-
-
Notifications
You must be signed in to change notification settings - Fork 23
Config: Combat section
The [Combat]
section of the config file configures the Combat and Repair modules of kcauto.
Whether or not the Combat module of kcauto should be enabled.
Valid values:
True
to enable the Combat module,False
to disable
Specify which Combat engine kcauto should use for sorties. The Live Combat engine automatically tracks your fleet's position as it travels around the map and automatically chooses the formation and night battle based on the node details specified in the map's corresponding JSON file. The Legacy Combat engine defaults every node to Line Ahead/Combinedfleet Formation 4 and declined night battle. Overriding this requires specifying the formations and night battles by the combat node count (see Formations
and NightBattles
, respectively). Overriding the formation and night battle by combat node count also works for the Live engine. The Live Combat engine also supports overriding formation and night battle by the Node name.
Valid values:
live
for the Live Combat engine,legacy
for the Legacy Combat engine
Optional. Which fleet presets to use for Combat sorties, using the FleetSwitcher module. Fleet presets will be cycled every sortie, in the order they are specified. Note that the fleet preset number is based on the order in which fleet presets are displayed in the fleet preset recall screen, not the fleet preset save screen. A failure in switching to the correct fleet will stop kcauto.
Valid values: list of integers
1
~12
Specify which map to sortie the fleet to. Event maps (E-1, and so forth) are only valid when there is an Event occurring and kcauto-kai has been updated with the necessary assets for the maps (map panel image and map JSON). Please check the issue tracker for an issue marked with the event tag when an event is occurring. Typically these assets are maintained in a separate branch for the duration of the event.
Valid values:
1-1
~6-5
,E-1
~E-8
(when applicable)
Optional. Specify which type of fleet the sortieing fleet is. This value is used during pre-sortie checks, post-combat damage checks, automatic FCF resolution, for tracking the fleet's position in the Live Combat engine, and for filtering which ships to repair.
Valid values:
(empty string represents the standard fleet),
ctf
,stf
,transport
,striking
Optional. List of max number of combat nodes the fleet should go through and node names where kcauto should retreat from battle. If multiple integer values are specified, the smallest integer value is chosen, and the script will retreat from battle after hitting that number of combat nodes. Retreating via node name is only available in Live engine mode.
Valid values: list of at most one positive integer and any number of alpha-numeric node names
Examples:
C, D, F, 3
kcauto will retreat after reaching node C, D, F, or any third combat node (Live Engine only)
Optional. Comma-separated list of any node selects to do, specified in the format [current node]>[selected node]. Coordinates are specified in the map's corresponding JSON file.
Examples:
A>E, B>F
means that if the fleet is at node A, node E will be selected, and if the fleet is at node B, node F will be selected
Optional. Comma-separated list of custom formations, specified in the format [combat node count|node name]:[formation]. The Live Combat engine supports custom formations by both combat node count and node name, while the Legacy combat engine only supports custom formations by combat node count.
Valid single-fleet formations:
line_ahead
,double_line
,diamond
,echelon
,line_abreast
,vanguard
;vanguard
anddouble_line
are automatically used as fallbacks
Valid combined-fleet formations:
combinedfleet_1
,combinedfleet_2
,combinedfleet_3
,combinedfleet_4
;combinedfleet_4
andcombinedfleet_2
are always used as fallbacks
Examples:
4:line_abreast
will select the line abreast formation at the 4th combat node,E:vanguard
will select the vanguard formation at node E (Live Engine only)
Optional. Comma-separated list of custom night battle selections, specified in the format [combat node count|node name]:[True|False]. True will conduct night battle, False will not. The Live Combat engine supports custom night battle selections by both combat node count and node name, while the Legacy combat engine only supports custom night battle selections by combat node count.
Examples:
4:True
will conduct night battle at the 4th combat node,E:False
will decline night battle at node E (Live Engine only)
The damage threshold at which if any of the ship(s) in the fleet(s) are at or above the specified damage threshold, kcauto will retreat from the sortie.
Valid values:
heavy
(taiha),moderate
(chuuha),minor
(shouha)
The damage threshold at which ship(s) in the fleet will be repaired. This damage threshold is also used during the pre-sortie fleet check: if any of the ships are at or above this limit pre-sortie, the sortie will be cancelled and the ship(s) repaired.
Valid values:
heavy
(taiha),moderate
(chuuha),minor
(shouha)
The maximum repair time a ship can have before the Repair module automatically uses a bucket, specified in HHMM 24-hour format. To skip the timer check and always use a bucket, use the value 0000
. To never use a bucket, specify 9999
(overridden by the ReserveDocks
MiscOption
).
Valid values: 4-digit number between 0000 and 2359 (with leading 0s)
Optional. Comma separated list of LBAS groups to enable for the sortie. Enabled groups will be resupplied and their fatigue checked (if the CheckFatigue
MiscOption
is enabled) pre-sortie.
Valid LBAS groups:
1
~3
Optional. Zero or two comma-separated Nodes that the active LBAS Group should be assigned to. Zero implies that the LBAS Group is on Air Defense duties (no nodes specified).
Examples:
A, E
means that the LBAS Group will be assigned to nodes A and E;(empty string) means that the LBAS Group is on Air Defense so it will be resupplied but not assigned any nodes
Optional. Comma-separated list of valid miscellaneous options.
-
CheckFatigue
— checks the Fleet and active LBAS Groups' fatigue/morale. If they are fatigued, the combat will be delayed until their morale naturally recovers. For LBAS Groups they will be set to Rest mode during this duration. -
ReserveDocks
— if there is only one repair dock available while repairing, the remaining ships that must be repaired will be bucketed by default, regardless of their repair timer. -
PortCheck
— checks if there is a warning pre-sortie indicating that the port is full, meaning that you will not receive any ship drops. If the port is full, the sortie time is delayed 15 minutes. This check is on by default for Event maps. -
ClearStop
— stops the Combat module once the map is cleared. Only valid for EOs and Event maps. EO clears are determined by receiving a medal, and Event map clears are determined by the additional clear screens that typically occurs upon Event map clears.
Valid options:
CheckFatigue
,ReserveDocks
,PortCheck
,ClearStop
kcauto Wiki
Developer's Corner