Installation and Usage

Compatibility

All browsers, viewers, and operating systems are compatible as long as the entirety of the Kancolle game window is visible at 100% scale (including OS-level scaling).

Installation and Usage

1. Install Java JRE 8
   • Unix only: Install additional packages: wmctrl xdotool tesseract-ocr libopencv-core2.4v5 libhighgui2.4 (or your distribution's equivalent)
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
   • Take note to turn off any browser/viewer features that obscure parts of the game screen (such as subtitles). These have the ability to hinder proper damage state detection by kcauto, which may lead to loss of ships.
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.

If you have issues installing or getting kcauto to run, please refer to the FAQ before opening an issue ticket.

Tips and Tricks

• You can create a batch/bash file or alias to launch kcauto with ease

  • For Windows:

    @ECHO off
    java -jar <path_to_sikuli>\sikulix.jar -r <path_to_kcauto>\kcauto.sikuli
    

    Save the file as .bat in an easy-to-access location.

  • For Linux (method 1):

    #!/bin/bash
    java -jar <path_to_sikuli>/sikulix.jar -r <path_to_kcauto>/kcauto.sikuli
    

    Save the file as .sh in your favorite space. Open terminal, open the bash file location, and run: chmod u+x <filename>.sh (allows for double-click and execution of the script).

  • For Linux (method 2): You can create an alias for the command in your .bashrc file or its equivalent like so:

    alias kca='java -jar <path_to_sikuli>/sikulix.jar -r <path_to_kcauto>/kcauto.sikuli'
    

    Just run the alias kca from any terminal window (works best if the above paths are absolute paths) to run!

• If you have multiple config files to switch between, you can use the cfg parameter to run kcauto with a config file not named config.ini: java -jar <path_to_sikuli>/sikulix.jar -r <path_to_kcauto>/kcauto.sikuli -- cfg <cfg_file_name>

• If you created a new asset and want to check if it works, or if you want to debug a FindFailed error, use the debug parameter to run kcauto in a special findAll mode, which finds all matches of the specified asset in the specified window before exiting: java -jar <path_to_sikuli>/sikulix.jar -r <path_to_kcauto>/kcauto.sikuli -- debug <window_name> <name_of_asset> <similarity:optional>

• See the Command Line Arguments page for additional information on the above two commands

• If kcauto-kai is crashing a lot, please run the script with the debug option -d 3 to help find the error: java -jar <path_to_sikuli>/sikulix.jar -r <path_to_kcauto_kai>\kcauto-kai.sikuli -d 3. This more-detailed log also helps with debugging when opening a new issue.