Pounces on bugs. Checks Crusader Kings 3 user mod files for mistakes and warns about them. For example: missing localizations, or using a faith trigger on a character.
Crusader Kings 3 is a grand strategy game made by Paradox Interactive, and user mods are made by the players to enhance or change their game experience. This tool is for the people who make the mods.
ck3-tiger now also comes with vic3-tiger, which does the same thing for Victoria 3.
This project is maturing but not yet stable. It will warn about some things that are actually correct.
vic3-tiger is somewhat younger than ck3-tiger and will have less accurate warnings.
ck3-tiger (or vic3-tiger) will read the relevant vanilla files and your mod's files, and it will complain about everything in your mod that looks wrong. Where possible, it will tell you why it thinks the thing is wrong and (still in very few cases) what you should do instead.
ck3-tiger loads and checks nearly all the game files.
vic3-tiger still has gaps in its coverage of the game item types.
ck3-tigerDownload a release package from GitHub. Unpack it somewhere.
On Windows, if everything works out, you can then just double-click on ck3-tiger-auto and it will try its best.
Otherwise, run the tool from the command prompt:
path/to/ck3-tiger path/to/your/descriptor.mod
or
path/to/ck3-tiger "path/to/Paradox Interactive/Crusader Kings III/mod/YourMod.mod"
(Note that the quote marks around the path are important because of the spaces in it.)
If you want the output in a file, you can redirect it like this:
ck3-tiger path/to/your/descriptor.mod >filename
vic3-tigerDownload a release package from GitHub. Unpack it somewhere.
On Windows, if everything works out, you can then just double-click on vic3-tiger-auto and it will try its best.
Otherwise, run the tool from the command prompt:
path/to/vic3-tiger path/to/your/mod
or
path/to/vic3-tiger "path/to/Paradox Interactive/Victoria 3/mod/YourMod/"
(Note that the quote marks around the path are important because of the spaces in it.)
If you want the output in a file, you can redirect it like this:
vic3-tiger path/to/your/mod >filename
You can place a file ck3-tiger.conf (or vic3-tiger.conf) in your mod directory. You can use it to select which languages to check localizations for, and to suppress messages about things you don't want to fix.
There is a sample ck3-tiger.conf file and vic3-tiger.conf file in the release, with an explanation of what goes in it. There is also a guide.
You can unpack the archive from the "Release" page on GitHub and use it that way.
If you want to build it yourself, you will have to install the Rust programming language.
For ck3-tiger, run cargo build --release -p ck3-tiger in the project's directory, then run the program as cargo run --release -p ck3-tiger.
For vic3-tiger, run cargo build --release -p vic3-tiger in the project's directory, then run the program as cargo run --release -p vic3-tiger.
User unLomTrois has made a VS Code extension for ck3-tiger.
It enables you to view the reports directly in the Problems tab.
I welcome contributions and collaborations! Some forms that contributions can take:
Contributions in the form of code are also welcome. They should be made as GitHub pull requests, and you should read and understand the project's copyright license before doing so. It may help to file a GitHub issue before starting to code, though, since I may prefer to solve the problem in a different way.
Some ideas for code contributions:
See the CODING wiki page for an overview of the code and coding style.
This program is free software: you can redistribute it and/or modify it under the terms of the GNU General Public License as published by the Free Software Foundation, either version 3 of the License, or (at your option) any later version.
This program is distributed in the hope that it will be useful, but WITHOUT ANY WARRANTY; without even the implied warranty of MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the LICENSE file for more details.