Skip to content

Package and distribute your launcher

Include the extracted contents of client-helper-<version>-release.zip from your developer access. Keep client-helper.exe, its lib directory and the remaining package files together.

The helper installs the compatible client and downloads resources for the selected server. Your installer only needs your launcher and the helper package. Players need the client prerequisites.

For the Electron launcher example, place the helper outside app.asar. Its executable and DLLs need normal filesystem paths. Electron documents these ASAR limitations.

This example uses electron-builder 26. In the launcher directory, install it:

Terminal window
npm install --save-dev electron-builder@26

Save this configuration as electron-builder.yml beside package.json:

electron-builder.yml
appId: com.example.launcher
productName: Example Launcher
asar: true
files:
- "*.mjs"
- "*.cjs"
- "*.js"
- "*.html"
- "package.json"
extraResources:
- from: helper
to: helper
filter:
- "**/*"
win:
target: nsis

Set appId and productName for your launcher. Add your own asset directories to files as needed. extraResources copies the complete helper folder into the packaged application’s resources.

Build a Windows x64 folder for testing:

Terminal window
npx electron-builder --win --x64 --dir --publish never

The relevant part of the output is:

dist/win-unpacked/
├── Example Launcher.exe
└── resources/
├── app.asar
└── helper/
├── client-helper.exe
├── lib/
└── helper-package.json

The example’s main.mjs already selects the helper under process.resourcesPath when packaged. Keep using an absolute executable path with separate arguments through the main process.

After testing that folder, build the installer:

Terminal window
npx electron-builder --win --x64 --publish never

The build options control whether an unpacked folder or installer is produced. Distribute the generated setup executable from dist through your launcher download page.

Component Update path
Your launcher interface and integration Your installer and launcher updater.
Client helper Signed updates checked by the helper.
Multiplayer client Compatible release selected and installed by the helper.
Server resources Current server manifest processed during preparation.

Keep starting the helper at the path bundled with your launcher. During inspect, prepare and launch, it checks for updates and forwards the operation to the verified version. Events and the terminal result continue through the original process.

Helper updates are stored in %LOCALAPPDATA%\revo\helpers\Release\versions. The bundled copy stays in place, so updating the helper requires no write access to your launcher’s installation directory.

An optional Check helper updates action can run:

Terminal window
.\client-helper.exe update

It works without a server selection and finishes with updated. If the update service is unavailable, a previously verified cached release can be reused. Before one has been cached, normal commands may continue with the bundled helper and emit update_unavailable. Treat that as a status and wait for the operation’s final result. An explicit update returns an error when no cached release is available.

Your launcher still needs its own updates when its interface or helper-protocol integration changes. See protocol compatibility.

Test the packaged application from a shortcut, including a path with spaces and non-Latin characters. Confirm that it can run:

Terminal window
.\resources\helper\client-helper.exe info

The result should report configuration: "Release" and the supported protocolVersion. Then check first-time folder selection, installation, pause/resume and launch through the packaged interface. Run the launcher under the player’s normal Windows account so it uses that account’s saved paths and preferences.

Uninstall your launcher’s own files. Keep %LOCALAPPDATA%\revo and the selected resource storage intact. They can also be used by other launchers.

If you offer a separate action to remove downloaded resources, use the helper’s storage commands and let the player choose that action explicitly.