UnityAgentClient  by nuskey8

AI agent integration for the Unity editor

Created 5 months ago
251 stars

Top 99.8% on SourcePulse

GitHubView on GitHub
Project Summary

Summary

This project integrates diverse AI agents (Gemini, Claude, Codex) into the Unity editor via the Agent Client Protocol (ACP). It empowers Unity developers to leverage AI with project assets and editor context, offering flexibility in agent choice and avoiding proprietary Unity AI dependencies.

How It Works

Unity Agent Client acts as an ACP client extension within the Unity editor, adopting Zed's ACP and MCP protocols. This architecture allows seamless integration of any ACP-compatible AI agent, providing an in-editor AI experience that utilizes project assets and editor state as context, thereby reducing external tool reliance.

Quick Start & Requirements

  • Installation:
    1. Install the AgentClientProtocol NuGet package (via NugetForUnity or DLLs).
    2. Add UnityAgentClient from Git URL: https://github.com/nuskey8/UnityAgentClient.git?path=Assets/UnityAgentClient.
  • Prerequisites: Unity 2021.3+, Node.js runtime.
  • Agent Setup: Requires configuring specific AI agents (e.g., Gemini CLI with --experimental-acp, Zed adapters for Claude/Codex, or direct ACP support from opencode/Goose). API keys may be necessary (e.g., GEMINI_API_KEY env var).
  • Notes: macOS users may encounter PATH resolution issues in zsh, requiring which command for full binary paths. Project settings containing API keys are saved in UserSettings and should be excluded from version control.
  • Links: ACP Overview: https://agentclientprotocol.com/overview/agents.

Highlighted Details

  • Supports any AI agent compatible with the Agent Client Protocol (ACP), including Gemini CLI, Claude Code, Codex CLI, opencode, and Goose.
  • Leverages Unity assets and editor information as context for AI agents.
  • Includes a built-in MCP server for model context integration.
  • Offers an alternative to Unity's official AI, allowing user-chosen LLM providers and avoiding mandatory Unity Cloud tokens.

Maintenance & Community

The provided README does not detail specific contributors, sponsorships, community channels (Discord/Slack), or a roadmap.

Licensing & Compatibility

  • License: MIT LICENSE.
  • Compatibility: The permissive MIT license generally permits commercial use and integration with closed-source projects.

Limitations & Caveats

This tool is not recommended for editing C# scripts within the Unity editor due to domain reloads disconnecting AI sessions and the editor's unsuitability for reviewing AI-generated code. Its primary utility lies in using AI agents to analyze the entire Unity project as a document for understanding or issue identification.

Health Check
Last Commit

5 months ago

Responsiveness

Inactive

Pull Requests (30d)
0
Issues (30d)
0
Star History
10 stars in the last 30 days

Explore Similar Projects

Feedback? Help us improve.