Tools

Methods of the tools: optimizer, maps, startpos, animations, glTF export, MyMods and Lua tests.

`tools.optimizer_options`

Returns the optimizer options, as the server’s settings have them.

Params (GetOptimizerOptions)

Empty object: {}.

Result (OptimizerOptionValues)

Name	Type	Required	Description
`options`	map of `boolean`	yes	If each optimization is enabled, by name.

`tools.optimize`

Removes data of an open pack that’s identical to the vanilla one, or unneeded.

Runs as a job: answers right away with a job ID, and sends its result when the job ends (see Jobs).

Params (OptimizePack)

Name	Type	Required	Description
`pack`	`string`	yes	Key of the pack.
`options`	map of `boolean`	no, default `{}`	Optimizations to enable or disable, by name. The rest keep the server’s settings. See `tools.optimizer_options` for the names.

Result (FilesChanged)

Name	Type	Required	Description
`added`	array of `string`	yes	Paths of the added or edited files.
`deleted`	array of `string`	yes	Paths of the deleted files.

`tools.patch_siege_ai`

Patches the siege maps of an open pack, so the AI can use them. Warhammer games only.

Params (PatchSiegeAi)

Name	Type	Required	Description
`pack`	`string`	yes	Key of the pack.

Result (SiegeAiPatched)

Name	Type	Required	Description
`message`	`string`	yes	Description of what was patched.
`deleted`	array of `string`	yes	Paths of the files deleted by the patch.

`tools.pack_map`

Adds the tiles and tile maps of a map exported by Terry to an open pack.

Params (PackMap)

Name	Type	Required	Description
`pack`	`string`	yes	Key of the pack.
`tile_maps`	array of `string`	yes	Paths on disk of the tile maps.
`tiles`	array of `MapTile`	no, default `[]`	Tiles to add.

Result (FilesChanged)

Name	Type	Required	Description
`added`	array of `string`	yes	Paths of the added or edited files.
`deleted`	array of `string`	yes	Paths of the deleted files.

`tools.generate_missing_locs`

Adds empty loc entries for the localised columns of the tables of the open packs that have none.

Params (GenerateMissingLocs)

Empty object: {}.

Result (FilesEdited)

Name	Type	Required	Description
`edited`	array of `string`	yes	Paths of the edited files.

`tools.update_anim_ids`

Offsets the animation ids of an open pack, like after a game update moves them.

Params (UpdateAnimIds)

Name	Type	Required	Description
`pack`	`string`	yes	Key of the pack.
`starting_id`	`integer`	yes	Only ids from this one are changed.
`id_offset`	`integer`	yes	Amount to add to each id.

Result (FilesEdited)

Name	Type	Required	Description
`edited`	array of `string`	yes	Paths of the edited files.

`tools.anims_by_skeleton`

Returns the paths of the animations using a skeleton, in the open packs and the dependencies.

Params (AnimsBySkeleton)

Name	Type	Required	Description
`skeleton`	`string`	yes	Name of the skeleton.

Result (FilePaths)

Name	Type	Required	Description
`paths`	array of `string`	yes	The paths, sorted.

Name	Type	Required	Description
`file`	`FileRef`	yes	The RigidModel.
`destination`	`string`	yes	Path of the glTF file to write.

`tools.init_mymod`

Creates the folder of a new MyMod, with editor configs for Lua scripting.

Params (InitMyMod)

Name	Type	Required	Description
`game_folder`	`string`	yes	Folder name of the game of the MyMod, like `warhammer_3`.
`name`	`string`	yes	Name of the MyMod.
`sublime_support`	`boolean`	no, default `false`	If a Sublime Text project is created.
`vscode_support`	`boolean`	no, default `false`	If a VSCode config is created.
`gitignore`	`string` or `null`	no	If set, a git repository is created with this `.gitignore`.

Result (MyModCreated)

Name	Type	Required	Description
`pack_path`	`string`	yes	Path of the pack of the MyMod. It doesn’t exist until it’s saved.

`lua.run_tests`

Runs Lua tests against the scripts of the game and the open packs, outside of the game.

Runs as a job: answers right away with a job ID, and sends its result when the job ends (see Jobs).

Params (RunLuaTests)

