Noxalus / Docker-Steam

DockerSteam

Project to build a Docker image with Steamworks API installed to easily deploy a build on Steam.

The image produced is uploaded on Docker Hub here.

It contains steamcmd binary and scripts to prepare the build before the upload (change the app id, the branch, etc...).

How to build

The .gitlab-ci.yml file will do the job for you, but you need to define some environment variables in your CI settings:

• CI_REGISTRY: Use docker.io if you want to publish the image on Docker Hub registry.
• CI_REGISTRY_IMAGE: It's the URL to the registry (ex: index.docker.io/homolus/dockersteam).
• CI_REGISTRY_USER: The user account on the registry (ex: homolus).
• CI_REGISTRY_PASSWORD: The password of this account.

How to use the image

First, you will need to define multiple environment variables for your project:

• BUILD_FOLDER: The path to your game folder (the one you want to upload).
• STEAM_ACCOUNT: The account you want to use to deploy your game build.
• STEAM_PASSWORD: The password of this account.
• STEAM_SSFN_FILE_PATH: The path to the SSFN file use to get rid of the 2AF (more info here)
• STEAM_APP_ID: Your project App ID on the Steamworks dashboard.
• STEAM_DEPOT_ID: The Depot ID where you want to upload your game build (can be found on the Steamworks dashboard).
• STEAM_DESCRIPTION: The description you want to specify for your game build (optional, default value: "").
• STEAM_BRANCH: The branch you want this build to be available on (optional, default value: [NO DESCRIPTION PROVIDED]).
• STEAM_PREVIEW: "1" if it's a preview build, else "0" (optional, default value: "0")

Moreover, if you want to wrap your game binary using the Steam DRM, you can do it defining these environment variables:

• STEAM_DRM_TOOL: The tool to use to wrap your game binary. drmtoolp for the new portable tool, drmtool for old legacy Win32 tool.
• BINARY_PATH: The path to your game binary used to launch the game and that you want to wrap with the Steam DRM (ex: Binaries/MyGame.exe). This path MUST BE relative to the BUILD_FOLDER.
• STEAM_DRM_FLAGS: Bitmask of the following numeric flags specifying tool behavior (optional, default value: 0). Possible values are:
  • 0: Normal wrap (most protection)
  • 6: Compatibility mode (disables obfuscation)
  • 32: Skip debugger check
  • 64: Compatibility mode and also skip debugger check (least protection)

Make sure to retrieve the SSFN file and define the STEAM_SSFN_FILE_PATH variable or it won't work. If you don't know what it is, please check this page.

When the image is downloaded, you need to call the prepare_build.sh script:

/home/prepare_build.sh

This will replace all values in app_build_*.vdf and depot_build_*.vdf files by the ones you specified through environment variables.

Then, call the run_build.sh script:

/home/run_build.sh