Home

Awesome

unity-desktop-lite

Unity Desktop Lite extends the "desktop-lite" project by the GitHub Devcontainer team, providing a lightweight desktop environment for containerized applications, particularly those involving Unity projects.

This tool facilitates a devcontainer/codepsace setup to manage code check-outs for Unity projects more efficiently. It allows users to monitor prefab changes, scene updates, and asset modifications directly in a codespace, bypassing the need for local cloning and potentially reducing PR approval times.

unity-desktop-lite-demo

Installation

Please note,

  1. Fork the repo
  2. Configure User Secrets (These should be user-level, not repository-level secrets):
    • UNITY_USERNAME
    • UNITY_PASSWORD
    • UNITY_SERIAL
    • VNC_PASSWORD (optional - see .devcontainer)
  3. Delete .github and unity-* folders.
  4. Select your version of Unity from the Github Container Registry for the repo, and replace .devcontainer.json.image with that URI.

Usage

The current implemention is intended for project managers and coders that want to check thier Unity scenes, prefabs, and other objects.

To launch Unity, run

/opt/unity/Editor/Unity --projectPath path/to/projdir

Troubleshooting & FAQ

Unity license activation fails; not enough licenses.

Unity license activation fails; Unity personal account.

Launching the codespace takes a long time.

What does unity-desktop-lite do with my UNITY_USERNAME and UNITY_PASSWORD?

Does unity-desktop-lite work with Unity Personal accounts?

I share a repo with multiple developers. What does this mean for my Unity License and ToS?

Contributing

Contributions are welcome and greatly appreciated. To contribute, please submit a pull request with your changes for review. For areas requiring immediate attention, refer to our issues page.