Aether

Quickstart Guide

Get Aether running in under 3 minutes. This guide will take you from zero to your first AI-visible Unity session.

Prerequisites

Before you begin, make sure you have:

  • Unity 2021.3 LTS or newer (including Unity 6)
  • Cursor IDE with MCP support
  • Windows, macOS, or Linux

Step 1: Download Aether

Download the Aether bridge binary for your operating system and the Unity SDK package.

ℹ️Download Links

Visit the Downloads page to get the latest bridge binaries and Unity SDK.

You'll need:

  • Bridge binary: aether-bridge-{os}-{arch} executable
  • Unity SDK: a versioned zip (e.g. aether-sdk-vX.Y.Z.zip)

Step 2: Install Unity SDK

  1. Open your Unity project
  2. Extract the Unity SDK zip (it contains an Aether/ folder)
  3. Copy Aether/ into your Unity project’s Assets/ folder (so you have Assets/Aether)
  4. Unity will auto-import the scripts
ℹ️Alternative: UPM

For Unity Package Manager, add via Package Manager → Add from git URL:

1https://github.com/finexma-dev/aether.git?path=unity-sdk/Aether

Step 3: Start the Aether Bridge

Before entering Play mode, start the Aether Bridge:

Windows:

1.\aether-bridge-windows-x64.exe

macOS / Linux:

1chmod +x ./aether-bridge-* 2./aether-bridge-darwin-arm64 # or darwin-x64, linux-x64
✅Expected Output

You should see:

1Unity WebSocket server listening on 127.0.0.1:7890 2MCP server listening on 127.0.0.1:7891

Keep this terminal window open while using Aether.

Step 4: Configure Cursor MCP

Create a file called .cursor/mcp.json in your project root:

1{ 2 "mcpServers": { 3 "aether": { 4 "command": "node", 5 "args": ["-e", "require('ws').WebSocket('ws://localhost:7891')"] 6 } 7 } 8}
ℹ️Alternative Setup

Alternatively, add via Cursor Settings → Features → MCP Servers → Add URL: ws://localhost:7891

Restart Cursor after adding the configuration.

Step 5: Test the Connection

  1. Enter Play mode in Unity
  2. Check Unity Console for: [Aether] Connected to bridge
  3. In Cursor, open the AI chat and type:
1@aether snapshot
✅Success!

If successful, you'll see a GTML snapshot with your current game state!

✅ You're Done!

Aether is now connected. Your AI can see Unity runtime context.

Try Your First Capsule

Now that everything is set up, try creating your first capsule:

1@aether package last_error

This packages the last error with full context for your AI to analyze.

What's Next?

  • Create a capsule: @aether package last_error or @aether mark "important moment"
  • Get a snapshot: @aether snapshot to see current game state
  • Learn the tools: Check out the MCP Tools Reference
  • Understand capsules: Read about Capsules and how they work
  • Need help?: Visit Troubleshooting if you run into issues
PreviousGetting Started
NextDownloads