Aether
Get Started

Quickstart Guide

From zero to AI-visible Unity in under 10 minutes.

Prerequisites

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

Download Aether

Get the bridge binary for your OS and the Unity SDK.

Go to Downloads →

Download the bridge binary and Unity SDK (.unitypackage)

2

Install Unity SDK

Import the Aether package into your Unity project.

  1. 2.1Open your Unity project
  2. 2.2Go to Assets → Import Package → Custom Package
  3. 2.3Select the downloaded Aether.unitypackage
  4. 2.4Click Import to add all files

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

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

Start the Bridge

Run the Aether bridge binary before entering Play mode.

Windows:

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

macOS / Linux:

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

You should see:

Unity WebSocket server listening on 127.0.0.1:7890
MCP server listening on 127.0.0.1:7891
4

Configure Cursor MCP

Tell Cursor where to find the Aether MCP server.

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

.cursor/mcp.json
{
  "mcpServers": {
    "aether": {
      "url": "ws://localhost:7891"
    }
  }
}

Windows: Create in your project root or %USERPROFILE%\.cursor\mcp.json for global

macOS/Linux: Create in your project root or ~/.cursor/mcp.json for global

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

5

Test the Connection

Verify everything is working.

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

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

Troubleshooting

Bridge won't start

  • • Check if ports 7890 and 7891 are already in use
  • • Try running with administrator/sudo privileges
  • • Check your firewall isn't blocking localhost connections

Unity not connecting

  • • Make sure the bridge is running before entering Play mode
  • • Check the Console for connection errors
  • • Verify Aether.Init() is called in your startup script

Cursor MCP not working

  • • Restart Cursor after adding the mcp.json file
  • • Check the file is valid JSON (no trailing commas)
  • • Verify the URL is exactly ws://localhost:7891

Unity domain reload issues

  • • If Aether disconnects on script recompile, it will auto-reconnect
  • • For persistent connection, disable Domain Reload in Project Settings → Editor

Ready to debug?

Explore FeaturesView Pricing