Available Actions

Actions

Actions are the commands your launcher runs when an event is triggered. In simple terms, an event is the thing that happens, and the action is what your launcher does next.

For example, when a button is clicked, you might run an action to change page, show an object, set a variable, start a download, or launch a game.

Pro Tip

Actions run in order from top to bottom. If you stack multiple actions on the same event, the launcher will execute them one by one.

What actions can do Navigation, UI control, variables, files, JSON, audio, downloads, platform launches, account logic, and more.

How to think about them Treat actions like building blocks. One action can do something simple. Several chained together can build an entire system.

Action Flags

Some actions are only available on the Developer plan, and some actions require a specific plugin. You’ll see those marked directly in the docs below.

Dev-Only This action or parameter requires the Developer plan.

Plugin Required This action requires a specific plugin or object type to be available.

Flow & Conditions

Compare a Variable Dev-Only

Compares one variable against a value and can stop the rest of the action chain if the result is false. This is one of the main ways to create branching logic.

Variable Name – The variable to check.
Condition – The comparison to use, such as Equals, Not Equals, Contains, Greater Than, Less Than, Is Empty, or Is Not Empty.
Value To Compare – The value to compare against. This can be left empty for empty-state checks.
Negate – Reverses the result.
Halt if Negative – Stops the rest of the action sequence if the final result is false.

Example Check whether user_role equals developer. If not, stop the rest of the actions.

Navigation & Window Control

Change Page

Switches the launcher to another page.

Page Number – The page to move to.

Example When the user clicks a Play button, send them to page 3 which contains patch notes and launch options.

Exit Launcher

Closes the launcher immediately.

Example Add this to an Exit button so the launcher closes when clicked.

Minimize Launcher

Minimizes the launcher window.

Example Use this for a custom minimize button in your top bar.

Restart Current Page

Reloads the current page and resets its objects back to their starting state.

Example Reset a settings page after the user presses a Cancel button.

Restart Launcher

Restarts the entire launcher.

Example Restart after changing a major configuration that should reload the full interface.

UI Visibility & Object Control

Show Objects

Makes one or more objects visible.

Objects – The objects to show.

Example Show a hidden login panel after the user clicks Sign In.

Hide Objects

Hides one or more objects.

Objects – The objects to hide.

Example Hide a loading spinner when a query finishes.

Move Object Dev-Only

Moves an object to a new X and Y position at runtime.

Target Object – The object to move.
X Coordinate – The new horizontal position.
Y Coordinate – The new vertical position.

Example Slide a panel into view by moving it from off-screen to a visible position.

Resize Object Dev-Only

Changes the size of an object during runtime.

Target Object – The object to resize.
New Width – New width value.
New Height – New height value.

Example Expand a progress panel when patching starts.

Destroy Object

Removes an object completely from the current runtime page.

Target Object – The object to remove.

Example Remove a temporary notification object after it has served its purpose.

Set Object Layer Dev-Only

Changes the stacking order of an object. Higher layers appear above lower ones.

Target Object – The object to update.
Layer – The new layer value.

Example Bring a modal window above the rest of the page.

Text, Images & Media

Change Text Label

Changes the text shown by a Label object.

Label Object – The label to update.
New Text – The new text value.

Example Update a welcome label to say Welcome back, Danny.

Change Button Text

Changes the text shown on a Button object.

Button Object – The button to update.
New Text – The new text.

Example Change a button from Install to Launching....

Change Image Dev-Only

Replaces the current image source of an Image object.

Image Object – The image object to change.
New Source URL – The new image path or URL.

Example Swap a banner image when the user selects a different game mode.

Change Video

Replaces the current video source of a Video object.

Video Object – The video object to update.
New Source URL – The new video path or URL.

Example Load a new trailer when the user clicks a thumbnail.

Play Sound

Plays a sound effect or audio file.

