config_detailed.ini

###################################################################################################
# ============================================ NOTE ============================================= #
# This file is here serve as a reference for config.ini and briefly explain what the different    #
#   options do. This file is not loaded by kancolle-auto at all. Please make all config changes   #
#   to config.ini. Please note that if kancolle-auto is configured improperly you increase the    #
#   chance of losing ships or getting banned for botting!                                         #
#                                                                                                 #
# Detailed explanation of config file:                                                            #
#   https://github.com/mrmin123/kancolle-auto/wiki/Setup-config.ini                               #
# Example configs:                                                                                #
#   https://github.com/mrmin123/kancolle-auto/wiki/Example-configs                                #
#   https://github.com/mrmin123/kancolle-auto/wiki/Event-configs                                  #
###################################################################################################

[General]
# The program/window name of your Kancolle container. Examples include Chrome, Firefox,
# KanColleViewer!, KanColleTool Viewer, Electronic Observer, etc...
# WARNING: IF YOU ARE USING A VIEWER WITH SUBTITLES, AND USING THE COMBAT MODULE, EITHER DISABLE
# THE SUBTITLES OR LOWER THEIR FONT SIZE TO 13PX OR LOWER. YOU MAY LOSE SHIPS IF YOU DO NOT DO
# THIS. PLEASE REFER TO THE FAQ IN THE README FOR DETAILS
Program = Chrome

# Which built-in recovery method to use when you get catbomb'ed. Valid options are Browser,
# KC3, KCV, KCT, and EO.
RecoveryMethod = KC3

# Set to True if your viewer sometimes throws a popup that must be cleared (DMM popup, KC3Kai
# navigation warning popup due to KC3Kai updates, etc). Setting this to True will try hitting the
# Esc key to clear the popup before re-initializing kancolle-auto from the beginning. Unfortunately
# does not work if the game is mid-sortie/combat.
BasicRecovery = True

# Your machine's timezone's difference to JST in full hours. Relevant to the Quests and PvP
# modules. Default is 0, same timezone as JST.
JSTOffset = 0

# How often kancolle-auto should run its loop, specified in full seconds. A lower value will make
# kancolle-auto be quicker to respond to timers, while a higher value will make it slower, but
# perhaps guard against bot-detection. Default value is 20.
SleepCycle = 20

# Specifies the desired # of menus to randomly walk through. The number of sidesteps range from 0
# to the Paranoia value. Setting this value to at least 1 is recommended (0 to 1 sidesteps).
Paranoia = 1

# If you have a slow computer/network connection, you may encounter frequent FindFailed errors.
# Increase this value by whole numbers (seconds) to increase the length of all sleep/wait timers
# to avoid this. Default is 0.
SleepModifier = 0


[ScheduledSleep]
# Set to True if you want kancolle-auto to automatically sleep/pause at set times. Highly
# recommended that you set this to True if you intend to run kancolle-auto for a long period of
# time.
Enabled = True

# Define around when you would like schedule sleep to start, in military time. Default time is
# 0030, meaning that Schedule Sleep will begin sometimes between 12:30AM and 1AM. Relative to your
# computer's time.
StartTime = 0030

# How long you want the sleep to last, in hours (decimals are OK). Anywhere between 0 to 10 minutes
# are added randomly to the actual timer. Default value is 3.5 (hours).
SleepLength = 3.5


[ScheduledStop]
# Set to True if you want kancolle-auto to automatically stop and exit after a set number of hours,
# expeditions, sorties, or PvPs. You will have to manually restart kancolle-auto after this.
Enabled = False

# Define what you want to base the stop count on. Valid options are 'time', 'expedition', 'sortie',
# and 'pvp'.
Mode = time

# Define how many of the above kancolle-auto should perform before automatically stopping.
Count = 5


[Expeditions]
# Set to True if you want kancolle-auto to run expeditions; False if not.
Enabled = True

# Define which Expedition a fleet should go on. If you do not have a Fleet unlocked or you don't
# want it to run an expedition, just leave its value blank. If you want to assign a fleet to the
# Event pre-boss and boss node support expeditions, they are 9998 and 9999, respectively.
Fleet2 = 2
Fleet3 = 5
Fleet4 = 21


[PvP]
# Set to True if you want Fleet 1 to run PvP sorties; False if not. NOTE: line-ahead formation
# will be selected for everything, regardless of enemy fleet...
Enabled = False

