rpfm_ipc/
settings_keys.rs

1//---------------------------------------------------------------------------//
2// Copyright (c) 2017-2026 Ismael Gutiérrez González. All rights reserved.
3//
4// This file is part of the Rusted PackFile Manager (RPFM) project,
5// which can be found here: https://github.com/Frodo45127/rpfm.
6//
7// This file is licensed under the MIT license, which can be found here:
8// https://github.com/Frodo45127/rpfm/blob/master/LICENSE.
9//---------------------------------------------------------------------------//
10
11//! Typed constants for all settings keys used across the application.
12//!
13//! Using these constants instead of raw string literals prevents typos
14//! and provides a single source of truth for settings key names.
15
16// Path settings.
17pub const MYMOD_BASE_PATH: &str = "mymods_base_path";
18pub const SECONDARY_PATH: &str = "secondary_path";
19pub const CUSTOM_CONFIG_PATH_KEY: &str = "custom_config_path";
20
21/// Suffix appended to a game key to form the settings key for that game's
22/// Assembly Kit path (e.g. `warhammer_3` → `warhammer_3_assembly_kit`).
23pub const ASSEMBLY_KIT_SUFFIX: &str = "_assembly_kit";
24
25// General settings.
26pub const DEFAULT_GAME: &str = "default_game";
27pub const LANGUAGE: &str = "language";
28
29/// UI theme preference. One of [`THEME_OS`], [`THEME_LIGHT`] or [`THEME_DARK`].
30pub const THEME: &str = "theme";
31
32/// [`THEME`] value: follow the OS light/dark preference (the default).
33pub const THEME_OS: &str = "os";
34/// [`THEME`] value: force the light scheme regardless of the OS preference.
35pub const THEME_LIGHT: &str = "light";
36/// [`THEME`] value: force the dark scheme regardless of the OS preference.
37pub const THEME_DARK: &str = "dark";
38
39pub const UPDATE_CHANNEL: &str = "update_channel";
40pub const AUTOSAVE_AMOUNT: &str = "autosave_amount";
41pub const AUTOSAVE_INTERVAL: &str = "autosave_interval";
42pub const FONT_NAME: &str = "font_name";
43pub const FONT_SIZE: &str = "font_size";
44pub const ORIGINAL_FONT_NAME: &str = "original_font_name";
45pub const ORIGINAL_FONT_SIZE: &str = "original_font_size";
46pub const RECENT_FILE_LIST: &str = "recentFileList";
47
48// UI settings.
49pub const START_MAXIMIZED: &str = "start_maximized";
50pub const ALLOW_EDITING_OF_CA_PACKFILES: &str = "allow_editing_of_ca_packfiles";
51pub const CHECK_UPDATES_ON_START: &str = "check_updates_on_start";
52pub const CHECK_SCHEMA_UPDATES_ON_START: &str = "check_schema_updates_on_start";
53pub const CHECK_LUA_AUTOGEN_UPDATES_ON_START: &str = "check_lua_autogen_updates_on_start";
54pub const CHECK_OLD_AK_UPDATES_ON_START: &str = "check_old_ak_updates_on_start";
55pub const USE_LAZY_LOADING: &str = "use_lazy_loading";
56pub const DISABLE_UUID_REGENERATION_ON_DB_TABLES: &str = "disable_uuid_regeneration_on_db_tables";
57pub const PACKFILE_TREEVIEW_RESIZE_TO_FIT: &str = "packfile_treeview_resize_to_fit";
58pub const EXPAND_TREEVIEW_WHEN_ADDING_ITEMS: &str = "expand_treeview_when_adding_items";
59pub const USE_RIGHT_SIZE_MARKERS: &str = "use_right_size_markers";
60pub const DISABLE_FILE_PREVIEWS: &str = "disable_file_previews";
61pub const INCLUDE_BASE_FOLDER_ON_ADD_FROM_FOLDER: &str = "include_base_folder_on_add_from_folder";
62pub const DELETE_EMPTY_FOLDERS_ON_DELETE: &str = "delete_empty_folders_on_delete";
63pub const AUTOSAVE_FOLDER_SIZE_WARNING_TRIGGERED: &str = "autosave_folder_size_warning_triggered";
64pub const IGNORE_GAME_FILES_IN_AK: &str = "ignore_game_files_in_ak";
65pub const ENABLE_MULTIFOLDER_FILEPICKER: &str = "enable_multifolder_filepicker";
66pub const ENABLE_PACK_CONTENTS_DRAG_AND_DROP: &str = "enable_pack_contents_drag_and_drop";
67pub const CLEAN_UI: &str = "clean_ui";
68pub const SINGLE_PACK_MODE: &str = "single_pack_mode";
69pub const GLOBAL_SEARCH_COLLAPSE_RESULTS: &str = "global_search_collapse_results";
70pub const GLOBAL_SEARCH_AUTO_SELECT_OPEN_PACKS: &str = "global_search_auto_select_open_packs";
71
72// Hidden/migration settings.
73pub const IMPORT_FROM_QT: &str = "import_from_qt";
74
75// Table settings.
76pub const ADJUST_COLUMNS_TO_CONTENT: &str = "adjust_columns_to_content";
77pub const EXTEND_LAST_COLUMN_ON_TABLES: &str = "extend_last_column_on_tables";
78pub const DISABLE_COMBOS_ON_TABLES: &str = "disable_combos_on_tables";
79pub const TIGHT_TABLE_MODE: &str = "tight_table_mode";
80pub const TABLE_RESIZE_ON_EDIT: &str = "table_resize_on_edit";
81pub const TABLES_USE_OLD_COLUMN_ORDER: &str = "tables_use_old_column_order";
82pub const TABLES_USE_OLD_COLUMN_ORDER_FOR_TSV: &str = "tables_use_old_column_order_for_tsv";
83pub const ENABLE_LOOKUPS: &str = "enable_lookups";
84pub const ENABLE_ICONS: &str = "enable_icons";
85pub const ENABLE_DIFF_MARKERS: &str = "enable_diff_markers";
86pub const HIDE_UNUSED_COLUMNS: &str = "hide_unused_columns";
87pub const SHOW_TABLE_TOOLBAR: &str = "show_table_toolbar";
88pub const TABLE_FILTER_NEW_CHIPS_SHARE_GROUP: &str = "table_filter_new_chips_share_group";
89
90// Debug settings.
91pub const CHECK_FOR_MISSING_TABLE_DEFINITIONS: &str = "check_for_missing_table_definitions";
92pub const ENABLE_DEBUG_MENU: &str = "enable_debug_menu";
93pub const ENABLE_UNIT_EDITOR: &str = "enable_unit_editor";
94pub const ENABLE_ESF_EDITOR: &str = "enable_esf_editor";
95pub const USE_DEBUG_VIEW_UNIT_VARIANT: &str = "use_debug_view_unit_variant";
96pub const USE_DEBUG_VIEW_GROUP_FORMATIONS: &str = "use_debug_view_group_formations";
97pub const ENABLE_RENDERER: &str = "enable_renderer";
98
99// Diagnostics settings.
100pub const DIAGNOSTICS_TRIGGER_ON_OPEN: &str = "diagnostics_trigger_on_open";
101pub const DIAGNOSTICS_TRIGGER_ON_TABLE_EDIT: &str = "diagnostics_trigger_on_table_edit";
102
103// Telemetry settings.
104pub const ENABLE_USAGE_TELEMETRY: &str = "enable_usage_telemetry";
105pub const ENABLE_CRASH_REPORTS: &str = "enable_crash_reports";
106
107/// Anonymous per-install id for telemetry.
108pub const ANONYMOUS_TELEMETRY_ID: &str = "anonymous_telemetry_id";
109
110// AI settings.
111//
112// The AI translator talks to any service that exposes the OpenAI
113// chat-completions wire format (OpenAI, Anthropic OpenAI-compat,
114// Gemini OpenAI-compat, OpenRouter, Ollama, vLLM, LM Studio, ...).
115// The user provides the full endpoint URL, an API key sent as a
116// `Bearer` token, and the model identifier to target.
117pub const AI_API_URL: &str = "ai_api_url";
118pub const AI_API_KEY: &str = "ai_api_key";
119pub const AI_MODEL: &str = "ai_model";
120pub const DEEPL_API_KEY: &str = "deepl_api_key";
121
122// Translator settings.
123pub const TRANSLATOR_SOURCE_LANGUAGE: &str = "translator_source_language";
124pub const TRANSLATOR_USE_DEEPL_GLOSSARY: &str = "translator_use_deepl_glossary";
125
126// Optimizer settings.
127pub const PACK_REMOVE_ITM_FILES: &str = "pack_remove_itm_files";
128pub const PACK_APPLY_COMPRESSION: &str = "pack_apply_compression";
129pub const PACK_APPLY_ENCRYPTION: &str = "pack_apply_encryption";
130pub const PACK_REMOVE_DUPLICATED_FILES: &str = "pack_remove_duplicated_files";
131pub const DB_IMPORT_DATACORES_INTO_TWAD_KEY_DELETES: &str = "db_import_datacores_into_twad_key_deletes";
132pub const DB_OPTIMIZE_DATACORED_TABLES: &str = "db_optimize_datacored_tables";
133pub const TABLE_REMOVE_DUPLICATED_ENTRIES: &str = "table_remove_duplicated_entries";
134pub const TABLE_REMOVE_ITM_ENTRIES: &str = "table_remove_itm_entries";
135pub const TABLE_REMOVE_ITNR_ENTRIES: &str = "table_remove_itnr_entries";
136pub const TABLE_REMOVE_EMPTY_FILE: &str = "table_remove_empty_file";
137pub const TEXT_REMOVE_UNUSED_XML_MAP_FOLDERS: &str = "text_remove_unused_xml_map_folders";
138pub const TEXT_REMOVE_UNUSED_XML_PREFAB_FOLDER: &str = "text_remove_unused_xml_prefab_folder";
139pub const TEXT_REMOVE_AGF_FILES: &str = "text_remove_agf_files";
140pub const TEXT_REMOVE_MODEL_STATISTICS_FILES: &str = "text_remove_model_statistics_files";
141pub const PTS_REMOVE_UNUSED_ART_SETS: &str = "pts_remove_unused_art_sets";
142pub const PTS_REMOVE_UNUSED_VARIANTS: &str = "pts_remove_unused_variants";
143pub const PTS_REMOVE_EMPTY_MASKS: &str = "pts_remove_empty_masks";
144pub const PTS_REMOVE_EMPTY_FILE: &str = "pts_remove_empty_file";
145
146// Internal/transient keys.
147pub const FACTORY_RESET: &str = "factoryReset";
148pub const MOVE_CHECKBOX_STATUS: &str = "move_checkbox_status";
149pub const GLOBAL_SEARCH_SOURCES_STATUS: &str = "global_search_sources_status";
150pub const GLOBAL_SEARCH_FILES_STATUS: &str = "global_search_files_status";
151pub const DIAGNOSTICS_DISABLED: &str = "diagnostics_disabled";
152pub const GEOMETRY: &str = "geometry";
153pub const WINDOW_STATE: &str = "windowState";
154pub const ORIGINAL_GEOMETRY: &str = "originalGeometry";
155pub const ORIGINAL_WINDOW_STATE: &str = "originalWindowState";
156pub const SPLIT_VIEW_SPLITTER_STATE: &str = "splitViewSplitterState";
157
158// QSettings colour keys (used by both Rust and C++ sides).
159pub const COLOUR_LIGHT_TABLE_ADDED: &str = "colour_light_table_added";
160pub const COLOUR_LIGHT_TABLE_MODIFIED: &str = "colour_light_table_modified";
161pub const COLOUR_LIGHT_DIAGNOSTIC_ERROR: &str = "colour_light_diagnostic_error";
162pub const COLOUR_LIGHT_DIAGNOSTIC_WARNING: &str = "colour_light_diagnostic_warning";
163pub const COLOUR_LIGHT_DIAGNOSTIC_INFO: &str = "colour_light_diagnostic_info";
164pub const COLOUR_DARK_TABLE_ADDED: &str = "colour_dark_table_added";
165pub const COLOUR_DARK_TABLE_MODIFIED: &str = "colour_dark_table_modified";
166pub const COLOUR_DARK_DIAGNOSTIC_ERROR: &str = "colour_dark_diagnostic_error";
167pub const COLOUR_DARK_DIAGNOSTIC_WARNING: &str = "colour_dark_diagnostic_warning";
168pub const COLOUR_DARK_DIAGNOSTIC_INFO: &str = "colour_dark_diagnostic_info";
rpfm_ipc/settings_keys.rs

rpfm_ipc/
settings_keys.rs
