Installation

Get Brody AI running in your Unity project in a few minutes. Two parts work together: the Unity Editor extension (the agent itself) and the gateway + dashboard (local servers that power the AI).

Requirements

Unity 2021.3 or newer

Personal, Pro, or Enterprise — the extension is Editor-only and works on Windows, macOS, and Linux.

No Python, no pip, no models

Brody AI is C# native. All AI traffic goes through the gateway over HTTP.

Network access to the gateway

The editor talks to the gateway at localhost (dev) or the hosted cloud (production).

A Brody AI account

Cloud sign-in for production, or a dev access key for local development.

Install the extension

Option A — unitypackage

Import the package

  1. Download BrodyAI.unitypackage from the download page.
  2. Drag it into the Unity Editor, or use Assets → Import Package → Custom Package.
  3. Wait for compilation to finish, then open Window → Brody AI.
Option B — UPM git install

Unity Package Manager

  1. Open your project, then Window → Package Manager.
  2. Click + (plus) in the top-left, choose Add package from git URL….
  3. Paste:
    https://github.com/DecNet-Games/UnityAICoPilot.git#upm
  4. Click Add and wait for the package to resolve.

Note: the #upm tag is published at release time. Until it ships, the git install adds the package shell only — the full extension ships via the repository's Assets/Brody AI folder, so also copy that folder into your project and reload the editor.

Open the window

Go to Window → Brody AI. The main agent window opens. If the menu is missing, the extension was not imported — redo the import step and reload the editor.

You will be asked to sign in. In dev mode you can use the local dev access key brody_sk_live_dev_test_access_key_12345. Production builds sign in through the cloud instead.

Run the gateway + dashboard

Easiest way — BrodyStart.bat

  1. Clone or download the repository.
  2. Double-click BrodyStart.bat (Windows). It installs dependencies, builds, and starts both servers.
  3. Gateway → http://187.77.152.23:4040 (health check: http://187.77.152.23:4040/health). Dashboard → http://localhost:3000.
  4. Wait for the window to report [gateway] ONLINE and [dashboard] ONLINE, and keep the window open.

Manual alternative

# Gateway
cd backend
npm install
Copy-Item .env.example .env    # fill in: DATABASE_URL, JWT_SECRET, HMAC_SECRET, ADMIN_SECRET_KEY, OPENROUTER_API_KEY
npm run build
npm run start

# Dashboard (second terminal)
cd dashboard
npm install
npm run build
npx next start -p 3000

First run needs a database: the gateway expects PostgreSQL at the DATABASE_URL in backend/.env. See backend/.env.example for all variable names.

Verify it works

  1. Ask a simple question: "What scripts are in my project?"
  2. Run a small proof task: "Create a simple player movement script with WASD input and add it to the player."
  3. Watch the agent plan → execute → verify. The verify/fix loop reports what it checked before applying.

Troubleshooting

ProblemFix
License error / "please log in"Close Unity, open Unity Hub, log in with your Unity account, then reopen the project.
Gateway down / connection refused on 4000Run BrodyStart.bat and wait for the window to report [gateway] ONLINE. Health check: /health.
AI returns 404 / "model not found"Your provider key is missing or wrong in backend/.env — check OPENROUTER_API_KEY (plus ANTHROPIC_API_KEY / OPENAI_API_KEY if used), then restart the gateway.
Menu Window → Brody AI missingThe extension folder was not imported. Re-import the package and reload the editor (Assets → Reimport All once).
Slow responsesFree pool models are slower than paid ones; check DEFAULT_HOSTED_MODEL in backend/.env and consider Pro for frontier models.

More issues documented on the troubleshooting page.