Shared Types

This page documents all the data types used in the RPFM server protocol. These types appear as parameters in Commands and as payloads in Responses.

All types are serialized as JSON. Nullable fields use null when absent.

Core Types

DataSource

Discriminates where file data originates from. Serialized as a plain string.

ContainerPath

A file or folder path within a Pack. Serialized as a tagged enum:

{ "File": "db/units_tables/data" }
{ "Folder": "db/units_tables" }

RFileInfo

Metadata about a packed file within a container.

interface RFileInfo {
  path: string;
  container_name: string | null;
  timestamp: number | null;
  file_type: string;
}

public class RFileInfo
{
    public string Path { get; set; }
    public string? ContainerName { get; set; }
    public long? Timestamp { get; set; }
    public string FileType { get; set; }
}

ContainerInfo

Reduced representation of a Pack file (container-level metadata).

interface ContainerInfo {
  file_name: string;
  file_path: string;
  pfh_version: string;
  pfh_file_type: string;
  bitmask: unknown;
  compress: string;
  timestamp: number;
}

public class ContainerInfo
{
    public string FileName { get; set; }
    public string FilePath { get; set; }
    public string PfhVersion { get; set; }
    public string PfhFileType { get; set; }
    public object Bitmask { get; set; }
    public string Compress { get; set; }
    public long Timestamp { get; set; }
}

DependenciesInfo

Information about loaded dependency files, used to populate dependency tree views.

interface DependenciesInfo {
  asskit_tables: RFileInfo[];
  vanilla_packed_files: RFileInfo[];
  parent_packed_files: RFileInfo[];
}

public class DependenciesInfo
{
    public List<RFileInfo> AsskitTables { get; set; }
    public List<RFileInfo> VanillaPackedFiles { get; set; }
    public List<RFileInfo> ParentPackedFiles { get; set; }
}

SessionInfo

Information about an active session on the server. Returned by the GET /sessions REST endpoint.

interface SessionInfo {
  session_id: number;
  connection_count: number;
  timeout_remaining_secs: number | null;
  is_shutting_down: boolean;
  pack_names: string[];
}

public class SessionInfo
{
    public int SessionId { get; set; }
    public int ConnectionCount { get; set; }
    public double? TimeoutRemainingSecs { get; set; }
    public bool IsShuttingDown { get; set; }
    public List<string> PackNames { get; set; }
}

File Types

NewFile

Parameters for creating a new packed file. Serialized as a tagged enum — the variant name determines the file type:

Example:

{ "DB": ["my_table", "units_tables", 4] }
{ "Text": ["script.lua", "Lua"] }

VideoInfo

Metadata specific to video files.

interface VideoInfo {
  format: string;
  version: number;
  codec_four_cc: string;
  width: number;
  height: number;
  num_frames: number;
  framerate: number;
}

public class VideoInfo
{
    public string Format { get; set; }
    public int Version { get; set; }
    public string CodecFourCc { get; set; }
    public int Width { get; set; }
    public int Height { get; set; }
    public int NumFrames { get; set; }
    public double Framerate { get; set; }
}

FileType

Identifies the type of a packed file. Serialized as a plain string:

CompressionFormat

Compression format for Pack files. Serialized as a plain string:

PFHFileType

Pack file type. Serialized as a plain string (e.g. "Mod", "Movie", "Boot", etc.).

Data Types

DecodedData

Cell data in a table. Serialized as a tagged enum — the variant name indicates the data type:

Example:

{ "StringU8": "hello" }
{ "I32": 42 }
{ "Boolean": true }

TableInMemory

In-memory table data structure used by DB and Loc files.

RFile

A raw packed file.

RFileDecoded

Decoded file content. Serialized as a tagged enum — the variant name indicates the file type. See Decoded File Types for each type’s structure.

Variants: Anim, AnimFragmentBattle, AnimPack, AnimsTable, Atlas, Audio, BMD, BMDVegetation, Dat, DB, ESF, Font, GroupFormations, HlslCompiled, Image, Loc, MatchedCombat, Pack, PortraitSettings, RigidModel, SoundBank, Text, UIC, UnitVariant, Unknown, Video, VMD, WSModel.

Example:

{ "DB": { "mysterious_byte": true, "guid": "", "table": { ... } } }
{ "Text": { "encoding": "Utf8Bom", "format": "Lua", "contents": "-- script" } }

