Path to the application that runs the additional application
If the additional application should run before the game. (If true, this will always run when the game is launched) (If false, this will only run when specifically launched)
ID of the additional application (unique identifier)
Command line argument(s) passed to the application to launch the game
Name of the additional application
Parent of this add app
Wait for this to exit before the Game will launch (if starting before launch)
Data contained in the Config file
Upper limit of the range of ports that the back should listen on.
Lower limit of the range of ports that the back should listen on.
If games flagged as "extreme" should be hidden (mainly for parental control)
Path to load User extensions from (relative to the flashpoint path)
Path to the Flashpoint root folder (relative or absolute)
Path to the image folder (relative to the flashpoint path)
Upper limit of the range of ports that the back image server should listen on.
Lower limit of the range of ports that the back image server should listen on.
Path to the json folder (relative to the flashpoint path)
Last time the Metadata Server Host was synced with
Path to the logo folder (relative to the flashpoint path)
Path to the logo sets folder (relative to the flashpoint path)
Base URL of the server to do pastes of the Logs to.
Path of the meta edits folder (relative to the flashpoint path)
Metadata Server Host (For Online Sync)
Array of native locked platforms
Base URL of the server to download missing thumbnails/screenshots from.
Path to the platform folder (relative to the flashpoint path)
Path to the playlist folder (relative to the flashpoint path)
If games flagged as "broken" should be hidden
If the Server should be started, and closed, together with this application. The "server" is defined in "services.json".
Path to the theme folder (relative to the flashpoint path)
Whether to notify that launcher updates are available
If the custom title bar should be used in MainWindow
Contains state of all non-config settings the user can change in the application. This is the data contained in the Preferences file.
Application path overrides to check during app launches
Scale of the games at the BrowsePage.
Layout of game collection at BrowsePage.
Width of the left sidebar. (Browse Page)
Width of the right sidebar. (Browse Page)
If "Extreme" games should be shown at the BrowsePage.
If the left sidebar at the BrowsePage should be visible.
If the right sidebar at the BrowsePage should be visible.
Width of the left sidebar. (Curate Page)
Current language
Filename of the current logo set
Filename of the current theme.
Default Library for new games etc.
If editing games, additional applications and playlists should be allowed.
Libraries that should be excluded from random picks.
Default language used for fallback
What order the games should appear in.
What property to order the games by.
The "route" of the last selected library (empty string selects the default).
Position and size of the main window.
Download missing thumbnails/screenshots from a remote server.
Save curations after importing
If the "Developer" tab should be visible in the header.
Levels to show/hide in the log page.
Sources to show/hide in the log page.
Whether to symlink or copy curation content when running (Symlink required for MAD4FP)
Options expected for 'browser' mode application return
Files / Folders being copied, and to where
Path of the curation
Game being imported
Utility type. Recursively set all properties as optional.
A self-nesting type that allows one time disposable with an optional callback
Whether this is already disposed
Callback to use when disposed
Children to dispose of in the future. Add with registerDisposable to maintain safety.
Put all extension disposables on here with registerDisposable
A search filter that applies to a specific field.
The field the filter applies to.
Value to search for in the field.
Options for ordering games.
Playlist to limit the results to (no playlist limit will be applied if undefined).
Search query to filter by
Ranges of games to fetch (all games are fetched if undefined).
All attached Additional Apps of a game
Any alternate titles to match against search
Path to the application that runs the game
If the game is "broken" or not
Date-time of when the game was added to collection
Date-time of when the game was added to collection
Name of the developer(s) of the game (developer names are separated by ',')
Game is not suitable for children
ID of the game (unique identifier)
The language(s) the game is in
Command line argument(s) passed to the application to launch the game
Library this game belongs to
Information that could be useful for the player (of varying importance)
Unused
Original description of the game (probably given by the game's creator or publisher)
ID of the game which owns this game
If the game is a placeholder (and can therefore not be saved)
Platform the game runs on (Flash, HTML5, Shockwave etc.)
If the game is single player or multiplayer, and if the multiplayer is cooperative or not
Name of the publisher of the game
Date of when the game was released
Game series the game belongs to (empty string if none)
Source if the game files, either full URL or the name of the website
How playable the game is
List of tags attached to the game
Full title of the game
Version of the game
Info type passed to onWillLaunch events
Game field to order the results by
Direction to return the results in (ascending or descending)
Data passed to merge tags together
Replacement of "object" type. Note: I'm not sure how effective it is though //obelisk
Tuple of values from the last game of a previous page (look up "keyset pagination").
ID of the game (unique value).
Primary order value.
Title of the game (secondary order value).
Object representation of a parsed search query.
Whitelists to apply
Generic filter to blacklist some predetermined field(s).
Generic filter to whitelist some predetermined field(s).
Blacklists to apply
Author of the playlist.
Description of the playlist.
Attribute for if playlist contains games not suitable for children
Games in this playlist
Icon of the playlist (Base64 encoded image).
ID of the playlist (unique identifier)
Route of the library this playlist is for.
Title of the playlist.
Game this represents (either ID or Game will exist)
Game this represents (either ID or Game will exist)
Internal ID of the playlist game entry
Notes for the game inside the playlist specifically
Order priority of the game in the playlist
Playlist which owns this game (either ID or Playlist will exist)
Playlist which owns this game (either ID or Playlist will exist)
Arguments to pass to the process
Name of the file to execute
Path of the file (relative to the Flashpoint root)
Tuple of the last game of the previous page. If this is set then "start" must be the index of the game after this (since this will be used instead of "start" when selecting the games).
Number of games to request (if undefined, all games until the end of the query will be included).
Index of the first game.
Games found within the range.
Number of games requested.
Index of the first game.
See Electron docs for explanations. https://www.electronjs.org/docs/api/dialog
See Electron docs for explanations. https://www.electronjs.org/docs/api/dialog
See Electron docs for explanations. https://www.electronjs.org/docs/api/dialog
Aliases / Names of the tag
Category this tag is a part of (either ID or TagCategory will exist)
Category this tag is a part of (either ID or TagCategory will exist)
Number of games this tag belongs to
Date when this tag was last modified
Description of the tag
Games which are marked with this Tag
ID of the tag (unique identifier)
Primary Alias
ID of Primary Alias
ID of the tag alias (unique identifier)
The name this alias represents
Tag this alias belongs to (either ID or Tag will exist)
Tag this alias belongs to (either ID or Tag will exist)
Category Color
Description of the Tag Category
ID of the tag category (unique identifier)
Category Name
Tags using this Tag Category
Alias found, only present if not the same as the primary alias
Primary alias of the tag suggestion
Tag suggested
Shortend version of Game returned in searches, makes for better performance.
Config Data
Path to own extension
Called when a client connects to the backend
Called when the backend has fully initialized. Extension activation is earlier.
Version of the Flashpoint Launcher
Dispose of all a disposable;s children but not itself
Dispose of a disposable and all its children
Get a URL for an extensions file
Relative path to file from extension path
Returns most up to date Preferences Data
Loads the extensions config file (
Creates Disposable data to fill a newly created Disposable type object
Callback to run when disposed
Updates the Preferences data with a partial change.
Partial data to apply
Callback for error handling
Updated Preferences data
Register a disposable to its parent. They must not be the same.
Parent to register to
Child to register
Saves data to the extensions config file (
Unload own extension
Unzips a file into a given directory (7zip)
Path to archive
Directory to output into
Generated using TypeDoc
Based off Microsoft VSCode's extension system (MIT Licensed) https://github.com/Microsoft/vscode Module is created during runtime and injected. Please read the documentation below to understand how to use these types. See https://github.com/FlashpointProject/launcher/blob/develop/docs/extensions.md for Extension documentation. See https://flashpointproject.github.io/launcher_ApiDocs/ (or /docs/api in the repo) for API documentation.