Skip to content
kcauto, the successor to kancolle-auto, a Kantai Collection (Kancolle) bot/automation tool
Branch: master
Clone or download
Latest commit 22a73d7 Feb 9, 2019
Permalink
Type Name Latest commit message Commit time
Failed to load latest commit information.
.github update docs Jun 22, 2018
docs-src
docs stage for master Feb 9, 2019
kcauto.sikuli stage for master Feb 9, 2019
.babelrc update, upgrade, and bugfix frontend Dec 26, 2018
.eslintignore initial commit Nov 25, 2017
.eslintrc update, upgrade, and bugfix frontend Dec 26, 2018
.gitignore add vscode dir to gitignore Feb 27, 2018
.sublimelinterrc
CHANGELOG.md
CONTRIBUTING.md rebuild bundle; minor tidying up Jun 22, 2018
LICENSE rebuild bundle; minor tidying up Jun 22, 2018
README.md add link to FAQ in readme Oct 21, 2018
config.ini add quarterly/others option to quest section of webUI Sep 9, 2018
package.json stage for master Feb 9, 2019
setup.cfg fix linting issues; add pause to config and config reader Feb 27, 2018
yarn.lock

README.md

kcauto

kcauto (previously called kcauto-kai) is a robust Kantai Collection automation tool. kcauto and it's predecessor, kancolle-auto, are proof-of-concepts in using Sikuli for vision-based automation to play Kantai Collection. They are exercises in automating large, convoluted, and complex game-playing logic. The primary logic of kcauto is written in Jython 2.7, with a standalone browser interface for config generation written in React JavaScript.

kcauto is not designed to be the fastest automation tool, but is instead robust, highly customizable, and relatively safe to use. Please read the Disclaimer below before use!


Consider supporting the developer on Patreon or MakerSupport!


Disclaimer

kcauto is meant for educational purposes only. Botting is against the rules and prolonged usage of kcauto may result in your account being banned. The developer of kcauto takes no responsibility for repercussions related to the usage of kcauto. You have been warned!

Although unlikely, users may lose ships and equipment when using kcauto to conduct combat sorties. While kcauto has been painstakingly designed to reduce the chances of this happening, the developer of kcauto does not take responsibility for any loss of ships and/or resources.


Features

  • Expedition Module — automate expeditions
    • Multiple expeditions per fleet
    • Event and non-event boss and node support expeditions
  • PvP Module — automate PvP
    • Automatic diamond or line abreast formations against submarine-heavy opponents
  • Combat Module — automate combat sorties
  • LBAS Module — automatic LBAS management
    • Automatic resupply, fatigue management, and node assignment
  • Ship Switcher Module — automatic switching of ships based on specified criteria between combat sorties
  • Fleet Switcher Module — automatic switching of fleet presets for PvP and combat sorties
  • Quests Module — automatic quest management
  • Repair & Resupply Modules — automatic resupply and repair of fleet ships
  • Stats — keeps stats on various actions performed
  • Scheduled and manual sleeping and pausing of individual modules or entire script
  • Automatic catbomb and script recovery
  • Browser/viewer-agnostic
  • Random variations in navigation, timers, and click positions to combat bot detection
  • Open-source codebase and no reporting or phoning home
  • Hot-reload config files
  • Web interface to generate and modify config files

Prerequisites

  • Game is scaled to 100% size/1x scaling — the entire game should be 1200 pixels wide and 720 pixels tall if you take a screenshot of it
  • Turn off any browser/viewer features that obscure the game (e.g. subtitles) — these can keep kcauto from properly operating. Subtitles specifically can block the damage states of ships during combat, which may lead to loss of ships due to hampered damage detection. At the very least, lower the subtitles' font size

Installation and Usage

  1. Install Java JRE 8
  2. Install SikuliX 1.1.3 with option 1 (Pack 1) selected
  3. Download kcauto either by downloading the repo or cloning it
  4. Set up kcauto's config file using the web interface or by opening the local copy of docs/index.html in a browser
    • Please refer to the Wiki for a detailed explanation of each of the config fields
  5. Run Kantai Collection in your favorite browser or viewer
  6. Run kcauto using the command java -jar <path_to_sikuli>/sikulix.jar -r <path_to_kcauto>/kcauto.sikuli (replacing <path_to_sikuli> and <path_to_kcauto> with the correct directories for your installs); you can also use the RunCmd tab of the web interface to help generate the command

Users not comfortable with the command line and looking for a GUI solution can use KAGA to both create the config and run kcauto. Please note that KAGA is not developed by the developer of kcauto, and there may be times when KAGA is not compatible with the latest version of kcauto.

Updating

The preferred method of keeping kcauto up to date is via git. This requires you have a working git installation, have cloned the kcauto repository, and are running kcauto off of said clone.

If you do have git and cloned the kcauto repository, use one of the following command to update to the latest release (master version) of kcauto:

  • git pull origin master or git pull

If you do not have git but would still like to keep up with master, please use this guide for setting up tortoisegit, but with the clone URL changed to https://github.com/mrmin123/kcauto.git

If you do not have git, tortoisegit, or a clone of the kcauto repository, head to the Releases page and download the latest tagged version. Overwrite your local kcauto installation with the contents of the new release, taking care to first back up or not overwrite your config file. Note that your config file may need updating to be compatible with new releases.

Getting help and contacting the dev

If you are encountering issues with kcauto, please first check the problems running kcauto portion of the FAQ first, as the solution to your issue may be documented already. Otherwise, please submit bugs and feature requests on the kcauto issue tracker. Please make sure you are on the latest release of kcauto and that the bug/feature has not been reported already before opening an issue on the tracker.

In addition, there are two kcauto-related Discord servers available:

  • The official kcauto server — join for kcauto-specific news, updates, help, and discussion
  • The Kancolle Auto server — maintained by the developer of KAGA; join for KAGA updates, unofficial kcauto news and help, and general Kantai Collection discussion

If you need to get in touch with the developer of kcauto, please join the official kcauto server or DM mrmin123#4639 on Discord. Please allow up to 24h for a response due to my busy schedule. Feature requests are best done via the Github issue tracker.

Contributing

If you would like to contribute to the development of kcauto, whether in the form of new features, bugfixes, documentation, or translations, please read the contribution guide first.

You can’t perform that action at this time.