Name	Type	Required	Description
`code`	`string`	yes	Code of the Lua test file.
`campaign`	`string` or `null`	no	Campaign whose vanilla scripts to load, like `main_warhammer`. If not set, only the script libraries and the mods are loaded.

Result (LuaTestResults)

Name	Type	Required	Description
`report`	`any`	yes	The report of the tests: passed and failed tests, with their errors and output.

`startpos.campaigns`

Returns the campaigns a startpos can be built for.

Params (GetStartposCampaigns)

Name	Type	Required	Description
`pack`	`string`	yes	Key of the pack with the startpos tables.

Result (StartposCampaigns)

Name	Type	Required	Description
`campaigns`	array of `string`	yes	Campaign keys, sorted.
`last_used`	`string` or `null`	yes	Campaign the last startpos of the pack was built for, if any.

`startpos.finish`

Imports the startpos built by the game into the pack, or cancels the build, and cleans up the build files.

Params (FinishStartpos)

Name	Type	Required	Description
`cancel`	`boolean`	no, default `false`	If the build is cancelled instead of imported.

Result (FilesEdited)

Name	Type	Required	Description
`edited`	array of `string`	yes	Paths of the edited files.

`startpos.validate`

Checks the tables a campaign’s startpos is built from, and reports what would make the build fail, hang, or drop data. Works for both ways of building startposes.

Runs as a job: answers right away with a job ID, and sends its result when the job ends (see Jobs).

Params (ValidateStartpos)

Name	Type	Required	Description
`pack`	`string`	yes	Key of the pack with the startpos tables.
`campaign`	`string`	yes	Campaign to check.

Result (StartposValidation)

Name	Type	Required	Description
`issues`	array of `StartposIssue`	yes	The problems, errors first.

Generates the startpos of a campaign from the tables of an open pack and the game’s files, and adds it to the pack as campaigns/<campaign>/startpos.esf. Unlike startpos.start, it doesn’t launch the game.

The tables are validated first (see startpos.validate), and the startpos isn’t generated if they have errors.

Experimental, and only available for Attila. The record layouts come from the game’s own startpos of the campaign, or of a campaign on the same map for new ones, completed with a layout merged from all the game’s campaigns, and are cached in the config folder.

Runs as a job: answers right away with a job ID, and sends its result when the job ends (see Jobs).

Params (GenerateStartpos)

Name	Type	Required	Description
`pack`	`string`	yes	Key of the pack with the startpos tables.
`campaign`	`string`	yes	Campaign to generate the startpos for.

Result (FilesEdited)

Name	Type	Required	Description
`edited`	array of `string`	yes	Paths of the edited files.

`startpos.extract_tables`

Extracts the start_pos_* tables of a campaign from its startpos, the pack’s or the game’s if the pack has none, and adds them to the pack as db/<table>/<campaign>_startpos, with the victory objectives the startpos has as db/victory_objectives.txt (replacing the pack’s). The inverse of startpos.generate.

The startpos doesn’t keep everything: columns the build ignores keep their default value, values the build sums over a province go to one of its regions, row ids other than the factions’ and regions’ are numbered from 1, and loot and raze objectives lose their settlements.

Experimental, and only available for Attila. The record layouts are the ones of startpos.generate.

Runs as a job: answers right away with a job ID, and sends its result when the job ends (see Jobs).

Params (ExtractStartposTables)

Name	Type	Required	Description
`pack`	`string`	yes	Key of the pack to add the tables to.
`campaign`	`string`	yes	Campaign whose startpos the tables are extracted from.

Result (FilesEdited)

Name	Type	Required	Description
`edited`	array of `string`	yes	Paths of the edited files.

`startpos.compare_tables`

Extracts the start_pos_* tables of a campaign from its startpos, like startpos.extract_tables, and compares them with the tables of the pack (and the game) the startpos is built from, to find what the build loses or changes. Rows are matched by what they describe, not by their ids.

Experimental, and only available for Attila.

Runs as a job: answers right away with a job ID, and sends its result when the job ends (see Jobs).

Params (CompareStartposTables)

Name	Type	Required	Description
`pack`	`string`	yes	Key of the pack with the startpos tables.
`campaign`	`string`	yes	Campaign whose startpos is compared.

