faulo/compose-unity repository overview

⁠Compose Unity for Linux and Windows containers

This project is retired. Use faulo/unity⁠ for Unity editor installation, builds, tests, and the Unity MCP server. Use faulo/ci-tools⁠ for Steam and itch.io publishing tools.

The legacy faulo/compose-unity⁠ image combines Unity tooling and distribution utilities in one Linux or Windows container. This repository remains a reference for existing consumers.

⁠Migration

Choose the replacement for the work your container performs:

The replacements separate Unity execution from build distribution. Pipelines that perform both tasks should use the appropriate image for each step.

Review the replacement project's documentation before changing an existing deployment. Commands, environment variables, and persistent state need to be mapped explicitly; changing only the image name is insufficient.

For example, the legacy command:

compose-unity exec unity-empty-project test 2021.3.45f2

becomes this command inside the Unity image:

unity empty-project test 2021.3.45f2

The Unity image starts unity-sidecar by default and enables its MCP server with UNITY_MCP=1. CI tools provide direct publishing commands without a Unity editor or licensing setup. See the Unity documentation⁠ and CI tools documentation⁠ for credentials, volumes, and complete usage examples.

⁠Legacy images

Docker selects the platform matching the container engine when you use latest. Windows containers require a compatible Windows host. For an existing deployment that needs an exact legacy image, pin its digest.

Retirement applies to the product even if a legacy image is rebuilt or its last-updated badge changes. New deployments should use the replacements above.

⁠Legacy tests and source

The repository retains the shared launcher and sidecar under common/ComposeUnity⁠, platform Dockerfiles under linux⁠ and windows⁠, and automated tests.

Run the unit suite from the repository root with the .NET 9 SDK:

dotnet test common/ComposeUnity.Tests/ComposeUnity.Tests.csproj --configuration Release

The suite covers command routing, configuration, project inspection, Unity test-report parsing, stream handling, and state management. Separate daemon and image integration suites exercise Docker workers, mounts, command execution, and installed tools.

⁠Support

Report migration issues in the relevant replacement project's issue tracker: Unity⁠ or CI tools⁠.

⁠License

The original code, Dockerfiles, scripts, and documentation are licensed under the MIT License⁠. Unity, Steam, and other bundled software retain their respective licenses and account requirements.