Command Line Arguments

Adding additional command line arguments when running kcauto opens up some additional functionality, primarily meant for advanced/power users or debugging purposes.

Command line arguments can be passed into kcauto by appending the run command with -- [argument] [argument parameters]. The available arguments and how to use them are listed below.

cfg

Usage: java -jar <path_to_sikuli>/sikulix.jar -r <path_to_kcauto>/kcauto.sikuli -- cfg <config_file_name>

By default, kcauto loads the config.ini found in the root kcauto directory. From a usage perspective, it is entirely possible that the user would like to create separate config files for specific purposes for reuse in the future.

The user can decide to load this separate config by using the hot-reload functionality and replacing the contents of the existing config.ini with the content of their separate config file, or by stopping kcauto and re-running it with the cfg parameter and passing in the name of the config file they would like to use.

For example, if one has a separate orel.cfg with the configuration set up specifically for Orel cruising, the user can stop the script, and add the -- cfg orel.ini parameter to their kauto run command. This will load kcauto with the configuration specified in orel.ini without modifying the contents of either config.ini or orel.ini. Note that orel.ini should also be in the root kcauto directory.

debug

Usage: java -jar <path_to_sikuli>/sikulix.jar -r <path_to_kcauto>/kcauto.sikuli -- debug <window_name> <image_file_name> <optional:match_similarity>

Useful for both debugging and asset generation. Running kcauto with this argument will run a single Sikuli findAll command and list all matches for the specified image_file_name matching the optional match_similarity (defaults to 0.8) in the window matched by window_name. Useful for checking for matches against a fixed element in the game and tweaking similarity thresholds or the asset itself as needed.

debugc

Usage: java -jar <path_to_sikuli>/sikulix.jar -r <path_to_kcauto>/kcauto.sikuli -- debugc <window_name> <image_file_name> <optional:match_similarity>

Useful for both debugging and asset generation. Running kcauto with this argument will continuously run the Sikuli findAll command and list all matches for the specified image_file_name matching the optional match_similarity (defaults to 0.8) in the window matched by window_name. Useful for checking for matches against animated or moving elements in the game and tweaking similarity thresholds or the asset itself as needed. Use ctrl+c to halt the process.