/Documentation/Patch Runtime/Introduction (Quick Start)

Introduction (Quick Start)

LaunchBoost is a standalone, single-file executable patching engine. It handles self-updating, differential file patching, dependency installation, and game integrity verification. It is designed to be launched by your custom game launcher or game client.

How it Works

  1. Authentication: The patcher authenticates with the LaunchBoost API using your API Key and Project Slug.

  2. Configuration: It downloads the specific configuration (visuals, rules, server list) for your project.

  3. Execution: It runs through 6 distinct stages, from visual setup to final cleanup.

🚀 Quick Start (CLI Usage)

The patcher is controlled entirely via Command Line Arguments. You must provide at least the apiKey and project.

Standard Launch:

patcher.exe -apiKey=YOUR_KEY -project=my-game-slug

Developer/Debug Mode:

patcher.exe -apiKey=YOUR_KEY -project=my-game-slug -verbose

Silent Mode (Headless):

patcher.exe -apiKey=YOUR_KEY -project=my-game-slug -silent

Command Line Arguments (Quick Reference)

FlagTypeDescription
-apiKeystringRequired. Your LaunchBoost API Key.
-project (or -slug)stringRequired.Your Project Slug (ID)
-silentboolRun without UI (Background Updates/In-Game Embed)
-verboseboolEnables debug logging (automatically enabled on crashes)
-serverintForces a specific download server index (0-based)
-cleanOnFailboolIf patching fails, delete temporary stages files immediately.
-parallelintThe number of simultaneous downloads. We recommend a max of 5-6. Default is 1.