Introduction

Ryx Sidekick is a Unity Editor integration for AI coding CLI agents. It lets you chat with Claude (Lite), Cursor, and Codex (Pro) directly inside Unity, attach project and scene context, and safely review every edit.

Tip

Quick start: Open Project Settings → Ryx Sidekick, click Validate CLI, then open Window → Ryx Sidekick and start chatting.

Requirements

• Unity 6.0+ (6000.x)
• Claude Code CLI installed — default command: claude
• An authenticated Claude setup (Claude.ai, Console API key, or a supported third-party provider)

Open the window

Window → Ryx Sidekick — opens the chat window.

Quick start (recommended flow)

1. Open Project Settings → Ryx Sidekick.
2. Click Validate CLI (fix CLI Path if validation fails).
3. Open Window → Ryx Sidekick and log in if prompted.
4. Add context (files, selection, screenshots) and start chatting.

Settings reference

Claude CLI Settings

Setting	Description
CLI Path	Executable name or absolute path (default: claude).
Working Directory	Base directory for CLI execution and file operations (default: project root).
Model	Default model ID passed to the CLI (e.g. sonnet, opus, haiku, or a custom string).
Max Turns	Maximum turns per request (forwarded to the CLI).
Permission Mode	default, plan, or bypassPermissions — also switchable from the chat toolbar.
Verbose Logging	Enables additional Unity console logs for debugging.

Asset Refresh

Asset Refresh Mode controls when AssetDatabase.Refresh() runs after edits:

• Off
• After assistant completes
• After edit + write tools
• Manual (shows a banner to refresh on demand)

MCP (optional)

Setting	Description
Enable MCP Config	Generates/passes an MCP config file to the CLI.
Use Custom MCP Config	Uses your own MCP config JSON.
MCP Config Path	Path to custom config (absolute or project-relative).
Unity MCP Server URL	HTTP endpoint for MCP for Unity (default: http://localhost:8080/mcp).

Providers / Debugging

• Use Bedrock — Routes Claude CLI through Bedrock (CLAUDE_CODE_USE_BEDROCK=1, requires AWS credentials).
• Debug Mode — Runs CLI in a visible OS terminal window (streaming output will not appear in Unity).

Core features

Streaming chat inside Unity

Streams responses from the Claude CLI using stream-json with fast incremental updates. Renders assistant messages with Markdown (code blocks, links, tables, and more). Shows raw CLI output in the built-in Terminal tab for debugging.

Conversation history (CLI-native)

Ryx Sidekick shows your past conversations by reading the CLI’s local history:

• Location: ~/.claude/projects/.../*.jsonl
• Sessions are read-only from Unity — Ryx Sidekick does not write your history files.
• Long histories are loaded incrementally (pagination) for performance.

Context attachments

Type	Notes
File context	Text-only, 100 KB max, large files truncated (head + tail). Binary files are skipped.
GameObject context	Hierarchy path + component list so Claude understands your scene.
Image attachments	Paste from clipboard, drag & drop, or capture Scene/Game View screenshots.

Add context from the Add Context button or the Command Palette.

Command palette + slash commands

Ryx Sidekick includes a command palette inspired by VS Code:

• Built-in actions: attach file, attach selection, screenshots, open settings, new chat, model selection.
• Auto-discovers Claude CLI slash commands and lets you insert or execute them.

Type / in the input to trigger slash suggestions.

Useful input shortcuts

Shortcut	Action
Enter	Send message (or stop a running turn)
Shift/Ctrl/Cmd/Alt + Enter	Insert newline
Tab	Cycle edit mode
Ctrl/Cmd + V	Paste image from clipboard (when supported)

Safe edits + permission UI

When Claude requests file edits or other controlled actions, Ryx Sidekick shows a permission overlay:

• Allow / Deny
• Allow & Remember — auto-accept that tool for the rest of the session.

Changed files are surfaced in the Files and Diff tabs (with revert).

Edit modes

Mode	Description
Ask before edits (default)	Safest — prompts for each action
Plan mode (plan)	Encourages planning before edits
Edit automatically (bypassPermissions)	Fastest, least restrictive

Models + Extended Thinking

Pick a default model (Sonnet / Opus / Haiku) or enter a custom model ID. Optional Extended Thinking mode uses --max-thinking-tokens.

Optional: MCP for Unity integration

Ryx Sidekick can integrate with MCP for Unity to enable deeper tool-like workflows:

• Generates or uses a custom MCP config JSON for the CLI.
• Setup is guided by the onboarding wizard, and configurable in Project Settings → Ryx Sidekick → MCP.

Troubleshooting

”Validate CLI” fails / CLI not found

• Ensure Claude Code CLI is installed: claude --version
• Set CLI Path to an absolute path if needed.
• On macOS/Linux, Unity launched from a GUI may not inherit your shell PATH; an absolute path is the most reliable fix.

No streaming output in Unity

• Check Debug Mode in Project Settings — when enabled, the CLI runs in a visible OS terminal and streaming output does not appear in Unity.

Conversations list is empty

• Verify the CLI has existing sessions for this project (stored under ~/.claude/projects/).
• Send a message once — a new session appears after the CLI creates history on disk.

Permission prompts feel too frequent

• Use Allow & Remember for tools you trust.
• Switch edit mode to Plan mode or Edit automatically.

Privacy & data notes

Ryx Sidekick is a UI and orchestration layer around the CLI:

• It starts the local process and streams events over stdin/stdout.
• Messages and attachments are transmitted by the CLI to the configured backend/provider.
• Conversation history shown in Unity is read from the CLI’s local storage.

Credential storage depends on platform and authentication method:

• macOS: Keychain (with plaintext fallback).
• Windows/Linux: plaintext files in ~/.claude/ (same as the CLI).