Main Site

Game Update Check

Object Concept Preview
Update Logic Visualization
Local Version
v1.0.3
⟷
Remote Version
v1.0.4
Click to check for updates...
Developer Edition Object
Non-Visual Object

The Game Update Check object is the backbone of keeping your players up to date. It is a non-visual utility that silently compares the game version installed on the user's computer against a live version hosted on your remote server.

When triggered inside your Custom Launcher, it handles the complex logic of parsing local files or registry keys, fetching the remote version string, and deciding if an action needs to be taken. Whether you want to quietly prompt a download or open a patch notes webpage, this object manages the entire flow automatically.

Pro Tip

The Game Update Check object is available in the Developer Edition. It operates invisibly in the background during runtime, requiring no complex visual layout, leaving you free to design your own custom loading screens or prompt dialogs.

Game Update Check Overview

Because this object is non-visual, it appears as a placeholder block in the editor. You configure its behavior through the properties panel, defining exactly where it should look for version numbers locally and remotely. When a mismatch is detected, it executes your chosen update action.

Typical Uses

  • ❖ Automatically verifying the game version on startup
  • ❖ Downloading and running a patch installer seamlessly
  • ❖ Directing users to a web portal to download large expansions
  • ❖ Pushing version numbers to variables for display on a Text Label

Properties Configuration

The configuration dictates exactly how the system reads local data, checks the web, and reacts.

Remote Source

  • Remote Version URL: The direct HTTP or HTTPS address to a text file that contains your latest version string (e.g., 1.0.4).

Local Source

You can choose exactly how your Custom Game Launcher reads the locally installed game version from the user's hard drive.

  • INI File: Specify the file path, section, and key name.
  • TXT File: Point to a plain text file containing only the version string.
  • TOML File: Read from modern TOML configurations using a dot-notation path (e.g., game.version).
  • XML File: Use an XPath query to extract the version from structured XML nodes.
  • Registry: Read directly from the Windows Registry by providing the Root hive, Path, and Key.

Variables and Actions

  • Version Variables: Optionally store the extracted local and remote version strings into global variables, allowing you to display them on your UI.
  • If Update Available: Choose what happens when the remote string does not match the local string.
    • Do Nothing: Halts the automated flow (useful if you only want to push variables).
    • Download and Run File: Instantly downloads an installer from a specified URL and executes it. You can opt to exit the launcher once the download begins.
    • Open Web Page: Launches the user's default browser to a designated URL, such as a forum post or direct download page.

Events

Unlike standard interactive objects like Buttons, the Game Update Check object is strictly action-driven and does not expose standalone events. It operates autonomously based on the settings configured in its properties panel once commanded to start.

Actions

To initiate the comparison process, you must trigger the object using the following dedicated action.

Action How it works
Built-in Update System Instructs the selected Game Update Check object to perform its read, fetch, and compare sequence immediately.

Building Logic with the Update Checker

You can execute the update logic silently on startup, or give players the choice to check manually.

Example 1: Automated Startup Check

Ensure players are always prompted to update the moment they open the application.

  1. Place the Game Update Check object on your main page.
  2. Configure it to read your local version.txt and set your Remote URL. Set the Update Action to Download and Run File.
  3. Open your Global Events from the top toolbar and locate the On Launcher Start event.
  4. Add the Built-in Update System action and target your object. The system will now scan for updates before the user can even click "Play".

Example 2: Visual Version Display

Show the installed version on the bottom right of the launcher interface.

  1. In your Game Update Check object properties, assign the "Local Version Var" field to a new variable called installed_ver. Set the Update Action to Do Nothing.
  2. Add a Text Label to your page and style it to match your footer design.
  3. Trigger the Built-in Update System action via the On Launcher Start event.
  4. Immediately follow that action with a Set Object Property from Variable action, applying the installed_ver variable to the text property of your new Label.

Custom CSS Note

Because the Game Update Check is a non-visual object, styling it does not alter the appearance of your compiled launcher. Custom CSS is only used here to stylize the placeholder icon within the Developer Edition editor, helping you organize complex workspaces.

Important Notice

Overrides applied here will only be visible while designing your interface in the editor canvas. The object remains invisible when the launcher is running.

css

/* Developer Edition Custom CSS Example for Game Update Check */
/* Creates a pulsing border around the placeholder to signify network activity */
border: 2px solid #3b82f6 !important;
border-radius: 12px !important;
background: rgba(59, 130, 246, 0.1) !important;
opacity: 0.7 !important;
:hover {
 opacity: 1 !important;
 background: rgba(59, 130, 246, 0.25) !important;
 box-shadow: 0 0 15px rgba(59, 130, 246, 0.5) !important;
}

Summary

The Game Update Check object automates one of the most critical aspects of maintaining a live community. By configuring a few simple paths and pairing it with standard actions, you can build a Custom Game Launcher that guarantees your players always have the latest content and bug fixes installed before they jump into the game.