Crate tiger_lib 

This library forms the bulk of the -tiger family of validators: ck3-tiger, vic3-tiger, and imperator-tiger. Each executable is a small wrapper around the functions in this library that start and perform validation.

Modules

block 🔒

Block is the core type to represent Pdx script code

ck3 🔒

Files specifically for validating Crusader Kings 3 mods.

config_load 🔒

Loading and interpreting the config file.

context 🔒

ScopeContext tracks our knowledge of the scope types used in script and validates its consistency.

data 🔒

Validators for game item types which are generic across all supported games. Each sub-mod handles a specific item type or group of related item types.

datacontext 🔒

DataContext tracks what we know about the GUI datamodels and datacontexts. Currently it only tracks the ScriptedGui name.

datatype 🔒

Validator for the [ ... ] code blocks in localization and gui files. The main entry points are the validate_datatypes function and the Datatype enum.

date 🔒

The Date type represents in-game dates.

db 🔒

A general database of item types. Most game items go here.

dds 🔒

Validator for the .dds (picture) files that are used in the game.

defines 🔒

Utility code for managing the in-game defines

desc 🔒

Validator for triggered description blocks that compose a description from multiple localization keys.

effect 🔒

Validate effects, which are parts of the script that change the game state.

effect_validation 🔒

Validators for effects that are generic across multiple games.

everything 🔒

Stores everything known about the game and mod being validated.

fileset 🔒

Track all the files (vanilla and mods) that are relevant to the current validation.

game 🔒

Dealing with which game we are validating

gui 🔒

Types and functions related to .gui file processing

helpers 🔒

Miscellaneous convenience functions.

imperator 🔒

Files specifically for validating Imperator: Rome mods.

item 🔒

Giant enum for all the Item types in the game.

launcher_settings 🔒

Loader for the launcher-settings.json file.

lowercase 🔒

Type-safety wrapper for strings that must be lowercase

macros 🔒

MacroCache to cache macro expansions, and MacroMap to track Loc use across macro expansions.

mod_metadata 🔒

Loader and validator for the .metadata/metadata.json files used by Vic3

modfile 🔒

Loader and validator for the .mod files themselves.

modif 🔒

Validator for modifs which is our name for the basic things that modifiers modify.

on_action 🔒

Track scope context for the builtin on-actions in the various games.

parse 🔒

Parsers for the various kinds of game script.

pathtable 🔒

A global table for the pathnames used in FileEntry and Loc.

pdxfile 🔒

Helper functions for loading pdx script files in various character encodings.

report 🔒

Error report collection and printing facilities.

rivers 🔒

Special validator for the rivers.png/bmp file.

scopes 🔒

The core Scopes type which tracks our knowledge about the types of in-game values.

script_value 🔒

Validation of script values, which are values that update dynamically based on rules given in their math blocks.

special_tokens 🔒

token 🔒

Contains the core Token and Loc types, which represent pieces of game script and where in the game files they came from.

tooltipped 🔒

A helper type used for effects and triggers, which tracks what kind of tooltipping to expect. This affects which errors are logged about them. Some things only matter if an item is being tooltipped.

trigger 🔒

Validate triggers, which are parts of the script that specify yes or no conditions.

util 🔒

Miscellaneous helper functions related to filesystem operations.

validate 🔒

Validation functions that are useful for more than one data module.

validator 🔒

variable_scopes 🔒

variables 🔒

A registry of all the script variables that have been defined somewhere.

vic3 🔒

Files specifically for validating Victoria 3 mods.

Macros

set

Structs

Everything

A record of everything known about the game and mod being validated.

Loc

LogReportMetadata

Describes a report about a potentially problematic situation that can be logged.

ModFile

Representation of a .mod file and its contents.

ModMetadata

Representation of a metadata.json file and its contents.

PointedMessage

Token

A Token consists of a string and its location in the parsed files.

Enums

Confidence

Mostly invisible in the output. User can filter by minimum confidence level. This would be a dial for how many false positives they’re willing to put up with.

FileKind

Note that ordering of these enum values matters. Files later in the order will override files of the same name before them, and the warnings about duplicates take that into account.

Game

Enum specifying which game we are validating.

Item

“items” are all the things that can be looked up in the game databases. Anything that can be looked up in script with a literal string key, or that’s loaded into tiger’s database and needs a unique key, is an Item.

Severity

Determines the output colour. User can also filter by minimum severity level: e.g. don’t show me Info-level messages.

Functions

add_loaded_mod_root

Record a secondary mod to be loaded before the one being validated. label is what it should be called in the error reports; ideally only a few characters long.

disable_ansi_colors

Disable color in the output.

emit_reports

Print all the stored reports to the error output. Set json if they should be printed as a JSON array. Otherwise they are printed in the default output format.

get_version_from_launcher

Looks up the game’s version in the launcher settings.

log

Store an error report to be emitted when emit_reports is called.

set_output_style

Override the default OutputStyle. (Controls ansi colors)

set_show_loaded_mods

Configure the error reporter to show errors that are in extra loaded mods. Normally those are filtered out, to only show errors that involve the mod’s code.

set_show_vanilla

Configure the error reporter to show errors that are in the base game code. Normally those are filtered out, to only show errors that involve the mod’s code.

suppress_from_json

take_reports

Extract the stored reports, sort them, and return them as a hashmap with the occurrences for each instance of metadata split out.

validate_config_file

Check if config file that was passed in with –conf argument is valid. If it is not valid let the user know, set it to None, and use the default one instead.

Type Aliases

LogReportPointers

Should contain one or more elements.

TigerHashMap

TigerHashSet