Result (StartposComparison)

Name	Type	Required	Description
`tables`	array of `StartposTableComparison`	yes	One comparison per extracted table.

`startpos.keep_campaign`

Removes the rows of the pack’s start_pos_* tables that don’t belong to a campaign, as the Assembly Kit does before building a startpos, so tables holding several campaigns don’t break the build. Tables left without rows are deleted.

Rows of tables with a campaign column belong to their campaign; other rows belong to it if one of their references to a start_pos_* table points to one of its rows (the game’s and the pack’s rows count). Matches the Assembly Kit on Attila’s main campaign.

Params (KeepStartposCampaign)

Name	Type	Required	Description
`pack`	`string`	yes	Key of the pack with the startpos tables.
`campaign`	`string`	yes	Campaign whose rows are kept.

Result (FilesChanged)

Name	Type	Required	Description
`added`	array of `string`	yes	Paths of the added or edited files.
`deleted`	array of `string`	yes	Paths of the deleted files.

`tools.plugin_scripts`

Returns the plugin scripts in the scripts folder of the config.

Params (ListPluginScripts)

Empty object: {}.

Result (PluginScripts)

Name	Type	Required	Description
`scripts`	array of `string`	yes	Paths of the scripts.

`tools.run_plugin_script`

Runs a plugin script over files of an open pack, reading back the files it changes.

Params (RunPluginScript)

Name	Type	Required	Description
`pack`	`string`	yes	Key of the pack.
`script`	`string`	yes	Path of the script.
`paths`	array of `string`	yes	Paths of the files and folders passed to the script.

Result (PluginScriptRun)

Name	Type	Required	Description
`edited`	array of `string`	yes	Paths of the files read back into the pack.
`error`	`string` or `null`	yes	Error message of the script, if it failed.

`lua.hovers`

Returns the docs of the game’s Lua API for the symbols of a Lua script, to show on hover.

Params (GetLuaHovers)

Name	Type	Required	Description
`source`	`string`	yes	Source of the script.

Result (LuaHovers)

Name	Type	Required	Description
`hovers`	array of `LuaHover`	yes	The hovers.

`ceo.traits`

Returns the trait CEOs of the Assembly Kit tables.

Params (ListTraitCeos)

Empty object: {}.

Result (TraitCeos)

Name	Type	Required	Description
`traits`	array of [`string`, `string`]	yes	UUID and key of each trait CEO.

`ceo.add_entries`

Adds CEO entries (armour, career, traits and their locs) to an open pack.

Params (AddCeoEntries)

Name	Type	Required	Description
`pack`	`string`	yes	Key of the pack.
`entries`	array of `CeoEntryData`	yes	The entries.

Result (FilesEdited)

Name	Type	Required	Description
`edited`	array of `string`	yes	Paths of the edited files.

`ceo.build`

Builds ceo_data.ccd in the Assembly Kit from the CEO tables of an open pack, running BOB.

Params (BuildCeo)

Name	Type	Required	Description
`pack`	`string`	yes	Key of the pack.
`assembly_kit`	`string`	yes	Root folder of the Assembly Kit.
`bob`	`string`	yes	Path of BOB’s executable.

Result (Done)

Empty object: {}.

`ceo.import`

Imports the ceo_data.ccd built by ceo.build into an open pack.

Params (ImportCeo)

Name	Type	Required	Description
`pack`	`string`	yes	Key of the pack.
`assembly_kit`	`string`	yes	Root folder of the Assembly Kit.

Result (FilesEdited)

Name	Type	Required	Description
`edited`	array of `string`	yes	Paths of the edited files.

Types

Type `CeoEntryData`

A CEO entry to add.

Name	Type	Required	Description
`name`	`string`	yes	Name of the entry, used to build the keys of its rows.
`option`	`string`	yes	Kind of entry: `unique` for unique ones.
`element`	`string`	yes	Element of the entry.
`gender`	`string`	yes	Gender of the entry.
`traits`	array of [`string`, `string`]	yes	UUID and key of each trait of the entry.
`expanded`	`boolean`	yes	If the entry also starts with a sword and shield.

Type `FileRef`

A file in one of the sources.