# Specify which saved fleet composition should be used for PvP, relative to the order in which they
# show up in the load fleet comp list, with the first saved fleet being 1.
# NOTE: this value is only relevant if both PvP and Combat modules are enabled with different
# fleets assigned to them! Setting the FleetComp value to 0 for either module, or setting them to
# the same value will disable the fleet composition switcher. Remember that if you save a fleet at
# position 10, but only have 2 saved fleets previous to it, it would be the 3rd fleet on the list.
FleetComp = 1


[Combat]
# Set to True if you want Fleet 1 to run combat sorties; False if not.
Enabled = False

# Specify which saved fleet composition should be used for Combat, relative to the order in which
# they show up in the load fleet comp list, with the first saved fleet being 1.
# To cycle fleet compositions, you may specify a comma delimited list of fleet composition numbers
# Example: 1, 2, 3
# NOTE: this value is only relevant if both PvP and Combat modules are enabled with different
# fleets assigned to them! Setting the FleetComp value to 0 for either module, or setting them to
# the same value will disable the fleet composition switcher. Remember that if you save a fleet at
# position 10, but only have 2 saved fleets previous to it, it would be the 3rd fleet on the list.
FleetComps = 2

# Set which area you want to sortie to.
# Example 1: if you're running 3-2-A, set this to '3'
# Example 2: if you're running 2-3 (Orel), set this to '2'
# Example 3: if you're running Events, set this to 'E'
Area = 2

# Set which subarea you want to sortie to.
# Example 1: if you're running 3-2-A, set this to '2'
# Example 2: if you're running 2-3 (Orel), set this to '3'
# Example 3: if you're running the first map (1) of the second screen of maps (2) in the Event
#   screen, set this to '2-1'
Subarea = 3

# Specify whether the map you're running utilizes Combined Fleets or not. Only relevant for Events.
# Will automatically handle FCFs and the extra ships needing repairs + resupplies. This also turns
# off PvP and Fleet 2's Expedition, regardless of what you input above.
CombinedFleet = False

# Maximum number of combat nodes to run. Resource/hazard nodes do not count.
# Example 1: if you're running 3-2-A, set this to '1' (1st node only)
# Example 2: if you're running 2-3 (Orel), set this to '3' or above
Nodes = 5

# If the map you are sortieing to involves node selections, use this to point at the image
# generated for that specific node. For example, if you want to always head to node K on E-3 of
# Winter 2016, set this to '_node_E-3-K' to reference the '_node_E-3-K.png' image included.
# For other maps, please generate this image yourself (a 70px x 70px image of the node during
# node selection, with the desired node being in the center of the image).
NodeSelects =

# Formations to use at each combat node, separated by commas. Valid options are
# line_ahead, double_line, diamond, echelon, or line_abreast. If the number of
# formations you've specified does not match the number of nodes you specified above,
# the script will default to line_ahead for the remaining nodes.
# Example 1: if you're running 3-2-A, set this to 'line_ahead'
# Example 2: if you're running 2-3 (Orel), set this to 'line_ahead' (remaining nodes
#     defaults to 'line_ahead')
# For combined fleets, the valid options are combinedfleet_1, combinedfleet_2, combinedfleet_3,
# combinedfleet_4, in order of how they show up in the formation selection screen (left to right,
# top to bottom).
Formations = line_ahead

# Whether or not to engage in night battle at each combat node, separated by commas.
# Valid options are True (to engage in night battle) and False (to avoid night battle).
# If the number of night battle options you've specified does not match the number of
# nodes you specified above, the script will default to True for the remaining nodes.
# Example 1: if you're running 3-2-A, set this to 'False'
# Example 2: if you're running 2-3 (Orel), set this to 'False' (remaining nodes defaults
#     to 'True')
NightBattles = False

# Set the damage threshold for your ships. RetreatLimit specifies when sortie should be cancelled
# (retreat from sortie), and RepairLimit specifies which ships should be repaired before
# sortieing again. In addition, the tool will automatically not sortie if any ships are at the
# RepairLimit threshold. 0 = light damage, 1 = moderate damage, 2 = critical damage.
# Example: If you want the script to retreat when any ship is at critical damage, but also repair
#     any ships at moderate damage, set RetreatLimit to 2, RepairLimit to 1.
RetreatLimit = 2
RepairLimit = 1

