Skip to content
This repository has been archived by the owner on Dec 10, 2017. It is now read-only.

Setup config.ini

Jump to bottom
Minyoung Choi edited this page Mar 13, 2017 · 26 revisions

The script will load config.ini in the main kancolle-auto folder for your user settings. This allows you to quickly switch between configs by renaming them and cycling them back in as config.ini and restarting the kancolle-auto. Please note that all input values are case-sensitive.

The config file is split up into the following six sections:

General

Program — The program/window name of your Kancolle container. Make this string match the name of your Kancolle window as close as possible. If you're playing within a browser, the browser name should suffice, unless you have multiple windows of the same browser window open. If you're using another Viewer program, input its name.

  • Examples: Chrome, Firefox, KanColleViewer!, KanColleTool Viewer, Electronic Observer, etc

RecoveryMethod — kancolle-auto will attempt to automatically refresh your Kancolle container if you encounter a catbomb. Five refresh methods are currently supported, and you should specify which method to be used depending on the viewer you use. Browser for all webbrowsers that uses F5 as a refresh page hotkey, KC3 for KC3Kai on Google Chrome, KCV for KanColleViewer, KCT for KanColleTool, and EO for Electronic Observer. Please use None if you're not using any of these browsers, or program your own in.

  • Valid values: Browser, KC3, KCV, KCT, EO, None

JSTOffset — Define your machine's timezone's difference to JST in full hours. Relevant only if you're enabling the PvP and/or Quests modules, as these reset relative to JST time.

  • Valid values: any integer, in hours

SleepCycle — Defines how often kancolle-auto should wait between running its loop, specified in full seconds. A lower value will make kancolle-auto be very snappy in response to timers ending, while a higher value will give it more time before acting on the timers.

  • Valid values: any integer, in seconds

Paranoia — One of the anti-bot-detection methods incorporated into kancolle-auto is a random walk through menus. This setting allows you to define the upper bound of sidesteps the random walk can take before reaching its final destination. Set to 0 if you think the random walk is unnecessary and want to disable it entirely (not recommended).

  • Valid values: any integer including 0 and above

SleepModifier — If you're encountering frequent FindFailed errors it may be due to the sleep/wait timers not being optimized for your KanColle experience. Increasing this value will increase the length of all sleep/wait timers in the game, which may help reduce the frequency of such crashes.

  • Valid values: any integer including 0 and above

ScheduledSleep

Enabled — Define whether or not you want kancolle-auto to sleep (not play the game) for a set period of time at a set time. It is highly recommended that you enable and use this feature, as an excessive number of expeditions has been known to cause frequent catbombs.

  • Valid values: True to enable scheduled sleep, False to disable

StartTime — Define around when Schedule Sleep should start, in military time. The Schedule Sleep will start sometime in a 30 minute window after the specified time.

  • Valid values: value between 0000 and 2359
  • Example: StartTime of 0030 means that Schedule Sleep will begin sometime between 12:30AM and 1AM.

SleepLength — Define roughly how long Schedule Sleep should last, in hours (decimals are OK). Anywhere beween 0 to 10 minutes are added randomly to the actual timer.

  • Example: 3.5 means that kancolle-auto will sleep for a period of time between 3 hours and 30 minutes and 3 hours and 40 minutes

ScheduledStop

Enabled — Define whether or not you want kancolle-auto to stop after a set number of hours, expeditions, sorties, or PvP. You will have to restart kancolle-auto manually after it stops via ScheduledStop.

  • Valid values: True to enable scheduled sleep, False to disable

Mode — Define what you want to base the count for the ScheduledStop on.

  • Valid values: time, expedition, sortie, or pvp

Count — Define after how many of the above kancolle-auto should stop itself. Integer values only. If the above Mode is time, it will stop after the number of hours specified here.

  • Valid values: any integer above 1

Expeditions