Name	Type	Required	Description
`source`	`FileSource`	yes	Where the file is.
`path`	`string`	yes	Path of the file in its source.

Type `FileSource`

Where a file is.

One of:

{ "pack": … }: An open pack, by key.
- pack (string, yes)
"game_files": The vanilla files of the selected game.
"parent_files": The files of the parent packs of the open packs.
"assembly_kit": The tables of the selected game’s Assembly Kit. Their paths are db/<table_name>/ak_data.

Type `LuaHover`

Docs of a symbol of a Lua script. Lines and columns are 0-based.

Name	Type	Required	Description
`start_line`	`integer`	yes	Line where the symbol starts.
`start_column`	`integer`	yes	Column where the symbol starts.
`end_line`	`integer`	yes	Line where the symbol ends.
`end_column`	`integer`	yes	Column where the symbol ends.
`docs`	`string`	yes	The docs, as rich text.

Type `MapTile`

A tile of a map.

Name	Type	Required	Description
`path`	`string`	yes	Path on disk of the tile.
`folder`	`string`	yes	Subfolder of the pack’s terrain tiles folder to add it to.

Type `StartposIssue`

A problem in the tables a startpos is built from.

Name	Type	Required	Description
`level`	`DiagnosticLevel`	yes	`error` if the build fails or hangs, `warning` if it works but drops or ignores data.
`table`	`string`	yes	Table, without the `_tables` suffix.
`row`	`string`	yes	Key values of the row, joined by `\|`, or its position (`#n`) if the table has no keys.
`column`	`string` or `null`	yes	Column with the problem, if it’s about one.
`message`	`string`	yes	What’s wrong.

Type `DiagnosticLevel`

Severity of a result.

One of:

"info": A suggestion, or information about the mod.
"warning": Something that may be a mistake, or cause problems in some situations.
"error": Something that will likely cause problems, like invalid references or malformed data.

Type `StartposTableComparison`

How the rows of one table extracted from a startpos compare with the original ones.

Name	Type	Required	Description
`table`	`string`	yes	Table, without the `_tables` suffix.
`match_ratio`	`number`	yes	Share of the original values the startpos keeps, from 0 to 1.
`matched_rows`	`integer`	yes	Rows found in both.
`missing_rows`	array of `string`	yes	Keys of the original rows the startpos doesn’t keep.
`extra_rows`	array of `string`	yes	Keys of the extracted rows the original tables lack.
`columns`	array of `StartposColumnComparison`	yes	The compared columns with different values.

Type `StartposColumnComparison`

How the values of one column of the matched rows compare.

Name	Type	Required	Description
`column`	`string`	yes	Column name.
`equal`	`integer`	yes	Matched rows with the same value.
`different`	`integer`	yes	Matched rows with a different value.
`examples`	array of `StartposValueDifference`	yes	Some of the differences.

Type `StartposValueDifference`

A value the startpos keeps differently from its table.

Name	Type	Required	Description
`row`	`string`	yes	Key of the row.
`original`	`string`	yes	Value in the original table.
`extracted`	`string`	yes	Value extracted from the startpos.

Rusted PackFile Manager Documentation

Tools

`tools.optimizer_options`

`tools.optimize`

`tools.patch_siege_ai`

`tools.pack_map`

`tools.generate_missing_locs`

`tools.update_anim_ids`

`tools.anims_by_skeleton`

`tools.export_gltf`

`tools.set_video_format`

`tools.live_export`

`tools.init_mymod`

`lua.run_tests`

`startpos.campaigns`

`startpos.start`

`startpos.finish`

`startpos.validate`

`startpos.generate`

`startpos.extract_tables`

`startpos.compare_tables`

`startpos.keep_campaign`

`tools.plugin_scripts`

`tools.run_plugin_script`

`lua.hovers`

`ceo.traits`

`ceo.add_entries`

`ceo.build`

`ceo.import`

Types

Type `CeoEntryData`

Type `FileRef`

Type `FileSource`

Type `LuaHover`

Type `MapTile`

Type `StartposIssue`

Type `DiagnosticLevel`

Type `StartposTableComparison`

Type `StartposColumnComparison`

Type `StartposValueDifference`

Keyboard shortcuts

Rusted PackFile Manager Documentation