DOCSEARCHbyAlgolia
Submit Docs

GameCI Documentation

website·Indexed 34 days ago

https://game.ci/

A CI/CD platform built for game developers, providing tools for automated Unity project testing and building. Documentation covers integration with GitHub Actions, GitLab CI, and CircleCI, as well as Unity Docker images, license activation, and self-hosting options using Multipass, QEMU, and Cloud-Init. Supports multiple versions, including v1, v2, and v4 (current).

Tokens
186.4K
Snippets
857
Records
1.2K
Agent score
68%

What's inside GameCI

  1. Overview of the unity3d-gitlab-ci-example project

    The unity3d-gitlab-ci-example project is a Proof of Concept demonstrating how to run Unity3D tests and builds inside a Continuous Integration (CI) pipeline using game-ci/docker Unity Editor images. It supports builds for Windows, Linux, macOS, WebGL, Linux IL2cpp, Android, and iOS Xcode projects. The project is available on both GitHub and GitLab to provide examples for GitLab-CI, Travis CI, and CircleCI.

  2. Overview of GitHub Actions Dispatch Provider

    The GitHub Actions Dispatch provider allows the orchestrator to trigger Unity builds as workflow_dispatch events on a target GitHub Actions workflow in a different repository. This is useful for separating build infrastructure from the game repository, distributing builds across organizations, using specialized runner pools (e.g., GPU machines), or isolating Unity license activation.

  3. Overview of GameCI

    GameCI provides documentation and tools to set up Continuous Integration (CI) for game projects. It enables the creation of automated pipelines that verify code changes work as expected before they are merged into the main branch, increasing release confidence and developer velocity.

  4. Overview of the Streaming Runner

    The Streaming Runner is an advanced Orchestrator capability designed for low-latency build and test iterations in large game projects. Unlike traditional CI providers that perform a full cold start (provision, clone, cache restore, build, teardown) for every job, the streaming runner keeps a runner process and workspace warm. It streams only changed content into the runner and returns structured results, significantly reducing iteration time.

  5. Overview of Unity GitLab CI setup process

    Setting up build and test automation for a Unity project on GitLab involves the following high-level steps:

    1. Understand GitLab CI basics.
    2. Configure a Unity license.
    3. Add build scripts and integrations to the Unity project.
    4. Set up the .gitlab-ci.yml pipeline configuration.

  6. Overview of GameCI for Unity

    GameCI provides ready-to-use Docker images with Unity pre-installed to automate the building, testing, and publishing of games. This eliminates the need to install Unity manually during every CI/CD pipeline run. It is free, open-source, and community-maintained.

  7. Overview of GameCI for Unity

    GameCI provides a set of tools and community resources to automate the build, test, and deployment processes for Unity games. It works by providing ready-to-use Docker images with Unity pre-installed, allowing developers to run Unity in CI/CD pipelines without manually installing the engine on every runner.

  8. Overview of Windows Docker images for Unity

    Windows Docker images are primarily used for features only available on Windows, most notably for building IL2CPP versions of Unity applications. The base image is built on .NET Framework 4.8 and includes Git and the Chocolatey package manager.

  9. Overview of GameCI Engine Plugins

    Engine plugins allow the GameCI Orchestrator to remain game-engine agnostic. While Unity is the default, plugins define engine-specific concerns such as which folders to cache between builds and what commands to run during container shutdown (e.g., returning a license). Other orchestrator functions like provisioning, git sync, and logging remain consistent across all engines.

  10. Overview of GameCI for Unity

    GameCI provides ready-to-use Docker images with Unity pre-installed, allowing developers to automate the building, testing, and publishing of games without manually installing Unity in their CI/CD pipelines. It is free, open-source, and community-driven.

  11. Overview of GameCI for Unity CI/CD

    GameCI is a free, open-source (MIT license) CI/CD platform designed to automate builds, tests, and deployments for game projects. It provides first-class support for Unity, allowing developers to generate production-ready builds for multiple platforms including iOS, Android, Windows, macOS, Linux, and WebGL. It integrates with CI/CD platforms such as GitHub Actions, GitLab CI, and CircleCI.

  12. Overview of GameCI

    GameCI provides documentation and tools to help game developers implement Continuous Integration (CI). CI allows for automated pipelines to verify that the latest code changes function correctly before they are merged into the main branch, increasing release velocity and confidence.