Upload game build

To load a game build to the update server, use the Build Loader command-line utility.

Build Loader system requirements:

  • Windows 7/8/10 64-bit OS or macOS 10.14.0 and higher
  • 1.6 GHz CPU
  • 100 MB free RAM
  • Free disk space: 1.5 × build size

Build Loader accepts the following options:

  • --init — initialization of the utility.
  • --update — sending the game build to the server.
  • --builds-list — a list of game builds.
  • --descr <build-description> — the build’s description.
  • --api-key <API-key> — an API key.
  • --game-path <path-to-game> — a path to the game build.
  • --chunk-size <chunk-size> — the size of chunks - parts into which the game archive is divided. Can be in MB or GB. Accepts values from 10mb to 5120mb or from 1gb to 5gb, default is 5gb.
  • --retry-timeout <timeout> — the timeout between attempts to upload files in seconds. Accepts values from 10 to 60, default is 20.
  • --retry-count <retry-count> — a number of attempts to upload files. Accepts values from 1 to 10, default is 3.

To upload a game build:

  1. Go to Publisher Account > Build settings.
  2. Copy the API key.
  3. Download and install Build Loader.
  4. Initialize the utility.
  5. Upload the game build(s) to the server.
  6. Place the game build to the stage.
  7. Set up the game files.

Initialize Build Loader

To initialize the utility, you need to pass the previously copied API key and the path to the game build:

Note
  • You only need to initialize the utility once, unless you want to change said parameters.
  • The path to the game build may contain only Latin letters.

Upload game build to the server

To upload a game build to the server, indicate the build path:

You can omit the --game-path parameter if you have already used it when initializing the utility or uploading the previous build. During the first upload, the update server receives the whole game build. Afterwards it will receive game patches generated by Build Loader.

Place the game build on the stage

When uploaded to the server, game builds are displayed in Publisher Account in Project setup > Build Settings > Build list. Select one of the two stages to place the game build to:
  • master: the game will be available for the end users,
  • test: the game will be available only for testing.
Note
To test your game, start Launcher with the -game_stage test parameter passed in the console. For example: launcher.exe -game_stage test.

Set up game files

To let Launcher send the correct files to users, first set up and initialize the installation files:
  1. In Publisher Account, go to Build settings and then Game file settings.
  2. Enter the name and the extension of the file that launches the game (for example, coolgame.exe).
  3. Specify the game installation path.
  4. Add any redistributable packages necessary to launch the game (for example, Microsoft Visual C++ 2017 Redistributable).
The launcher forwards the following parameters to the game:
  • --xsolla-locale <locale>: interface language;
  • --xsolla-login-token <token>: Xsolla Login JWT (JSON Web Token).
Example

Tutorials

Was this article helpful?
Thank you!
Is there anything we can improve? Message
We’re sorry to hear that
Please explain why this article wasn’t helpful to you. Message
Thank you for your feedback!
We’ll review your message and use it to help us improve your experience.
Rate this page
Rate this page
Is there anything we can improve?

Don’t want to answer

Thank you for your feedback!
Last updated: June 25, 2021

Found a typo or other text error? Select the text and press Ctrl+Enter.

Report a problem
We always review our content. Your feedback helps us improve it.
Provide an email so we can follow up
Thank you for your feedback!