Sound URL – Audio file to play.
Volume – Playback volume.
Playback Rate (Pitch) – Playback speed and pitch.
Loop Sound – Whether the sound should loop continuously.
Sound ID – Optional unique ID so you can stop this sound later.

Example Play a hover sound when the user points at a button, or start looping ambient music on launcher start.

Stop Sound

Stops a sound that is currently playing.

Sound ID – The ID of the sound to stop.

Example Stop background music when moving into a video-heavy page.

Mute Music

Silences all music currently playing.

Example Use this when the user toggles a mute option in settings.

Volume Up

Raises the current volume by a preset step.

Example Attach this to a plus button in an audio settings page.

Volume Down

Lowers the current volume by a preset step.

Example Attach this to a minus button beside a volume label.

Launchers, Files & External Resources

Launch Local File

Opens or runs a local file or executable.

Filename – The file or executable to run.
Commandline – Optional launch arguments.
Wait for End – Whether the action should wait for the launched process to finish.

Example Launch a game executable with custom startup arguments.

OpenURL

Opens a URL in the default browser, or sends that URL into a WebView instead.

URL – The destination address.
Parameters – Optional extra parameters or data.
sendToWebview Dev-Only Param – If enabled, the URL is sent to a WebView instead of opening externally.
webviewObjectName Dev-Only Param – The WebView object to target when using the WebView route.

Example Open your support page in the user’s browser, or send the request into an embedded browser panel.

Download File

Downloads a file from a URL and optionally runs it afterwards.

Download URL – The file to download.
Exit after Download – Close the launcher after the download finishes.
Wait for End – Wait for the process or workflow to complete.
Progress Bar ID – Progress bar to update while downloading.
Exit if Error – Close the launcher if the download fails.
Run after Download – Launch the downloaded file automatically.
Target Directory Dev-Only Param – Custom destination folder for the downloaded file.

Example Download a patch installer to a custom folder, update a progress bar, then run it automatically.

Launch Registry File

Runs a registry file or registry-based setup step.

Filename – Registry file or target path.
Wait for End – Wait for completion.
Commandline – Optional parameters.
Registry Root – Registry hive to target.
Registry Key – Key path.
Registry String – The string or value being used.
64-Bit Key – Whether to use the 64-bit registry branch.

Example Apply a registry tweak before launching an older title that expects a certain setting.

Queries, Downloads & Updating

GET Query

Runs a query using a Query object.

Object – The query object to execute.

Example Fetch patch notes, server data, or launcher news using a configured query object.

Built-in Update System

Triggers a Game Update Check object so it can perform its update check.

Updater Object Name – The update checker object to run.

Example Run an update check as soon as the launcher starts.

Show Downloads Dialog Plugin Required

Shows the downloads dialog for a product and can optionally auto-download when only one matching file is found.

Product SKU – The product to load downloads for.
Auto Download if One – Automatically download if only one file exists.
Target Directory – Where downloaded files should be saved.
Run after Download – Run the selected file after download.
Commandline – Optional arguments for the launched file.
Progress Bar ID – Optional progress bar to update.

Example Show a list of customer downloads after login, then let the user grab the latest installer.

LaunchBoost: Call Patch System Dev-Only

Calls the LaunchBoost patch system with a chosen executable and arguments.

Executable Path – Path to the patch tool.
Arguments – Optional command line arguments.
Launcher Exe – Optional launcher executable reference.

Example Call the patcher silently before unlocking the Play button.

Lists

Add to List Dev-Only

Adds a new item to the end of a List Box.

List Object – The list to update.
Item Text – The new entry to add.

Example Add a freshly downloaded patch version to a history list.

Remove from List Dev-Only

Removes a line from a List Box.

List Object – The list to update.
Line Number – The line to remove.

Example Remove a queue item after it has finished processing.

Edit List Item Dev-Only

Replaces the text of an existing line in a List Box.

List Object – The list to update.
Line Number – The line to change.
New Text – The replacement text.

