Integration
About 5995 wordsAbout 20 min
API
AsstAppendTask
Prototype
TaskId ASSTAPI AsstAppendTask(AsstHandle handle, const char* type, const char* params);Description
Appends a task.
Return Value
TaskId
The task ID if the task is successfully appended, for the following configuration; 0 if the task is not successfully appended.
Parameter Description
handleRequiredAsstHandle
Instance handle
typeRequiredconst char*
Task type
paramsRequiredconst char*
Task parameters, json string
List of Task Types
StartUp
Start-up
enableOptionalboolean
true
Whether to enable this task.
client_typeRequiredstring
Client version.
Options: Official | Bilibili | txwy | YoStarEN | YoStarJP | YoStarKR
start_game_enabledOptionalboolean
false
Whether to launch client automatically.
account_nameOptionalstring
Switch account, don't switch by default.
Only supports switching to already logged-in accounts, using login name for identification, ensure the input content is unique among all logged-in accounts.
Official server: 123****4567, can input 123****4567, 4567, 123, or 3****4567
Bilibili server: Zhang San, can input Zhang San, Zhang, or San
Traditional Chinese server: Email-based, e.g. ab****01@gmail.com. Entering the plain-text portion without asterisks is recommended, e.g. 01@gmail
Example
{
"enable": true,
"client_type": "Official",
"start_game_enabled": true,
"account_name": "123****4567"
}CloseDown
Close Game Client
enableOptionalboolean
true
Whether to enable this task.
client_typeRequiredstring
Client version, no execution if left blank.
Options: Official | Bilibili | txwy | YoStarEN | YoStarJP | YoStarKR
Example
{
"enable": true,
"client_type": "Official"
}Fight
Operation
enableOptionalboolean
true
Whether to enable this task.
stageOptionalstring
Stage name, by default empty, recognizes current/last stage. Editing in run-time is not supported. Currently supported stages for navigation include:
- All mainline stages. You can add
-NORMALor-HARDat the end of the stage to switch difficulty: Chapters 10-14 map to Standard/Adverse, while Chapters 15+ map to Normal/Raid. - For LMD and Battle Record stages 5/6, must input
CE-6/LS-6. MAA will automatically switch to stage 5 if stage 6 cannot be delegated. - Skill Summary, Voucher, and Carbon stage 5, must input
CA-5/AP-5/SK-5. - All chip stages. Must input complete stage code, e.g.
PR-A-1. - Annihilation mode supports the following values, must use corresponding Value:
- Current Annihilation: Annihilation
- Chernobog: Chernobog@Annihilation
- Lungmen Outskirts: LungmenOutskirts@Annihilation
- Lungmen Downtown: LungmenDowntown@Annihilation
- OF-1 / OF-F3 in side stories.
- Last three stages of current SS events. Visit API for the list of supported stages. Requires additional loading of event stage navigation in tasks.json file.
- Rerun SS events. Input
SSReopen-<stage prefix>to farm XX-1 ~ XX-9 stages at once, e.g.SSReopen-IC.
medicineOptionalnumber
0
Maximum number of Sanity Potions used.
medicine_expire_daysOptionalnumber
0
Use Sanity Potions that expire within the specified number of days. 0 means no expiring potions will be used.
expiring_medicineOptionalDeprecatednumber
0
Deprecated since v6.8.0, please use medicine_expire_days instead.
stoneOptionalnumber
0
Maximum number of Originite Prime used.
timesOptionalnumber
2147483647
Number of battles.
seriesOptionalnumber
1
Number of consecutive battles, -1~10. -1 to disable switching. 0 to automatically switch to the current maximum available times, if current sanity is not enough for the maximum times, select the minimum available times. 1~10 to specify number of consecutive battles.
Server Difference
Input validation depends on whether the resource contains FightSeries-OldMethodFlag:
- New list (CN main resources after 2026/8/1, without this flag): accepts
-1~10 - Old list (overseas resources with this flag): accepts only
-1~6; larger values are rejected
Overseas servers are expected to follow in about six months, after which the limit becomes 10 with the resource update. The Windows GUI series dropdown currently always offers up to 10; on overseas clients, manually selecting 7~10 will be rejected by Core when the task is submitted.
dropsOptionalobject
Specifying the number of drops, no specification by default. key is item_id, value is quantity. key can refer to resource/item_index.json file.
Example: { "30011": 10, "30062": 5 }
All above are OR relations, i.e. task stops when any one is reached.
report_to_penguinOptionalboolean
false
Whether to upload data to Penguin Statistics.
penguin_idOptionalstring
Penguin Statistics report id, empty by default. Only effective when report_to_penguin is true.
report_to_yituliuOptionalboolean
false
Whether to report to YITULIU.
yituliu_idOptionalstring
YITULIU report id, empty by default. Only effective when report_to_yituliu is true.
serverOptionalstring
CN
Server, will affect drop recognition and upload.
Options: CN | US | JP | KR
client_typeOptionalstring
Client version, empty by default. Used to restart and reconnect after game crash, does not enable this feature if empty.
Options: Official | Bilibili | txwy | YoStarEN | YoStarJP | YoStarKR
DrGrandetOptionalboolean
false
Sanity-saving Originite usage mode, only effective when Originite usage may occur.
Wait at the Originite confirmation screen until the current 1 sanity point is restored, then immediately use Originite.
Example
{
"enable": true,
"stage": "1-7",
"medicine": 1,
"medicine_expire_days": 2,
"stone": 0,
"times": 10,
"series": 0,
"drops": {
"30011": 10
},
"report_to_penguin": true,
"penguin_id": "123456",
"report_to_yituliu": true,
"yituliu_id": "123456",
"server": "CN",
"client_type": "Official",
"DrGrandet": false
}Recruit
Recruitment
enableOptionalboolean
true
Whether to enable this task.
refreshOptionalboolean
false
Whether to refresh 3★ tags.
selectRequiredarray<number>
Tag ★ rarity to click.
confirmRequiredarray<number>
Tag ★ rarity for confirmation. Can be set to empty array for calculation only.
first_tagsOptionalarray<string>
Preferred Tags, valid only when selecting 3★ tags. Default is empty.
For 3★ recruits, MAA will try to include as many of the listed tags as possible. This is treated as a hard requirement and will override any "don't select 3★ Tags" settings.
extra_tags_modeOptionalnumber
0
Select more tags. 0 - default behavior 1 - select 3 tags even if they may conflict 2 - if possible, select more high star tag combinations even if they might conflict
timesOptionalnumber
0
Number of recruitments. Can be set to 0 for calculation only.
set_timeOptionalboolean
true
Whether to set recruitment time limit. Only effective when times is 0.
expediteOptionalboolean
false
Whether to use Expedited Plans.
expedite_timesOptionalnumber
Number of expedites, only effective when expedite is true. No longer effective in the current version; expedites are unlimited until the times limit is reached.
skip_robotOptionalboolean
true
Deprecated and kept only for backward compatibility.
When preserve_tags is absent and this value is true, MAA skips on 支援机械 only; 元素 is no longer treated as the legacy 1★ tag.
preserve_tagsOptionalarray<string>
List of tag names that should preserve the current recruitment slot and skip this recruitment. Default is empty.
If any specified tag is recognized, MAA will keep that slot untouched and skip the current recruitment.
recruitment_timeOptionalobject
Tag ★ rarity (greater than or equal to 3) and corresponding desired recruitment time limit, in minutes, all default to 540 (i.e. 09:00:00).
Example: { "3": 540, "4": 540 }
report_to_penguinOptionalboolean
false
Whether to report to Penguin Statistics.
penguin_idOptionalstring
Penguin Statistics report id, empty by default. Only effective when report_to_penguin is true.
report_to_yituliuOptionalboolean
false
Whether to report to YITULIU data.
yituliu_idOptionalstring
YITULIU report id, empty by default. Only effective when report_to_yituliu is true.
serverOptionalstring
CN
Server, will affect upload.
Options: CN | US | JP | KR
Example
{
"enable": true,
"refresh": true,
"select": [5, 4],
"confirm": [4, 3],
"first_tags": ["高级资深干员"],
"extra_tags_mode": 1,
"times": 4,
"set_time": true,
"expedite": false,
"expedite_times": 0,
"preserve_tags": ["支援机械"],
"recruitment_time": {
"3": 540,
"4": 540
},
"report_to_penguin": false,
"penguin_id": "123456",
"report_to_yituliu": false,
"yituliu_id": "123456",
"server": "CN"
}Infrast
Infrastructure shifting
enableOptionalboolean
true
Whether to enable this task.
modeOptionalnumber
0
Shift mode. Editing in run-time is not supported. 0 - Default: Default shift mode, automatically calculates efficient operator combinations within and across facilities. 10000 - Custom: Custom shift mode, reads user configuration, see Base Scheduling Schema. 20000 - Rotation: One-key rotation mode, skips control center, power station, dormitory and office, other facilities do not change shifts but retain basic operations (such as using drones, reception room logic).
facilityRequiredarray<string>
Facilities for shifting. Editing in run-time is not supported.
When mode = 0, this array acts as an enabled set; the order and duplicates do not affect scheduling (the shift order is planned automatically by the algorithm). When mode = 10000 / 20000, facilities are processed in array order.
Facility name: Mfg | Trade | Power | Control | Reception | Office | Dorm | Processing | Training | AssistantChange
dronesOptionalstring
\_NotUse
Usage of drones. This field is ignored when mode = 10000.
Options: _NotUse | Money | SyntheticJade | CombatRecord | PureGold | OriginStone | Chip
thresholdOptionalnumber
0.3
Morale threshold, range [0, 1.0].
When mode = 10000, this field is only effective for "autofill".
This field is ignored when mode = 20000.
replenishOptionalboolean
false
Whether to replenish Originium Shard in trading post.
dorm_notstationed_enabledOptionalboolean
false
Whether to enable "Not Stationed in Dorm" option.
dorm_trust_enabledOptionalboolean
false
Whether to fill dormitory with operators not at max trust.
fiammetta_targetsOptionalarray<string>
["清流", "可露希尔", "但书"]
Fiammetta recovery target list. At the start of a shift change, the target operator with the lowest morale in the list is placed in a dormitory together with Fiammetta to swap moods. Only effective when mode = 0 and fiammetta_recovery_enabled is true.
Options: 清流 | 可露希尔 | 但书 | 巫恋 | 龙舌兰 | 歌蕾蒂娅 (entries outside the options or duplicates are ignored)
fiammetta_recovery_enabledOptionalboolean
false
Whether to use Fiammetta to restore the target's morale at the start of the shift; when disabled, the shift change skips the dormitory preparation step. Only effective when mode = 0.
use_pinus_sylvestrisOptionalboolean
false
Whether to enable the 「Pinus Sylvestris Knights」 cross-facility team. Only effective when mode = 0.
use_perception_informationOptionalboolean
false
Whether to enable the 「Perception Information」 cross-facility team, which takes priority over 「Worldly Plight」. Only effective when mode = 0.
use_worldly_plightOptionalboolean
false
Whether to enable the 「Worldly Plight」 cross-facility team. Only effective when mode = 0.
use_abyssal_hunterOptionalboolean
false
Whether to enable the 「Abyssal Hunters」 cross-facility team. Only effective when mode = 0; when enabled together with 「Pinus Sylvestris Knights」, the two teams will not participate in scheduling together.
reception_message_boardOptionalboolean
true
Whether to collect credits from reception room message board.
reception_clue_exchangeOptionalboolean
true
Whether to perform clue exchange.
reception_send_clueOptionalboolean
true
Whether to send clues.
filenameRequiredstring
Custom config path. Editing in run-time is not supported.
plan_indexRequirednumber
Plan index number in the configuration. Editing in run-time is not supported.
continue_trainingOptionalboolean
false
Whether to continue unfinished skill training in the Training Room.
Example
{
"enable": true,
"mode": 0,
"facility": ["Mfg", "Trade", "Reception"],
"drones": "PureGold",
"threshold": 0.3,
"replenish": true,
"dorm_notstationed_enabled": false,
"dorm_trust_enabled": true,
"reception_message_board": true,
"reception_clue_exchange": true,
"reception_send_clue": true,
"filename": "schedules/base.json",
"plan_index": 1
}Mall
Collecting Credits and auto-purchasing.
Will buy items in order followingbuy_firstlist, buy other items from left to right ignoring items inblacklist, and buy other items from left to right ignoring theblacklistwhile credit overflows.
enableOptionalboolean
true
Whether to enable this task.
visit_friendsOptionalboolean
true
Whether to visit friends' base to obtain Credits.
shoppingOptionalboolean
true
Whether to buy items from the store.
buy_firstOptionalarray<string>
[]
Items to be purchased with priority. Item name, e.g. "招聘许可" (Recruitment Permit), "龙门币" (LMD), etc.
blacklistOptionalarray<string>
[]
Blacklist. Item name, e.g. "加急许可" (Expedited Plan), "家具零件" (Furniture Part), etc.
force_shopping_if_credit_fullOptionalboolean
false
Whether to ignore the Blacklist if credit overflows.
only_buy_discountOptionalboolean
false
Whether to purchase only discounted items, applicable only on the second round of purchases.
reserve_max_creditOptionalboolean
false
Whether to stop purchasing when credit points fall below 300, applicable only on the second round of purchases.
credit_fightOptionalboolean
false
Whether to run one battle of OF-1 to gain more Credits the next day.
formation_indexOptionalnumber
0
Formation slot index used for the OF-1 battle.
Integer between 0–4, where 0 = current squad, 1–4 = first, second, third, fourth squad.
Example
{
"enable": true,
"visit_friends": true,
"shopping": true,
"buy_first": ["招聘许可", "龙门币"],
"blacklist": ["家具零件"],
"force_shopping_if_credit_full": false,
"only_buy_discount": true,
"reserve_max_credit": false,
"credit_fight": false,
"formation_index": 0
}Award
Collecting various rewards
enableOptionalboolean
true
Whether to enable this task.
awardOptionalboolean
true
Collect daily/weekly task rewards.
mailOptionalboolean
false
Collect all mail rewards.
recruitOptionalboolean
false
Collect daily free pulls from limited banners.
orundumOptionalboolean
false
Collect Orundum from lucky drop wall.
miningOptionalboolean
false
Collect Orundum from limited mining licenses.
specialaccessOptionalboolean
false
Collect monthly card rewards from 5th anniversary.
signineventOptionalboolean
false
Collect rewards from limited-time sign-in events (only standard horizontal layouts are supported).
Example
{
"enable": true,
"award": true,
"mail": true,
"recruit": true,
"orundum": false,
"mining": true,
"specialaccess": false,
"signinevent": false
}SwitchTheme
Switch the game's main interface theme
enableOptionalboolean
true
Whether to enable this task.
themesRequiredstring[]
List of candidate theme names, matching the names shown in the in-game theme list; with multiple entries, one is picked at random each run; an empty array skips the task.
Example
{
"enable": true,
"themes": ["夜间", "银凇"]
}Roguelike
Integrated Strategies
enableOptionalboolean
true
Whether to enable this task.
themeOptionalstring
Phantom
Theme. Phantom - Phantom & Crimson Solitaire Mizuki - Mizuki & Caerula Arbor Sami - Expeditioner's Jǫklumarkar Sarkaz - Tales of the Unfathomable JieGarden - Sui's Garden of Grotesqueries BlackFlow - 黑流树海
modeOptionalnumber
0
Mode. 0 - Score farming/reward points, aiming to consistently reach higher levels. 1 - Originium Ingot farming, exit after investing in the first layer. 2 - Removed Originally balanced modes 0 and 1; rejected in the current version. 3 - Not yet available Rejected when passed. 4 - Opening reset; first reaches the third layer at difficulty 0, then restarts and switches to the specified difficulty to reset the opening reward. If not the desired item, restart at difficulty 0; in the Phantom theme, retry only in the current difficulty. 5 - Collapsal Paradigm farming; only for the Sami theme; accelerates collapsal buildup via missed enemies; if the first collapsal paradigm encountered is in the expected_collapsal_paradigms list, stops the task; otherwise, restarts. 6 - Monthly squad rewards farming, same as mode 0 except for specific mode adaptations. 7 - Deep Dive rewards farming, same as mode 0 except for specific mode adaptations. 10001 - Quickly clear the first layer; only available in the Sarkaz theme. 20001 - Playtime node farming; enter the hollow on the first layer and restart if the required node cannot be found; only available in the JieGarden theme, requires find_playTime_target. 30001 - Swaddled baby animal farming; only available in the BlackFlow theme.
squadOptionalstring
指挥分队
Starting squad name.
rolesOptionalstring
取长补短
Starting role group.
core_charOptionalstring
Starting operator name. Supports only single operator Chinese name, regardless of server; leave empty or set to "" to auto-select based on level. Equivalent to the 1st entry of core_char_list; kept only for compatibility with older callers.
core_char_listOptionalarray<object>
Starting operator list. Each entry is { "name": operator name, "use_support": whether to use support }, with operator Chinese name only, regardless of server; entries correspond to the 1st, 2nd, and 3rd recruitments at the start in array order, and the operators in the three slots must be of different classes. Recruitment only searches the first few pages for the specified operators, so operators with lower hope cost may be missed due to appearing later in the list; if the operator of a slot is not recruited (neither owned nor support one appears), that recruitment falls back to the default priority, so it is recommended to place operators with higher hope cost first. Takes precedence over core_char when both are passed.
use_supportOptionalboolean
false
Whether the starting operator is a support operator. Equivalent to the support flag of the 1st entry of core_char_list; kept only for compatibility with older callers.
use_nonfriend_supportOptionalboolean
false
Whether non-friend support operators are allowed. A global switch that applies to all starting operator slots using support.
starts_countOptionalnumber
2147483647
Number of times to start exploration. Stops automatically upon reaching limit.
difficultyOptionalnumber
-1
Specified difficulty level; -1 means no preference. Selects the highest unlocked difficulty if the specified one is not unlocked.
stop_at_final_bossOptionalboolean
false
Whether to stop before the level 5 final boss node. Only applicable to themes excluding Phantom.
stop_at_max_levelOptionalboolean
false
Whether to stop if max level for roguelike has been achieved.
investment_enabledOptionalboolean
true
Whether to invest Originium Ingots.
investments_countOptionalnumber
2147483647
Number of Originium Ingot investments. Stops automatically upon reaching limit.
stop_when_investment_fullOptionalboolean
false
Whether to stop automatically when investment limit is reached.
investment_with_more_scoreOptionalboolean
false
Whether to try shopping after investment. Only applicable to mode 1.
start_with_elite_twoOptionalboolean
false
Whether to reset for an Elite 2 operator at start. Only applicable to mode 4.
only_start_with_elite_twoOptionalboolean
false
Whether to reset only for Elite 2 operator while ignoring other starting conditions. Only effective when mode is 4 and start_with_elite_two is true.
refresh_trader_with_diceOptionalboolean
false
Whether to refresh the shop with dice for special items. Only applicable to the Mizuki theme, used to refresh Scale of Past.
first_floor_foldartalOptionalstring
Desired Foldartal to acquire in the first floor foresight phase. Only applicable to the Sami theme, any mode; task stops once obtained successfully.
start_foldartal_listOptionalarray<string>
[]
Desired Foldartals for the starting reward phase during opening reset. Effective only for Sami theme and mode 4.
Reset is successful only when all Foldartals in the list are present in the opening rewards.
Note: This parameter must be used with the "生活至上分队" (Life-Sustaining Squad) as other squads do not obtain Foldartals in the opening reward phase.
collectible_mode_start_listOptionalobject
Desired starting rewards, all false by default. Only valid in mode 4. hot_water: Hot Water reward, typically used to trigger boiling mechanism (universal). shield: Shield reward, equivalent to extra HP (universal). ingot: Originium Ingot reward (universal). hope: Hope reward (universal, note: not available in JieGarden theme). random: Random reward option: consumes all Ingots for a random collectible (universal). key: Key reward, only available in Mizuki theme. dice: Dice reward, only available in Mizuki theme. ideas: 2 Ideas reward, only available in Sarkaz theme. ticket: Coupon reward, only available in JieGarden theme.
use_foldartalOptionalboolean
Whether to use Foldartals. Default is false in mode 5 and true in other modes. Only applicable to the Sami theme.
check_collapsal_paradigmsOptionalboolean
Whether to check obtained Collapsal Paradigms. Default is true in mode 5 and false in other modes.
double_check_collapsal_paradigmsOptionalboolean
true
Whether to perform additional checks to prevent missed Collapsal Paradigms. Only effective when theme is Sami and check_collapsal_paradigms is true. Default is true in mode 5 and false in other modes.
expected_collapsal_paradigmsOptionalarray<string>
['目空一些', '睁眼瞎', '图像损坏', '一抹黑']
Desired Collapsal Paradigms to trigger. Only effective when theme is Sami and mode is 5.
monthly_squad_auto_iterateOptionalboolean
Whether to enable automatic monthly squad rotation.
monthly_squad_check_commsOptionalboolean
Whether to also check monthly squad communications as rotation criteria.
deep_exploration_auto_iterateOptionalboolean
Whether to enable automatic deep exploration rotation.
collectible_mode_shoppingOptionalboolean
false
Whether to enable shopping in hot water mode.
collectible_mode_squadOptionalstring
Squad to use in hot water mode, default synced with squad, when squad is empty and collectible_mode_squad not specified, uses 指挥分队.
start_with_seedOptionalstring
Fixed seed for seed-based money farming; leave empty to disable.
Only effective in Sarkaz theme, Investment mode, with "点刺成锭分队" (Point-Stab Ingot Squad) or "后勤分队" (Logistics Squad).
blackflow_strategyOptionalstring
Strategy for the 黑流树海 (BlackFlow) theme; inferred from mode and investment_enabled when left empty. baby_animal - Check the general store on floor 1, then explore floors 2 and 3 and enter the 秘境行商 (secret-route trader) to cultivate seeds; requires blackflow_cultivation_targetinvestment - Reach the fixed general store on floor 1 via the route with the fewest battles and the shortest estimated time burn_with_investment - Complete investment on floor 1, then reach floor 3 as fast as possible and restart upon arrival burn - Reach floor 3 as fast as possible and restart upon arrival
blackflow_cultivation_targetOptionalstring
swaddled_cat
Target of the baby animal farming mode. Options: swaddled_cat (Swaddled Cat) | swaddled_feathered_serpent (Swaddled Feathered Serpent) | swaddled_dog (Swaddled Dog) | swaddled_cerberus (Swaddled Cerberus); only used when blackflow_strategy is baby_animal.
find_playTime_targetOptionalnumber
Target playtime node of the playtime node farming mode. 1 - Ling (掷地有声, Resounding); 2 - Shu (种因得果, Sow the Cause, Reap the Fruit); 3 - Nian (三缺一, Three Out of Four). Only used when the theme is JieGarden and the mode is 20001, required in that mode; other or missing values cause the task parameters to fail to be set.
Example
{
"enable": true,
"theme": "Sami",
"mode": 5,
"squad": "指挥分队",
"roles": "稳扎稳打",
"core_char_list": [
{ "name": "维什戴尔", "use_support": true },
{ "name": "古米", "use_support": false },
{ "name": "史都华德", "use_support": false }
],
"use_nonfriend_support": false,
"starts_count": 3,
"difficulty": 8,
"stop_at_final_boss": false,
"stop_at_max_level": false,
"investment_enabled": true,
"investments_count": 2,
"stop_when_investment_full": false,
"investment_with_more_score": false,
"start_with_elite_two": false,
"only_start_with_elite_two": false,
"refresh_trader_with_dice": false,
"first_floor_foldartal": "",
"start_foldartal_list": [],
"collectible_mode_start_list": {
"hot_water": true,
"shield": false,
"ingot": false,
"hope": true,
"random": false,
"key": false,
"dice": false,
"ideas": false
},
"use_foldartal": true,
"check_collapsal_paradigms": true,
"double_check_collapsal_paradigms": true,
"expected_collapsal_paradigms": ["目空一些", "睁眼瞎"],
"monthly_squad_auto_iterate": false,
"monthly_squad_check_comms": false,
"deep_exploration_auto_iterate": false,
"collectible_mode_shopping": false,
"collectible_mode_squad": "指挥分队",
"start_with_seed": ""
}For specific information about the Collapsal Paradigm farming feature, please refer to Integrated Strategy Schema
Copilot
Auto combat feature
enableOptionalboolean
true
Whether to enable this task.
filenamestring
Path to a single job JSON file, mutually exclusive with copilot_list (required, choose one); both relative and absolute paths are supported.
copilot_listarray`<object>
List of jobs, mutually exclusive with filename (required, choose one); when both filename and copilot_list are present, copilot_list will be ignored; set_params can only be executed once when this parameter is in effect.
Each object contains:
filename: Path to the job JSON file; both relative and absolute paths are supportednav_name_override: Navigation stage name, optional; if omitted ornull, automatically inferred from the task fileis_raid: Whether to switch to Challenge Mode (Raid), optional, default false
loop_timesOptionalnumber
1
Number of loops. Effective only in single job mode (i.e., when filename is specified); set_params can only be executed once when this parameter is in effect.
use_sanity_potionOptionalboolean
false
Whether to use sanity potions when sanity is insufficient.
formationOptionalboolean
false
Whether to enable auto formation.
formation_indexOptionalnumber
0
The index of the formation slot to use in auto formation. Only effective when formation is true.
An integer between 0–4: 0 means the current formation, 1–4 refer to the 1st–4th formations.
user_additionalOptionalarray`<object>
[]
Custom additional operators list. Only effective when formation is true.
Each object contains:
name: Operator name, optional, default "", if left empty this operator will be ignoredskill: Skill to bring, optional, default 0 (follows the in-game default skill selection); must be an integer between 1–3; otherwise, also follows the in-game default
add_trustOptionalboolean
false
Whether to auto-fill empty slots by ascending trust value during auto formation. Only effective when formation is true.
ignore_requirementsOptionalboolean
false
Whether to ignore operator attribute requirements during auto formation. Only effective when formation is true.
support_unit_usageOptionalnumber
0
Support operator usage mode. Integer between 0–3. Only effective when formation is true. 0 - Do not use support operators 1 - Use support operator only if exactly one operator is missing; otherwise, do not use support 2 - Use support operator if one is missing; otherwise, use the specified support operator 3 - Use support operator if one is missing; otherwise, use a random support operator
support_unit_nameOptionalstring
Specified support operator name. Only effective when support_unit_usage is 2.
For more details about auto-combat JSON, please refer to Combat Operation Protocol
Example
{
"enable": true,
"filename": "copilot/1-7.json",
"loop_times": 2,
"use_sanity_potion": false,
"formation": true,
"formation_index": 1,
"user_additional": [
{
"name": "能天使",
"skill": 3
}
],
"add_trust": true,
"ignore_requirements": false,
"support_unit_usage": 2,
"support_unit_name": "艾雅法拉"
}SSSCopilot
Auto combat feature for Stationary Security Service
enableOptionalboolean
true
Whether to enable this task.
filenameRequiredstring
Filename and path of the task JSON, supporting absolute/relative paths. Editing in run-time is not supported.
loop_timesOptionalnumber
Number of times to loop execution.
For more details about Stationary Security Service JSON, please refer to SSS Schema
Example
{
"enable": true,
"filename": "sss/plan.json",
"loop_times": 1
}ParadoxCopilotAutomatically run Paradox Simulation operations
enableOptionalboolean
true
Whether to enable this task.
filenameRequiredstring
File path of a single operation JSON, supports absolute/relative paths. Runtime editing not supported. Mutually exclusive with list (required, choose one).
listRequiredarray`<object>` | array`<string>
List of jobs. Runtime editing not supported. Mutually exclusive with filename (required, choose one).
Array elements support two forms: an object containing id (job identifier, passed as-is to the CopilotListLoadTaskFileSuccess callback) and filename (path to the job JSON file, both absolute and relative paths supported); or a job path string used directly.
Example
{
"enable": true,
"filename": "paradox/exusiai.json",
"list": []
}DepotDepot recognition
enableOptionalboolean
true
Whether to enable this task.
Example
{
"enable": true
}OperBox
Operator box recognition
enableOptionalboolean
true
Whether to enable this task.
Example
{
"enable": true
}Reclamation
Reclamation Algorithm
enableOptionalboolean
true
Whether to enable this task.
themeOptionalstring
Tales
Theme. Fire - Fire Within the Sand (Closed) Tales - Tales Within the SandRelaunchAnchor - Relaunch Anchor
modeOptionalnumber
0
Mode. Supported modes vary by theme:
Tales:0 - No save, farm prosperity points by entering and exiting stages. 1 - With save, farm currency by crafting support items.
RelaunchAnchor:16 (RA1) - RA-1, automatically execute intensive farming, construction, resource delivery, and settlement loop. 32 (RA15) - RA-15, complete the 60-kill mission with Civilight Eterna. 48 (RA4) - RA-4, Use the Gold from Strategy Planning Management to unlock areas, and use Wis'adel to complete the boss elimination mission.
tools_to_craftOptionalarray<string>
[]
Automatically crafted items. Suggested to fill in the substring; leave empty to craft nothing. Only effective in the Tales theme with a save (mode = 1).
clear_storeOptionalboolean
false
Whether to purchase (clear out) shop items after the task completes. Only effective in the Tales theme without a save (mode = 0).
increment_modeOptionalnumber
0
Click type. Only effective for Tales theme. 0 - Rapid Click 1 - Long Press
num_craft_batchesOptionalnumber
16
Maximum number of craft batches per session. Only effective for Tales theme.
Example
{
"enable": true,
"theme": "Fire",
"mode": 1,
"tools_to_craft": ["荧光棒", "发电机"],
"increment_mode": 0,
"num_craft_batches": 12
}Custom
Custom Task
enableOptionalboolean
true
Whether to enable this task.
task_namesRequiredarray<string>
Execute the task on the first match in the array (and subsequent next, etc.). If you want to perform multiple tasks, you can append Custom task multiple times. Supports the Secret Front (MiniGame@SecretFront) concatenated form: MiniGame@SecretFront@Begin@Ending[A-E](@event)?, where event is optional (支援作战平台 / 游侠 / 诡影迷踪), e.g. MiniGame@SecretFront@Begin@EndingA@支援作战平台.
paramsOptionalobject
Additional task parameters. Currently only used by the pixel paint task (MiniGame@PixelPaint@Begin):
params.pixel_paint.groups: color-grouped cell list.coloris the palette slot index (0~39, same order as the in-game right-side palette),pointsis an array of[x, y]grid coordinates (0~23, origin at top-left).params.pixel_paint.swipe(bool, optional, default true): consecutive cells of the same color are drawn in a single drag for speed; some touch modes may behave abnormally.params.pixel_paint.grid_delay(int, optional, default 0): extra per-cell wait (ms). Applied after clicks and added to drag duration. Each touch mode already has its own base interval; usually no need to adjust. Legacy keygrid_click_delayis still accepted.
Example
{
"enable": true,
"task_names": ["StartUp", "Infrast", "Fight"]
}{
"enable": true,
"task_names": ["MiniGame@PixelPaint@Begin"],
"params": {
"pixel_paint": {
"groups": [
{ "color": 7, "points": [[0, 1], [3, 4]] }
]
}
}
}SingleStep
Single-step task (currently only supports copilot)
enableOptionalboolean
true
Whether to enable this task.
typeRequiredstring
copilot
Currently only supports "copilot".
subtypeRequiredstring
Subtask type. stage - Set stage name, requires "details": { "stage_name": "xxxx" }. start - Start mission, without details. action - Single battle action, details is single action in Copilot, e.g.: "details": { "name": "史尔特尔", "location": [ 4, 5 ], "direction": "左" }, see Combat Operation Protocol for details.
detailsOptionalobject
Detailed parameters for the subtask.
Example
{
"enable": true,
"type": "copilot",
"subtype": "stage",
"details": {
"stage_name": "1-7"
}
}VideoRecognition
Video recognition, currently only supports operation (combat) video
enableOptionalboolean
true
Whether to enable this task.
filenameRequiredstring
Video file path, supporting absolute/relative paths. Editing in run-time is not supported.
Example
{
"enable": true,
"filename": "videos/copilot.mp4"
}AsstSetTaskParams
Prototype
AsstBool ASSTAPI AsstSetTaskParams(AsstHandle handle, AsstTaskId id, const char* params);Description
Set task parameters
Return Value
AsstBool
Whether the parameters are successfully set.
Parameter Description
handleRequiredAsstHandle
Instance handle
idRequiredAsstTaskId
Task ID, the return value of AsstAppendTask
paramsRequiredconst char\*
Task parameter in JSON, same as AsstAppendTask. For those fields that do not mention "Editing in run-time is not supported" can be changed during run-time. Otherwise these changes will be ignored when the task is running.
AsstSetStaticOption
Prototype
AsstBool ASSTAPI AsstSetStaticOption(AsstStaticOptionKey key, const char* value);Description
Set process-level parameters
Return Value
AsstBool
Is the setup successful
Parameter Description
keyRequiredAsstStaticOptionKey
key
valueRequiredconst char\*
value
List of Key and value
InvalidOptionalnumber
0
Invalid placeholder. Enum value: 0.
CpuOCROptionalboolean
Use the CPU for OCR. The value is not parsed. Switching after resources are loaded is not supported. Enum value: 1.
GpuOCROptionalstring
Use the GPU for OCR. The value is the GPU device index (integer); on Windows, luid:<hexadecimal LUID> is also accepted. Switching after resources are loaded is not supported. Enum value: 2.
AsstSetInstanceOption
Prototype
AsstBool ASSTAPI AsstSetInstanceOption(AsstHandle handle, AsstInstanceOptionKey key, const char* value);Description
Set instance-level parameters
Return Value
AsstBool
Is the setup successful
Parameter Description
handleRequiredAsstHandle
handle
keyRequiredAsstInstanceOptionKey
key
valueRequiredconst char\*
value
List of Key and value
InvalidOptionalnumber
0
Invalid placeholder. Enum value: 0.
MinitouchEnabledOptionalboolean
Deprecated. Originally for enabling Minitouch; "1" - on, "0" - off. Note that the device may not support it. Enum value: 1 (deprecated).
TouchModeOptionalstring
minitouch
Touch mode setting. Options: minitouch | maatouch | adb | MacPlayTools | MaaFwAdb | MumuExtras. Default minitouch. Enum value: 2.
DeploymentWithPauseOptionalboolean
Whether to pause when deploying operators (affects IS, Copilot and Stationary Security Service). Options: "1" | "0". Enum value: 3.
AdbLiteEnabledOptionalboolean
Whether to enable AdbLite or not. Options: "0" | "1". Enum value: 4.
KillAdbOnExitOptionalboolean
Release Adb on exit. Options: "0" | "1". Enum value: 5.
ClientTypeOptionalstring
Client channel. Most connection configs do not need this option. Set it before AsstConnect / AsstAsyncConnect only when the selected config uses [PackageName] in commands executed during connect. In the built-in configs, only Androws and WSA currently require it for displayId lookup. This does not replace the client_type task parameter used by StartUp / CloseDown tasks. Enum value: 6.
