Quick Start

The fastest way to get started with the Build Server is to use the starter template. It includes all the files you need to order your first build.

Download the starter template

Download Build Starter Template (.zip)

The template contains:

File	Purpose
`Build/build_config.json`	Tells the Build Server what builds your project supports
`Build/Pipeline/nuget.yml`	Plugin dependencies (Unity, iOS, AppSigning, SaveArtifacts)
`Build/Pipeline/definitions/`	Pipeline definitions for Android and iOS
`Build/Pipeline/values/`	Shared configuration values per platform

Setup

1. Copy files to your project

Copy the Build/ folder to your game repository root:

your-game/
  ├── Build/
  │   ├── build_config.json
  │   └── Pipeline/
  │       ├── nuget.yml
  │       ├── definitions/
  │       │   ├── android/
  │       │   │   └── store.yml
  │       │   └── ios/
  │       │       └── store.yml
  │       └── values/
  │           ├── product.yml
  │           ├── android/
  │           │   └── unity.yml
  │           └── ios/
  │               ├── unity.yml
  │               ├── xcode.yml
  │               └── signing.yml
  ├── Assets/
  ├── Packages/
  └── ProjectSettings/

2. Configure build_config.json

Update requirements to match your project’s tooling:

"requirements": {
    "xcode": "26.2",
    "unity": "6000.0.47f1"
}

3. Review the build plugins

The starter template comes preconfigured with these Build Plugins in Build/Pipeline/nuget.yml:

BuildPlugins.Unity — Runs the Unity Editor to build your game
BuildPlugins.IOS — Builds the Unity Xcode project into a signed IPA
BuildPlugins.AppSigning — Checks out iOS provisioning profiles and certificates
BuildPlugins.SaveArtifacts — Uploads build outputs to the Build Server

You don’t need to change anything here unless you want to add more plugins. See Build Plugins for details.

4. Create a Unity build script

Your Unity project needs a static C# method that the pipeline calls to build the game. See Unity Build Script for a complete example.

The method name must match the UNITY_EXECUTE_METHOD value in your pipeline values files.

5. Configure values

Edit the value files in Build/Pipeline/values/:

File	What to set
`product.yml`	Product name and bundle identifier
`android/unity.yml`	Android Unity build target and build script method
`ios/unity.yml`	iOS build script method
`ios/signing.yml`	iOS provisioning profile and signing certificate

6. Commit and order your first build

Commit the files to your repository, then go to the Build Server:

Click Order build
Select your project, branch, and revision
Choose a build target (e.g. Android)

What’s next

Ordering Builds — details on build types and options
Pipeline Definition — customize your pipeline steps
Plugins & Dependencies — add more build plugins
Protocol Reference — full build_config.json schema