Build status:
A suite of static analysis tools for Victoria 2 modding.
You can download from master, or obtain the release of your choice. You can also install the following optional dependency:
- Terminal::ANSIColor for coloured output
This is a traditional Raku module distribution and can be installed through the usual means, though it is not available on https://modules.raku.org. If you’re not too sure, try the following after downloading:
$ unzip master.zip # or whichever release you got
$ zef --install ./pds-companion-master
The vic2-companion executable is able to coordinate static analysis of your Victoria 2 files, one mod at a time. In
general you should point it at the base of your mod files, and specify what you want to be checked. E.g. to perform
analysis of event and decision files:
$ vic2-companion --base=path/to/mod events decisions
(The base of your mod files is where everything is for a given mod, such as events, decisions, flag graphics. It’s the
same location that's pointed to by the path entry in the corresponding .mod file.)
You can specify any number of directories or individual files. If you want to check everything (but see the --help
regarding file extensions):
$ vic2-companion --base=path/to/mod .
Results are displayed on standard output. A successful exit code is returned unless a problem was encountered during processing or unless some result was unexpected.
Without the --base parameter or if your mod files follow an unconventional structure, analysis can still be performed
but it will be mainly syntactical. See vic2-companion --help for detailed information regarding parameters and
features such as whitelists.
Copyright © 2019–2021 moretrim. “2019–2021” and other similar notices indicate that all individual years in the range, inclusive, are covered.
Available under the terms of the GNU General Public License version 3. See the accompanying
LICENSE.markdown file for more information.
- introduced the
vic2-companionexecutable
An alpha release. Not suitable for general consumption.