Enabled — Define whether or not you want kancolle-auto to automatically run expeditions.

  • Valid values: True to automate expeditions, False to disable

Fleet2, Fleet3, Fleet4 — Define which expedition a fleet should go to.

  • Supported expeditions: 1 ~ 32, 35 ~ 40

PvP

Enabled — Define whether or not you want kancolle-auto to automatically run PvP sorties with your main fleet. Please note that kancolle-auto will select the line-ahead formation for every PvP, regardless of enemy fleet composition.

  • Valid values: True to automate PvP sorties, False to disable

FleetComp — Define which saved fleet composition to use for PvP, with the first saved fleet being 1. Please note that this field is only relevant if both PvP and Combat modules are enabled and both have different FleetComps assigned to them. To disable the fleet composition switching feature, set both FleetComp values to the same value or either one to 0.

  • Valid values: 1 ~ 5

Combat

Enabled — Define whether or not you want kancolle-auto to automatically run sorties with your main fleet.

  • Valid values: True to automate sorties, False to disable

FleetComp — Define which saved fleet composition to use for sorties, with the first saved fleet being 1. Please note that this field is only relevant if both PvP and Combat modules are enabled and both have different FleetComps assigned to them. To disable the fleet composition switching feature, set both FleetComp values to the same value or either one to 0.

  • Valid values: 1 ~ 5

Area — Define which world you want to sortie to. For example, if you want to sortie to 1-5, the Area would be '1'. kancolle-auto currently supports all sorties up to 6-1, including Extra Operations, as well as Events.

  • Valid values: 1 ~ 6 for normal maps, E for Events

Subarea — Define which map you want to sortie to. For example, if you want to sortie to 1-5, the Subarea would be '5'. kancolle-auto currently supports all sorties up to 6-1, including Extra Operations. For Events, this value must be in the form of #-#, where the first # is the nth screen the map you would like to sortie is, and the second # is the nth entry the map you would like to sortie to is on that screen. So if the Event has 3 maps, 2 on the first screen and a 3rd on the second screen, you would enter 1-1, 1-2, or 2-1` for each map you would like to sortie to.

  • Valid values: 1 ~ 6 for normal maps, #-# for Events (see above)

CombinedFleet — Define whether or not the map you are sortieing to is a Combined Fleet map. You must set this value accordingly if the map you are sortieing to is a Combined Fleet map, otherwise kancolle-auto will crash. Setting this to True will disable expeditions of fleet 2, as well as the PvP module, regardless of what you have set in the config file.

  • Valid values: True to enable CombinedFleet mode for the Combat module, False to disable

Nodes — Define how many combat nodes you want to run (resource/treasure/hazard nodes do not count as a node to kancolle-auto). You can set this to any number, and it might be wise to set it to something higher than the actual number of nodes you will run to be certain that you'll run through the entire map.

  • Examples: 1 if you're running 3-2-A (1st node only), 3 or above if you're running 2-3 (Orel Cruising; all nodes)

NodeSelects — Define any node selections you would like kancolle-auto to perform on the map you are sortieing to. The values should be the name of the image of the node you are trying to select. The image should be a 70px by 70px uncompressed png image put in the combat.sikuli folder. A pair of example images have been included at the moment, both for the 2016 Winter event: _node_E-2-I is for map E-2 node I, while _node_E-3-K is for map E-3 node K. Please generate your own node images based on these guidelines, and feel free to create a pull request/issue ticket with the images if you'd like to share them.

  • Valid values: name of image of node in combat.sikuli folder; multiple values should be comma-separated

