← All docs

Claunity Documentation

Everything you need to use Claunity — from installation to advanced scene control.

New to Claunity?

Start with Installation, then follow the Quick Start to send your first message in under 5 minutes.

🚀

Getting Started

Install Claunity, enter your API key, and send your first message to the AI.

🎮

Modes

Five specialized modes for different workflows — from chat to asset discovery to full project generation.

⚡

Actions Reference

Every action Claunity can execute — JSON format, parameters, and examples.

⚙️

Configuration

Settings, AI providers, API keys, and how to get the best performance.

🔧

Help

Answers to common questions and solutions for the most frequent issues.

How Claunity works

Claunity has two parts that work together:

  • Unity package — an EditorWindow panel that lives inside Unity Editor. Sends your messages to the backend and executes actions in the scene.
  • Desktop app — a small Python FastAPI server that runs locally on localhost:8765. Talks to Claude API or Claude Code on your behalf.

When you type a message, it travels from Unity → Desktop App → AI API → back to Unity. If the AI wants to perform a scene action, it returns a JSON payload that Unity executes directly. 

Unity Editor (C#)
  └─ EditorWindow panel
       ↕ HTTP (localhost:8765)
  Desktop App (Python)
  └─ FastAPI server
       ↕ HTTPS
  AI API (Claude)

System requirements

Platform Requirement
Unity2021.3 LTS or newer
WindowsWindows 10 64-bit or newer
macOSmacOS 14 Sonoma+ (Apple Silicon)
LinuxUbuntu 22.04+ / glibc 2.35+
API KeyAnthropic (Claude API) — or Claude Code subscription
Next → Installation