Example Change a list item from Pending to Complete.

Load List from File Dev-Only

Loads a text file into a List Box, one line per item.

List Object – The list to populate.
Filename – The text file to load.

Example Load a saved mod list into a list box when the launcher opens.

Save List to File Dev-Only

Saves the contents of a List Box into a text file.

List Object – The list to save.
Filename – File path to write to.

Example Save a user’s selected server list so it can be restored later.

Variables & Object Properties

Set Variable Dev-Only

Sets a global variable to a value.

Target Variable – The variable to set.
Value – The value to store.

Example Set selected_edition to Deluxe.

Set Variable from Variable Dev-Only

Copies one variable into another.

Source Variable – Variable to read from.
Destination Variable – Variable to write to.

Example Copy username_temp into username_saved.

Push to Variable Dev-Only

Reads a property from an object and stores that value in a variable. This is one of the most useful glue actions in the whole system.

Source Object – The object to read from.
Source Property – The property to read, such as text, value, or checked.
Target Variable – The variable to store the result in.

Example Push the text from a username input into login_email.

Set Object Property from Variable Dev-Only

Takes a variable value and applies it to an object property. This is effectively the reverse of Push to Variable.

Source Variable – The variable containing the value.
Target Object – The object to update.
Target Property – The property to change, such as text, value, width, opacity, or backgroundColor.

Example Set a label’s text property from a variable that contains server status.

Files, Text Data & Structured Files

Save Variable to File Dev-Only

Writes the contents of a variable into a local text file.

Source Variable – Variable to save.
Filename – Destination file path.

Example Save a user token or a simple text preference locally.

Set Variable from File Dev-Only

Reads a value from a simple key=value file and stores it in a variable.

Filename – The file to read.
Key – The key to look up.
Target Variable – Variable that receives the value.

Example Read install_path from a local config file.

Set File Value from Variable Dev-Only

Writes a variable value into a simple key=value file.

Source Variable – Variable to read from.
Filename – File to write to.
Key – Key to set in the file.

Example Write the current selected region into a local settings file.

Set Variable from INI File Dev-Only

Reads a value from an INI file and stores it in a variable.

Filename – INI file to read.
Group – INI section name.
Item – Key inside that section.
Target Variable – Variable that receives the value.

Example Read a saved graphics preset from an INI file.

Set INI Value from Variable Dev-Only

Writes a variable into an INI file.

Source Variable – Value source.
Filename – INI file to update.
Group – Section to write to.
Item – Key to update.

Example Save the selected server region into Settings.ini.

Set Variable from TOML Dev-Only

Reads a value from a TOML file into a variable.

Filename – TOML file.
TOML Path – Path within the TOML structure.
Target Variable – Variable to receive the value.

Example Read a branch name or build channel from a TOML config.

Set TOML Value from Variable Dev-Only

Writes a variable into a TOML file.

Source Variable – Variable to read from.
Filename – TOML file.
TOML Path – Destination path in the TOML data.

Example Store an environment value into a TOML-based settings file.

Set Variable from XML Dev-Only

Reads a value from XML using an XPath query.

Filename – XML file to read.
XPath – Path to the target node.
Target Variable – Variable to receive the result.

Example Read a launcher version or endpoint from an XML config file.

Set XML Value from Variable Dev-Only

Writes a variable value into XML using XPath.

Source Variable – Variable containing the new value.
Filename – XML file to update.
XPath – XPath of the node to replace.

Example Update an XML config node with the user’s selected install path.

System Data

Set Variable from System Data Dev-Only

Pulls system data and stores the result in a variable. This can be used for folders, environment values, machine details, display size, and more.

System Data Config – The system value to read.
Target Variable – Variable that stores the result.

Available system data sources include:
Environment Variable, Registry Key, AppData (Roaming), AppData (Local), My Documents, Desktop, Launcher Directory, OS Version, Username, Computer Name, CPU Name, Total RAM, Screen Width, and Screen Height.

