Skip to main content

Builds

Build is a zip package that contains all the components required to run your game server, including game server executable files, dependent packages, and installation scripts. Finally, It will be deployed on a Machine Instance. We provide the PgosSDK for game developers, and you can use it with Unreal or Unity to generate binary files and output the build package.

1. Add a Build Install Script (optional)​

If you want to do some custom installation work after the Build is unpacked, you can add an installation script to the Build package. This is an optional operation, you can skip it if you don't need it. Create an install script for the operating system of your game build:

  • Windows: create a PowerShell script file named "install.ps1".
  • Linux: create a bash script file named "install.sh".

When creating an install script, keep in mind the following:

  • The script cannot take any user input.
  • A build is installed on a hosting server in the following locations. File directories in your build package are recreated.
    • For Windows fleets: C:/local/game
    • For Linux fleets: /local/game
  • Install script must located at the root of the build package.
    • For Windows fleets: C:/local/game/install.ps1
    • For Linux fleets: /local/game/install.sh

1.1 Example scripts​

The following examples show some common scripts for Windows and Linux.

Windows

This example install.bat file installs Visual C++ runtime components required for the game server. The component file is included in the build package.

C:\\local\\game\\vc_redist.x64.exe /install /quiet

Linux

This example install.sh file illustrates how to use bash in your install script and write the results to a log file.

#!/bin/bash
echo 'Hello World' > install.log

2. Add Builds​

When your DS program is ready, you need to compress it into a ZIP file, and then you can upload the build package to the PGOS platform according to the following steps:

Step1: Log in to the web portal, enter console and then select a title region to which you want to upload the build.

image-20220907173641982

Step2: Choose DS Hosting > Builds ， Click Add Build button:

image-20220907174525406

Fill in the fields below:

  • Build Name: A descriptive name for the build, which should be unique and cannot be modified after submission.
  • Build Version: A string which can be used to distinguish between different versions of the build.
  • OS Type: The operating system where the DS instance runs on. It can't be changed after creation.
  • Package: Select the build package locally and upload it to cloud. Currently only zip package is supported.

Setp3: Click the Submit button then a new build is created.

You can also add Builds using the PGOS CLI tool, which can be integrated into automated dev & ops processes.

3. Modify Builds​

Step1: Choose the build you want to edit and click its id or edit icon.

image-20220907195545804

Step2: You will see the Edit Build dialog as shown below:

image-20220907195638779

Step3: Make your changes and click the submit button to save your modification.

4. Delete Build​

Step1: Choose the build you want to edit and click its delete icon. image-20220907200220610

Step2: Double-check and confirm the operation before deleting.

image-20220907200354265

❗ Note:

  • The maximum build capacity available for upload game builds is 100G for each titile region.
  • We suggest that you can regularly delete unused builds as needed to make room for additional or larger builds.
  • Delete Build may not succeed when the build is associated with a fleet.
  • Please confirm the delete operation because it cannot be recovered.