Skip to main content

Control Unity Editor from Codex

Project description


name: unity description: Execute Unity Editor commands through Codex Unity Bridge. Requires the com.prodfact.codex-bridge Unity package in the current project and a running Unity Editor.

Unity Bridge Skill

Use this skill when Codex needs to interact with a live Unity Editor from the project workspace.

Overview

Codex Unity Bridge uses a deterministic Python CLI instead of ad-hoc in-context file handling. The CLI owns:

  • UUID generation
  • atomic command writes
  • polling and timeout handling
  • response parsing
  • cleanup of stale files
  • skill installation

That keeps Unity interactions stable across sessions and avoids re-implementing the file protocol each time.

Requirements

  1. The Unity project has com.prodfact.codex-bridge installed
  2. Unity Editor is open with that project loaded
  3. The project root contains .codex-unity-bridge/ after the package initializes
  4. The CLI is installed: codex-unity-bridge

Runtime Files

  • Command file: .codex-unity-bridge/command.json
  • Response files: .codex-unity-bridge/response-{id}.json

This is intentionally separate from the original Claude bridge runtime directory so both bridges can coexist in the same Unity project.

Basic Usage

Run the CLI directly:

codex-unity-bridge [command] [options]

Common commands:

codex-unity-bridge run-tests --mode EditMode
codex-unity-bridge compile
codex-unity-bridge refresh
codex-unity-bridge get-status
codex-unity-bridge get-console-logs --limit 20 --filter Error
codex-unity-bridge play
codex-unity-bridge pause
codex-unity-bridge step
codex-unity-bridge health-check

Natural-Language Examples

Typical prompts that map well to this skill:

  • Run the Unity tests in EditMode
  • Check whether Unity is compiling
  • Show the last 10 Unity errors
  • Refresh the Unity asset database
  • Pause play mode and step one frame

Guidance

  • Prefer the CLI over manual edits to bridge files
  • Use --timeout for long-running test or compile operations
  • Use get-status or health-check before assuming Unity is unavailable
  • Use get-console-logs --filter Error before asking for a broad log dump

Troubleshooting

If Codex cannot communicate with Unity:

  1. Verify the Unity Editor is open with the intended project
  2. Check that .codex-unity-bridge/ exists at the project root
  3. Run codex-unity-bridge health-check
  4. Inspect the Unity Console for [CodexBridge] messages

If the CLI is not on PATH, run:

python -m codex_unity_bridge.cli install-skill

References

Project details


Download files

Download the file for your platform. If you're not sure which to choose, learn more about installing packages.

Source Distribution

codex_unity_bridge-0.3.0.tar.gz (37.6 kB view details)

Uploaded Source

Built Distribution

If you're not sure about the file name format, learn more about wheel file names.

codex_unity_bridge-0.3.0-py3-none-any.whl (26.8 kB view details)

Uploaded Python 3

File details

Details for the file codex_unity_bridge-0.3.0.tar.gz.

File metadata

  • Download URL: codex_unity_bridge-0.3.0.tar.gz
  • Upload date:
  • Size: 37.6 kB
  • Tags: Source
  • Uploaded using Trusted Publishing? Yes
  • Uploaded via: twine/6.1.0 CPython/3.13.7

File hashes

Hashes for codex_unity_bridge-0.3.0.tar.gz
Algorithm Hash digest
SHA256 c7c7d0d527c70ce7e06005c8699c04895f0a52ea1e6738bf6affd4ad948f9699
MD5 c6cb65da7afe69ceca6d1080cd238344
BLAKE2b-256 32f394959edbfbae0e65d360060a07181574a6a8e3c46ee4bc7bbc2aa5f9cbab

See more details on using hashes here.

Provenance

The following attestation bundles were made for codex_unity_bridge-0.3.0.tar.gz:

Publisher: publish.yml on ProdFact/codex-unity-bridge

Attestations: Values shown here reflect the state when the release was signed and may no longer be current.

File details

Details for the file codex_unity_bridge-0.3.0-py3-none-any.whl.

File metadata

File hashes

Hashes for codex_unity_bridge-0.3.0-py3-none-any.whl
Algorithm Hash digest
SHA256 7acef0267d61c61deb17b40d2c99561f606d5888f77b54ce805b0e4ba1f46c10
MD5 871a7c05093bfdaf9051f292432e9c7e
BLAKE2b-256 2f436275a6d270718831f7e74836100a76a781dcea664375ded5664ebe15bd88

See more details on using hashes here.

Provenance

The following attestation bundles were made for codex_unity_bridge-0.3.0-py3-none-any.whl:

Publisher: publish.yml on ProdFact/codex-unity-bridge

Attestations: Values shown here reflect the state when the release was signed and may no longer be current.

Supported by

AWS Cloud computing and Security Sponsor Datadog Monitoring Depot Continuous Integration Fastly CDN Google Download Analytics Pingdom Monitoring Sentry Error logging StatusPage Status page