Example Read the user’s Desktop path into a variable, then use that value in another action.

JSON

Parse JSON From Variable Dev-Only

Loads JSON text from a variable into a JSON Parser object.

Target Object – The JSON Parser object.
Source Variable – Variable containing the raw JSON text.

Example Run a query, store the JSON response in a variable, then parse it for further use.

Clear Parsed JSON Dev-Only

Clears the currently loaded JSON document from a JSON Parser object.

Target Object – The JSON Parser object to clear.

Example Clear old parsed data before loading a new response.

Set Variable From JSON Path Dev-Only

Reads a value from a JSON path and stores it in a variable.

Target Object – JSON Parser object.
JSON Path – Path to the value to read.
Target Variable – Variable that will receive the result.

Example Read downloads[0].name from parsed JSON and store it in a label variable.

Check JSON Path Exists Dev-Only

Checks whether a JSON path exists and stores a true or false style result in a variable.

Target Object – JSON Parser object.
JSON Path – Path to test.
Target Variable – Variable that stores the result.

Example Check if a response contains an error field before continuing.

Serialize Parsed JSON To Variable Dev-Only

Turns the currently parsed JSON document back into text and stores it in a variable.

Target Object – JSON Parser object.
Target Variable – Variable to receive the JSON text.

Example Save a parsed JSON document back into a variable before writing it to file.

Platform Launch Actions

Connect to FiveM Server Plugin Required

Connects to a FiveM server using the details stored in a FiveM object.

FiveM Object – The FiveM server object to use.

Example Put this on a Join Server button for your FiveM launcher.

Connect to Steam Server Plugin Required

Connects to a Steam server using a Steam object.

Steam Object – The Steam object to use.

Example Launch a direct join for a community server from the launcher UI.

Connect to Minecraft Server Plugin Required

Connects to a Minecraft server using a Minecraft object.

Minecraft Object – The Minecraft object to use.

Example Start the game and join the selected Minecraft server from one click.

Discord Presence

Initialize Discord Plugin Required

Initializes Discord Rich Presence using a configured Discord object. It can also store returned user details in variables.

Discord Object – The Discord object to initialize.
Store Username in Variable – Optional variable for the Discord username.
Store Discriminator in Variable – Optional variable for the discriminator.
Store User ID in Variable – Optional variable for the user ID.
Store Avatar URL in Variable – Optional variable for the avatar URL.

Example Initialize Discord on launcher start, then display the connected username in your UI.

Update Discord Presence Plugin Required

Updates the active Discord Rich Presence details.

Details – Main rich presence text.
State – Secondary line.
Large Image Key – Large asset key.
Large Image Text – Hover text for large asset.
Small Image Key – Small asset key.
Small Image Text – Hover text for small asset.

Example Change the Discord presence to show Browsing Servers when the user opens your server page.

Clear Discord Presence Plugin Required

Clears the current Discord presence.

Example Clear presence when the user signs out or closes the launcher.

Launcher Login & Account Actions

Launcher: Query Login Dev-Only Plugin Required

Calls the login endpoint using the configured Launcher Login object.

Launcher Login Object – The login object to use.
Username or Email – User login field.
Password – User password.

Example Push input values into variables, then call this action when the user clicks Sign In.

Launcher: Query Verify Dev-Only Plugin Required

Verifies a user using email and code.

Launcher Login Object – The login object.
Email – User email.
Code – Verification code.

Example Submit a verification form after a new account is created.

Launcher: Query Downloads Dev-Only Plugin Required

Fetches available downloads, optionally filtered by product SKU.

Launcher Login Object – The login/download object.
Product SKU (optional) – Specific product to fetch files for.

Example Fetch all downloads after login, then populate a custom UI.

Launcher: Register Dev-Only Plugin Required

Registers a new account.

Launcher Login Object – The login object.
Email – Email address.
Password – Account password.
First Name – User first name.
Last Name – User last name.