TableReferences

Reference data for a column, used by lookup/autocomplete features.

Decoded File Types

DB

Decoded database table file.

Loc

Decoded localisation file.

Text

Decoded text file.

TextEncoding values: "Iso8859_1", "Utf8", "Utf8Bom", "Utf16Le"

TextFormat values: "Bat", "Cpp", "Html", "Hlsl", "Json", "Js", "Css", "Lua", "Markdown", "Plain", "Python", "Sql", "Xml", "Yaml"

Image

Decoded image file.

RigidModel

Decoded RigidModel (3D model) file.

ESF

Decoded ESF (Empire Save Format) file.

Bmd

Decoded BMD (Battle Map Data) file.

AnimFragmentBattle

Decoded AnimFragmentBattle file.

AnimsTable

Decoded AnimsTable file.

Atlas

Decoded Atlas (sprite sheet) file.

Audio

Decoded Audio file.

GroupFormations

Decoded GroupFormations file.

MatchedCombat

Decoded MatchedCombat file.

PortraitSettings

Decoded PortraitSettings file.

UIC

Decoded UIC (UI Component) file.

UnitVariant

Decoded UnitVariant file.

Schema Types

FieldType

The data type of a field in a schema definition. Most values are plain strings; sequence types wrap a nested Definition:

Field

A single field descriptor within a Definition.

Definition

Schema definition for a specific version of a DB table.

Note: The fields list is ordered to match the binary encoding of the table, which is not necessarily the order columns appear in the decoded/displayed data. To get fields in decoded column order (with bitwise expansion, enum conversion, and colour merging applied), use the FieldsProcessed command, passing the Definition as input.

Schema

The full schema containing all table definitions for a game.

DefinitionPatch

A patch applied to a schema definition. Serialized as a nested map:

{
  "field_name": {
    "property_name": "property_value"
  }
}

Type: Record<string, Record<string, string>>

Pack Settings Types

PackSettings

Per-pack configuration stored inside the Pack file.

Note

A note attached to a path within the Pack file.

OptimizerOptions

Configuration for the pack optimizer.

Translation Types

Translation

A single translation entry for a Loc key.

PackTranslation

Translation data for a pack in a specific language.

Diagnostics Types

Diagnostics

Diagnostics report configuration and results.

Update Types

APIResponse

Response from a program update check. Serialized as a tagged enum:

GitResponse

Response from a git-based update check (schemas, translations, etc.):

Search Types

SearchSource

Which data source to search. Serialized as a plain string:

SearchOn

Boolean flags for which file types to include in a search. Each field corresponds to a file type:

anim, anim_fragment_battle, anim_pack, anims_table, atlas, audio, bmd, db, esf, group_formations, image, loc, matched_combat, pack, portrait_settings, rigid_model, sound_bank, text, uic, unit_variant, unknown, video, schema

All fields are boolean.

GlobalSearch

Global search configuration and results.

Match Types

Search results use specialized match types per file format. All match containers share the same pattern: a path string and a matches array.

TableMatch (used for DB and Loc files):

TextMatch (used for text files):

UnknownMatch (used for binary/unknown files):

AnimFragmentBattleMatch (used for AnimFragmentBattle files):

AtlasMatch (used for Atlas files — same structure as TableMatch):

PortraitSettingsMatch (used for PortraitSettings files):

RigidModelMatch (used for RigidModel files):

UnitVariantMatch (used for UnitVariant files):

SchemaMatch (used for schema searches):

All match container types (e.g. TableMatches, TextMatches, AnimFragmentBattleMatches, etc.) share the same structure: { path: string, matches: <MatchType>[] }.

MatchHolder

A tagged enum wrapping a single file type’s matches. The variant name indicates the file type:

{ "Db": { "path": "db/units_tables/data", "matches": [...] } }
{ "Text": { "path": "script/campaign/mod.lua", "matches": [...] } }

Variants: Anim, AnimFragmentBattle, AnimPack, AnimsTable, Atlas, Audio, Bmd, Db, Esf, GroupFormations, Image, Loc, MatchedCombat, Pack, PortraitSettings, RigidModel, SoundBank, Text, Uic, UnitVariant, Unknown, Video, Schema.