# Set the repair time limit for repairs. kancolle-auto will automatically use a bucket to repair a
# ship if its repair time is above this # of hours. Integer values only, please. If you want to
# never use buckets, set this to '9900'. A limit of '9500' and below will allow the repair script
# to use a bucket if the OCR cannot properly read the timer, so adjust this accordingly. If you
# always want to use buckets, set it to '0'.
RepairTimeLimit = 0030

# Whether or not the repair module should always keep one dock free, so as to not block sorties
# when repairs are needed and all docks are filled. This will result in above-average bucket usage.
# True automatically uses buckets when only one dock is free, False disables this functionality.
ReserveDocks = False

# Whether or not to consider fatigue/morale before sorties. If the ships have an unhappy face
# (morale of 29 or below) the script will wait for a set amount of time for morale to recover.
CheckFatigue = False

# Whether or not to sortie when the port (ship slots) is full. Set to True if you do not want
# sorties to occur when your port is full. Port checking is automatically done when sortieing to
# Event maps, since sortieing is prohibited when you do not have 5 free ship slots.
PortCheck = False

# Set this to True if you want kancolle-auto to stop sortieing to the specified map once the medal
# has been obtained. Only applicable to the monthly EOs (1-5, 2-5, 3-5, 4-5, 5-5).
MedalStop = False

# Set whether or not to 'push' past the max number of defined combat nodes, REGARDLESS OF THE
# STATE OF YOUR FLEET. Only do this if the last node is a resource/non-combat node, like the end
# of 1-6, and only if your path is 100% fixed!
# WARNING: YOU MAY LOSE SHIPS WITH THIS SET TO TRUE. PLEASE STUDY THE MAP YOU ARE SORTIEING TO AND
# MAKE AN EDUCATED DECISION
LastNodePush = False


[SubmarineSwitch]
# Whether or not to find submarines under repair to switch out so kancolle-auto can continue
# sorties. Useful for maps where submarines are used to tank hits, such as 2-3 (Orel) or 3-2-A.
Enabled = True

# Specify which submarines (SSs) should be included in the submarine switch rotation in a
# comma-delmiited list. Valid values include 'all', 'ss', 'ssv', 'i-8', 'i-8-kai', 'i-13', 'i-14',
# 'i-19', 'i-19-kai', 'i-26', 'i-26-kai', 'i-58', 'i-58-kai', 'i-168', 'i-401', 'maruyu',
# 'ro-500', 'u-511'. Specifying 'all' includes all subs, including 'ss' and 'ssv'. Specifying 'ss'
# or 'ssv' will include all SS or SSVs, respectively. You can use 'ss' and 'ssv' together
# (equivalent to 'all') or with other individually specified submarines.
EnabledSubs = ss

# If you want submarines of any other damage states to be replaced, specify up to which damage
# state should be replaced. 0 = light damage, 1 = moderate damage. Critically damaged ships will
# be repaired/checked by default. Leave blank if you just want critically damaged subs and subs
# under repair to be replaced.
ReplaceLimit =

# If you want submarines of medium and high fatigue to be swapped out as well, set this to True
FatigueSwitch = False

# If you want submarines to be allowed to use buckets under normal repair conditions set above in [Combat], set this to True
UseBuckets = False


[LBAS]
# Set to True if you want kancolle-auto to sortie with LBAS support
Enabled = False

# Enabled air support groups for the sortie, delimited by commas. Values should be 1, 2, or 3
EnabledGroups =

# Node image names for each of the above enabled air support groups. Groups with node targets
# should have two nodes assigned to them. You'll have to generate these images yourself (or wait
# for the program to be updated on Github). Active groups with no node images are assumed to be
# air defense groups, and will be resupplied each sortie, but not assigned nodes on the map
Group1Nodes =
Group2Nodes =
Group3Nodes =


[Quests]
# Set to True if you want kancolle-auto to manage quests; False if not.
Enabled = True

# Quests to check for. Please check the Wiki linked above for a list of supported quests. Defaults
# to a list of most generic quests. kancolle-auto will ignore quests if they are not completable
# as specified by your config (if PvP is disabled, PvP quests will not be activated, and so on).
Quests = 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

# How often should quests be checked? Settings this to 1 will make quests be checked after every
# expedition and sortie. Default is 3.
CheckSchedule = 3