#mod #validation #linter #crusaders #vic3 #victoria3

bin+lib vic3-tiger

Validator that checks Victoria 3 user mod files for mistakes and warns about them. For example: missing localizations, or using a state trigger on a country. Victoria 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.

21 releases

new 0.9.6 Apr 12, 2024
0.9.5 Mar 27, 2024
0.8.12 Feb 29, 2024
0.8.10 Jan 30, 2024
0.7.4 Jul 22, 2023

#519 in Game dev

Download history 1/week @ 2024-01-15 8/week @ 2024-01-22 2/week @ 2024-01-29 1/week @ 2024-02-05 169/week @ 2024-02-26 241/week @ 2024-03-04 166/week @ 2024-03-11 2/week @ 2024-03-18 237/week @ 2024-03-25 43/week @ 2024-04-01

458 downloads per month

GPL-3.0-or-later

5.5MB
97K SLoC

Tiger Banner

GitHub Release GitHub License tiger-lib docs.rs Discord

Tiger 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, and with imperator-tiger, which does the same thing for Imperator: Rome.

Status

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.

Features

ck3-tiger (or vic3-tiger or imperator-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.

  • Syntax validation: are you using the right key = value pairs? No misspellings?
  • Missing items: is every game object that you refer to actually defined somewhere?
  • Missing localizations: do you have all the localizations you need for your mod?
  • Scope consistency checking: are you using culture effects on cultures and character effects on characters, etc.?
  • History (for CK3): Are spouses, employers, and lieges alive on the relevant dates? Is no one their own grandfather?
  • Special: rivers.png check

Sample output

Sample Output

Sample Output

Sample Output

How to use

ck3-tiger

Download 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-tiger

Download 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

imperator-tiger

Download a release package from GitHub. Unpack it somewhere.

Run the tool from the command prompt:

path/to/imperator-tiger path/to/your/descriptor.mod

or

path/to/imperator-tiger "path/to/Paradox Interactive/ImperatorRome/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:

imperator-tiger path/to/your/mod >filename

How to configure

You can place a file ck3-tiger.conf (or vic3-tiger.conf or imperator.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, vic3-tiger.conf file, and imperator-tiger.conf file in the release, with an explanation of what goes in it. There is also a guide.

How to build

If you want to build it yourself, you will have to install the Rust programming language. You can either get the source archive from one of the releases (preferably the latest) or clone the git repository.

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.
For imperator-tiger, run cargo build --release -p imperator-tiger in the project's directory, then run the program as cargo run --release -p imperator-tiger.

Visual Studio Code extension

User unLomTrois has made a VS Code extension for ck3-tiger. It enables you to view the reports directly in the Problems tab.

Showing only new reports

You can tell tiger to suppress reports that were shown in a previous run. This can be helpful when you only want to see what changed, for example after updating your mod. First you have to generate a "baseline" to compare future runs to:

ck3-tiger --json path/to/your/mod >baseline.json

You can use any filename in place of baseline.json. Then when you run tiger again, you can tell it to exclude reports from the baseline:

ck3-tiger --suppress baseline.json path/to/your/mod

It works with vic3-tiger and imperator-tiger too.

Contributions

I welcome contributions and collaborations! Some forms that contributions can take:

  • Suggestions and ideas about what things tiger should check
  • Telling me which of the output messages are confusing or hard to understand
  • Reporting cases where tiger complains about a problem that's not real (false positives)
  • Filing an issue on GitHub about a problem you have, or sending me email directly
  • Starting up the game to verify something that's marked "TODO: verify" in the code

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:

  • Adding a new check and its error report
  • Adding a validator for a new item type
  • Updating a validator to a new game version
  • Solving one of the hundreds of TODO comments in the code
  • Solving one of the issues marked in the TODO or IDEAS wiki pages
  • Speed or memory use improvements; opportunities are all over the place

See the CODING wiki page for an overview of the code and coding style.

License

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.

Dependencies

~21–40MB
~536K SLoC