preferences.json
Overview
The preferences.json file holds options specific to the User and Data version that the Launcher will be using.
For deployment it is recommended to not ship with a preferences.json file, but instead to ship with .preferences.default.json. This will allow the preferences file to regenerate using the default file as a partial override to the existing defaults.
Root folder refers to the folder where /Data is located in most instances (see config.json), where your version specific data will be kept.
Options
| Preferences Key | Config Location | Description |
|---|---|---|
registerProtocol | Hidden | Whether to register itself as the default flashpoint:// protocol handler on startup. |
imagesFolderPath | Hidden | Relative to the root folder, stores Game images. |
logoFolderPath | Hidden | Relative to the root folder, stores the default Logos. |
playlistFolderPath | Hidden | Relative to the root folder, stores the Playlist files. |
jsonFolderPath | Hidden | Relative to the root folder, stores the services.json, gotd.json, and credits.json files. |
htdocsFolderPath | Hidden | Relative to the root folder. Used as a base when opening Legacy game file locations, the folder used when the -extract mount parameter is used on Game Data, and where the content folder will be symlinked into when running a Curation from the Curate page. |
platformFolderPath | UNUSED | UNUSED |
themeFolderPath | Hidden | Relative to the root folder. Stores all installed themes as individual folders. |
logoSetsFolderPath | Hidden | Relative to the root folder. Stores all installed logo sets as individual folders. |
metaEditsFolderPath | UNUSED | UNUSED |
extensionsPath | Hidden | Relative to the root folder. Where to load Launcher extensions from. Currently not able to be disabled. |
dataPacksFolderPath | Hidden | Relative to the root folder. Where to download GameZIP / Game Data to. |
browsePageGameScale | Footer | Configurable via the bottom right slider. The zoom value used on the browse page. |
browsePageShowExtreme | Hidden | If set to false then will automatically disable all extreme Playlists from showing, and enable all Extreme tag filters without user intervention. |
hideExtremeScreenshots | UI | If set to true then will require an extra click to view Extreme game screenshots in the sidebar. Will also disable Extreme screenshots in Screenshot Preview mode. |
enableEditing | Config Page | Enables the Curate page and various editing features. |
fallbackLanguage | Config Page | The language to use when a string is not translated to your current language. |
currentLanguage | Config Page | The language to use for translations. |
browsePageLayout | Config Page | 0 for List view, 1 for Grid view. |
browsePageShowLeftSidebar | Header | Determines if the left sidebar on the Browse page should be visible. |
browsePageShowRightSidebar | Header | Determines if the right sidebar on the Browse page should be visible. |
browsePageLeftSidebarWidth | Drag Sidebar | Specifies the width of the left sidebar on the Browse Page in pixels. |
browsePageRightSidebarWidth | Drag Sidebar | Specifies the width of the right sidebar on the Browse Page in pixels. |
curatePageLeftSidebarWidth | Drag Sidebar | Specifies the width of the left sidebar on the Curate Page in pixels. |
showDeveloperTab | Config Page | Determines if the Developer tab should be visible in the header, and shows some Advanced config options. |
currentTheme | Config Page | The id of the current theme being used. |
currentLogoSet | Config Page | The id of the current logo set being used. |
lastSelectedLibrary | Hidden | The route of the last selected library (an empty string selects the default library). |
gamesOrderBy | Search Bar | The last selected order by in the search header. |
gamesOrder | Search Bar | The last selected order direction in the search header. |
mainWindow | Hidden | Contains position and size information for the main window. A little confusing, but stores both position and width to restore when the application launches again. |
defaultLibrary | UNUSED | UNUSED |
saveImportedCurations | Curate Page | Determines whether to save a copy of curations to /Curations/Imported after importing them. |
keepArchiveKey | UNUSED | UNUSED |
symlinkCurationContent | Curate Page | Determines whether to symlink or copy curation content to <htdocsFolderPath>/content (see config.json) when running (Symlink required for MAD4FP). |
onDemandImages | Config Page | Enables downloading missing thumbnails/screenshots from a remote server. |
onDemandImagesCompressed | Config Page | Determines whether to download compressed images or not. |
onDemandBaseUrl | Hidden | The base URL of the server to download missing thumbnails/screenshots from. |
browserModeProxy | Hidden | Specifies the proxy server to use during Browser Mode. Commonly used by some extensions. |
showLogSource | Logs Page | Allows selection of which sources to show or hide in the log. |
showLogLevel | Logs Page | Allows filtering of log messages by their level of importance (e.g., error, warning, info). |
excludedRandomLibraries | Config Page | List of libraries that should be excluded from random games list on the Home page. |
appPathOverrides | Config Page | Specifies application path overrides to modify specific application paths before running a game. |
tagFilters | Config Page | Allows setting up of tag filter groups to filter games from results, or make games and tags as extreme. |
tagFiltersInCurate | Curate Page | Determines whether tag filters should be applied in Curate suggestions. |
nativePlatforms | Config Page | Lists platforms where we want to launch a native application instead of using Wine. Linux / Mac only. |
disableExtremeGames | Config Page | If set, all extreme tag filters will be active and hidden, mainly for parental control purposes. |
showBrokenGames | UNUSED | UNUSED |
shortcuts | Hidden | Defines keyboard shortcuts for various actions within the application. See Shortcuts |
onlineManual | Hidden | URL of the online manual for the help page of the launcher. |
offlineManual | Hidden | Relative or Absolute Path to the offline manual for the help page in situations without internet access. |
gameDataSources | Hidden | Specifies sources from which game data will be attempted to download from. Can support multiple mirrors. |
gameMetadataSources | Hidden | Specifies sources from which game metadata can be synced. (Shown on the home page, only 1 safely supported currently) |
fpfssBaseUrl | Hidden | Base URL for the FPFSS server, used for authoring actions on remote metadata. |
server | Config Page | The name of the server process to run. See Services |
curateServer | Config Page | The name of the server process to run when running curations on the Curate page. See Services |
enablePlaytimeTracking | Config Page | Whether to track playtime for games in the database. |
enablePlaytimeTrackingExtreme | Config Page | Whether to track playtime for games matching an extreme Tag filter group. |
enableVerboseLogging | Config Page | If enabled, shows additional logging from the Database API. |
screenshotPreviewMode | Config Page | Defines the behavior of game thumbnails: 0 (Off) shows game logos, 1 (On) shows game logos until hovered for a delay then shows the screenshot, 2 (Always) always shows game screenshots. |
screenshotPreviewModeDelay | Config Page | Specifies the delay before showing a game screenshot when screenshotPreviewMode is set to 1 (On). |
searchLimit | Config Page | The maximum number of search results to display on the browse page. |