Formations — Define which formation to use at each combat node, separate by commas. If you specify less formations than the number of Nodes, kancolle-auto will automatically use line_ahead for the remaining nodes. For Combined Fleet sorties, all nodes' formations must be defined.

  • Valid values: line_ahead, double_line, diamond, echelon, line_abreast; multiple values should be comma-separated
  • Valid values (Combined Fleet): combinedfleet_1, combinedfleet_2, combinedfleet_3, combinedfleet_4; multiple values should be comma-separated
  • Examples: line_ahead if you're running 3-2-A (1st node only), 'line_abreast, line_abreast, line_abreast, line_abreast` if you're running 1-5 (all submarine nodes)

NightBattles — Define whether or not to engage in night battle at each combat node, separated by commas. If you specify less values than the number of Nodes, kancolle-auto will automatically use True for the remaining nodes.

  • Valid values: True to engage in night battle, False to decline night battle; multiple values should be comma-separated
  • Examples: False if you're running 3-2-A, False, True, True, True, True or just False if you're running 2-3 (Orel Cruising; night battle at everything but 1st node)

RetreatLimit — Define how much your ships can be damaged before you retreat from the sortie. kancolle-auto will automatically retreat from sortie if one or more ships are at or below this threshold.

  • Valid values: 0 for light damage, 1 for moderate damage, 2 for critical damage

RepairLimit — Define how much your ships can be damaged before you repair them. kancolle-auto will automatically repair all ships at or below this threshold before sortieing again, regardless of whether or not you retreated previously.

  • Valid values: 0 for light damage, 1 for moderate damage, 2 for critical damage

RepairTimeLimit — Define the upper limit (in HHMM format) of the repair timer before kancolle-auto uses a bucket to repair the ship.

  • Examples: 0 if you want all repairs to use a bucket (useful if all ships are high leveled), 0030 if you want buckets to be used if the repair timer is longer than 30 minutes, 0200 if you want buckets to be used if the repair timer is longer than 2 hours, 9900 if you never want buckets to be used

CheckFatigue — Define whether or not kancolle-auto should check fatigue/morale of your ships before sortieing. If your ships are moderately fatigued (orange sadface) kancolle-auto will wait 12 minutes before attempting to sortie again. If your ships are heavily fatigued (red sadface) kancolle-auto will wait 24 minutes before attempting to sortie again. If disabled, kancolle-auto will disregard fleet morale when sortieing.

  • Valid values: True to enable morale/fatigue checking, False to disable

PortCheck — Define whether or not kancolle-auto should do a basic check your port (ship count) for vacancies before sortieing. Useful if you're trying to farm for a specific drop. If enabled and your port becomes full, kancolle-auto will not sortie and wait 15 minutes, allowing you to modernize/scrap to make room, before attempting to sortie again. Port Checks are automatically done if you are sortieing to an event map. Note: kancolle-auto only knows that your port is full when you are completely maxed out! If you have a vacancy of 1 ship, it will still sortie, even if the number of potential drops is greater than 1!

  • Valid values: True to enable port checking, False to disable

MedalStop — Define whether or not kancolle-auto should stop sortieing once a medal has been obtained. This is only relevant for the monthly EOs, excluding 1-6, as they are the only maps that reward a medal on the post-sortie screen. Setting this to True on maps that do not award medals will no impact, other than slightly slow down the checks on the post-combat screen.

  • Valid values: True to enable stopping on medal award, False to disable

LastNodePush — Define whether or not kancolle-auto should push to the node after the last specified combat node. Useful for automating maps where the last node is a resource/non-combat node, such as 1-6. Setting to this to True allows kancolle-auto to bypass any damage checks after the last specified combat node, so it should only be used on maps where the routing is 100% predetermined and the last node is for certain a resource/non-combat node, such as 1-6, otherwise you risk losing ships! kancolle-auto itself does not know whether or not the last node is a non-combat node. You must check this yourself!

  • Valid values: True to enable pushing past last specified combat node, False to disable

SubmarineSwitch

Enabled — Define whether or not you want kancolle-auto to switch out any submarines in your fleet after repairs. If a submarine switch is successful, and your fleet is ready to sortie again, sortie will occur again immediately as long as other requirements are met (fatigue/morale, port check). This feature is useful for maps where submarines are the only ships being sortied (Orel), or if submarines are used to tank hits (3-2-A).

  • Valid values: True to enable SubmarineSwitch, False to disable

EnabledSubs — Specify which submarine(s) should be included in the submarine switch rotation, delimited by commas. Aggregate values all, ss, and ssv exist to help select all subs of a specific type. all is equivalent to specifying both ss and ssv, where ss is equivalent to specifying all valid SS values (see below) and ssv is equivalent to specifying all valid SSV values (see below).

  • Valid aggregate values: all (all SS and SSVs), ss (all SSs), ssv (all SSVs); multiple values should be comma-separated
  • Valid SS values: i-8, i-19, i-26, i-58, i-168, maruyu, ro-500, u-511; multiple values should be comma-separated
  • Valid SSV values: i-8-kai, i-13, i-14, i-19-kai, i-26-kai, i-58-kai, i-401; multiple values should be comma-separated; can be used in conjunction with SS values above except for all
  • Example: ss, i-13, i-14 to enable sub switching for all SSs and the SSVs I-13 and I-14

ReplaceLimit — Specify up to which damage state submarines should be replaced, on top of the default behavior of replacing subs being repaired and subs critically damaged. Only occurs after a repair action has been initiated (damaged subs to switch out exist). This setting is independent of FatigueSwitch.

  • Valid values: 0 for replacing lightly and moderately damage subs (on top of under-repair and critically damaged), 1 for replacing moderately damage subs (on top of under-repair and critically damaged)

FatigueSwitch — Specify whether or not submarines at medium or high fatigue should also be switched out. Only occurs after a repair action has been initiated (damaged subs to switch out exist). This setting is independent of ReplaceLimit.

  • Valid values: True to enable switching out fatigued submarines, False to disable

LBAS

Enabled — Define whether or not you want kancolle-auto to sortie with LBAS support. Used primarily for Events, although LBAS assets must be added for each event, map, and node.

  • Valid values: True to enable LBAS, False to disable

EnabledGroups — Enabled air support groups for the sortie, delimited by commas. Note that groups on Air Defense mode should be considered Enabled, otherwise they will not be resupplied. Values should be 1, 2, or 3.

  • Valid values: 1, 2, 3; multiple values should be comma-separated

Group1Nodes, Group2Nodes, Group3Nodes — Specify the 2 nodes that each LBAS group should sortie to, delimited by commas. If they are on Air Defense or not sortieing, leave this blank.

  • Example: _node_lbas_E-2-O_1, _node_lbas_E-2-O_2 which means that this particular LBAS Group will sortie to Event map 2's O node for its first and second sortie. Please note that their corresponding images _node_lbas_E-2-O_1.png and _node_lbas_E-2-O_2.png must be generated and present for kancolle-auto to use

Quests

Enabled — Define whether or not you want kancolle-auto to automatically check and complete quests.

  • Valid values: True to automate quests, False to disable

Quests — Define a list of quests you would like kancolle-auto to check. Please see the list of valid values below to see which quests are supported. Please refer to the Wikia Quest page to see which quest ID is which.

  • Valid values: bd1, bd2, bd3, bd4, bd5, bd6, bd7, bd8, bw1, bw2, bw3, bw4, bw5, bw6, bw7, bw8, bw9, bw10, c2, c3, c4, c8, d2, d3, d4, d9, d11, e3, e4; multiple values should be comma-separated
  • Example: bd1, bd2, bd3, bd4, bd5, bd6, bd8, bw1, bw2, bw3, bw4, bw5, c2, c3, c4, c8, d2, d3, d4, d9, d11, e3, e4 is the default value, which is a list of the most generic quests

CheckSchedule — Define how often you want kancolle-auto to check the Quests page. Setting this to 1 will cause kancolle-auto to check quests after every sortie or expedition. Certain quests will make kancolle-do this already. Quests are checked after every PvP sortie.

  • Valid values: any integer above 1
Clone this wiki locally