Example Build a registration form directly inside your launcher.

Launcher: Resend Verification Dev-Only Plugin Required

Resends the verification email or code.

Launcher Login Object – The login object.
Email – Address to resend to.

Example Add a Resend Code button on your verify page.

Launcher: Logout Dev-Only Plugin Required

Logs out the current user.

Launcher Login Object – The login object.

Example Put this on an account dropdown logout button.

Launcher: Refresh Entitlements Dev-Only Plugin Required

Refreshes roles, products, and downloads from the server and updates the mapped variables.

Launcher Login Object – The login object.

Example Refresh user access immediately after login or after a purchase sync.

Launcher: Check Role Dev-Only Plugin Required

Checks whether the current user has a given role.

Launcher Login Object – The login object.
Role Slug – Role to test.

Example Check whether the user has the developer role before showing advanced pages.

Launcher: Check Product Dev-Only Plugin Required

Checks whether the user owns a specific product.

Launcher Login Object – The login object.
Product SKU – Product to check.

Example Test whether the user owns a plugin before unlocking a feature page.

Launcher: Save Session Dev-Only Plugin Required

Stores the current session so the launcher can auto-login later.

Launcher Login Object – The login object.
Token – Session token to store.
Expires In (seconds) [optional] – Optional expiry time.

Example Save the login token after a successful sign-in so the user stays signed in next launch.

Launcher: Try Auto Login Dev-Only Plugin Required

Attempts to restore a stored session and sign the user in automatically.

Launcher Login Object – The login object.

Example Run this on launcher start before showing the manual login page.

Launcher: Clear Saved Session Dev-Only Plugin Required

Removes any stored session data.

Launcher Login Object – The login object.

Example Clear saved login data when the user signs out.

Launcher: Session Exists? Dev-Only Plugin Required

Checks whether a local saved session exists.

Launcher Login Object – The login object.
Var: Has Session (1/0) – Variable that stores the result.

Example Check for a saved session before deciding which page to show first.

Launcher: Forgot Password Dev-Only Plugin Required

Sends a password reset request.

Launcher Login Object – The login object.
Email – Email address to reset.

Example Add this to a forgot password form inside your launcher.

Launcher: Reset Password Dev-Only Plugin Required

Submits a new password using a reset token.

Launcher Login Object – The login object.
Reset Token – Password reset token.
New Password – The new password to apply.

Example Complete a password reset flow after the user pastes in their token.

Launcher Login Logic Checks

Launcher: If Has Role Dev-Only Plugin Required

Checks whether the current user has a specific role and can stop the remaining actions if they do not.

Launcher Login Object – The login object.
Role Slug – Role to test.
Halt if Negative – Stop the action flow if the role is missing.

Example Only continue to a developer dashboard if the user actually has the developer role.

Launcher: If Has Product Dev-Only Plugin Required

Checks whether the user owns a specific product and can stop the flow if not.

Launcher Login Object – The login object.
Product SKU – Product to test.
Halt if Negative – Stop the rest if the product is not owned.

Example Only allow access to a premium downloads page if the user owns the correct SKU.

Launcher: If Access Allowed Dev-Only Plugin Required

Checks whether the user has access to a specific feature or reference and can stop the flow when access is denied.

Launcher Login Object – The login object.
Ref (SKU/feature) – The feature or resource to test.
Halt if Negative – Stop the remaining actions if access is denied.
Var: Has Access (1/0) – Optional variable to store the result.

Example Check access to a premium plugin screen before opening it.

Final Notes

This page covers the current action list in the engine as it stands right now. If you are building advanced launcher behaviour, the most important actions to get comfortable with first are:

Change Page
Show Objects and Hide Objects
Push to Variable
Set Object Property from Variable
Compare a Variable
Parse JSON From Variable and Set Variable From JSON Path

Pro Tip

Master those first and the rest of the system starts making a lot more sense.