Module settings 

Persistent settings store and config-path helpers.

Settings are kept in a single JSON file under the OS-specific config directory (resolved through [directories::ProjectDirs]) and exposed as a per-type Settings map: bool, i32, f32, String, raw bytes, and Vec<String>. Both the UI and the server side use the same rpfm_ipc::settings_keys constants when reading and writing, so a typo becomes a compile error rather than a silently-missed setting.

Structs

Settings

Snapshot of every persisted setting.

Constants

CONFIG_REDIRECT_FILE_NAME 🔒

File for storing the path to the user-chosen custom config folder.

DEPENDENCIES_FOLDER 🔒

SCRIPTS_FOLDER 🔒

Folder under config_path where the user drops plugin scripts (.py/.lua).

SETTINGS_FILE_NAME 🔒

TABLE_PATCHES_FOLDER 🔒

TABLE_PROFILES_FOLDER 🔒

TRANSLATIONS_LOCAL_FOLDER 🔒

TRANSLATIONS_REMOTE_FOLDER 🔒

Functions

backup_autosave_path

This function returns the autosave path.

clear_config_path

Recursively deletes the config folder, then re-runs init_config_path to recreate the standard sub-folders. Refuses to delete anything outside config_path.

config_path

This function returns the active config path: the user’s custom folder if one is set, or the default otherwise.

custom_config_path

This function returns the user-configured custom config folder, or None if RPFM uses the default one.

default_config_path

This function returns RPFM’s default config path, ignoring any custom-folder redirect.

dependencies_cache_path

This function returns the dependencies path.

error_path

This function returns the path where crash logs are stored.

init_config_path

Function to initialize the config folder, so RPFM can use it to store his stuff.

lua_autogen_base_path

This function returns the lua autogen path.

lua_autogen_game_path

This function returns the lua autogen path for a specific game.

old_ak_files_path

Folder under config_path holding archived Empire/Napoleon Assembly Kit definitions (no AK was ever shipped for these games, so RPFM bundles a frozen copy via the old_ak_files submodule).

schemas_path

This function returns the schema path.

scripts_path

Folder under config_path where the user drops plugin scripts shown in the PackFile contents context menu.

set_custom_config_path

This function sets (or clears, when passed None) the custom config folder and initializes it.

table_patches_path

Folder under config_path where user-side schema patches live.

table_profiles_path

Folder under config_path where saved table view profiles (column orders, filters, hidden columns) are persisted.

translations_local_path

Folder under config_path where the user’s local mod translations are stored (one JSON per pack/language).

translations_remote_path

Folder under config_path where the local clone of the Translation Hub repository is mirrored.