55 lines
1.7 KiB
Markdown
55 lines
1.7 KiB
Markdown
# Godot AI
|
|
|
|
Connect AI assistants to a live Godot editor via the [Model Context Protocol](https://modelcontextprotocol.io/introduction) (MCP).
|
|
|
|
Godot AI bridges Claude Code, Codex, Antigravity, DeepSeek Harness, and other MCP clients with your editor — inspect scenes, create nodes, modify properties, run tests, search project files, and more, all from a prompt.
|
|
|
|
## Quick Start
|
|
|
|
1. For a fresh install, verify and extract the signed v4 exact-tree archive;
|
|
for v3 migration, follow `docs/v4-migration.md` in the repository
|
|
2. Enable the plugin: **Project > Project Settings > Plugins > Godot AI**
|
|
3. Pick your MCP client in the **Godot AI** dock and press **Configure**
|
|
|
|
The plugin auto-starts the MCP server and connects over WebSocket. No manual configuration required.
|
|
|
|
## Requirements
|
|
|
|
- Godot 4.7+ within the 4.x line
|
|
- [uv](https://docs.astral.sh/uv/) (used to install the Python server)
|
|
<details>
|
|
<summary>Install uv</summary>
|
|
|
|
**macOS / Linux:**
|
|
```bash
|
|
curl -LsSf https://astral.sh/uv/install.sh | sh
|
|
```
|
|
|
|
**Windows (PowerShell):**
|
|
```powershell
|
|
powershell -ExecutionPolicy ByPass -c "irm https://astral.sh/uv/install.ps1 | iex"
|
|
```
|
|
|
|
**Homebrew (macOS / Linux):**
|
|
```bash
|
|
brew install uv
|
|
```
|
|
|
|
**pipx:**
|
|
```bash
|
|
pipx install uv
|
|
```
|
|
|
|
See the [uv install docs](https://docs.astral.sh/uv/getting-started/installation/) for more options.
|
|
|
|
</details>
|
|
- An MCP client ([Claude Code](https://docs.anthropic.com/en/docs/claude-code) | [Codex](https://openai.com/index/codex/) | [Antigravity](https://www.antigravity.dev/))
|
|
|
|
## Documentation
|
|
|
|
Full documentation, contributing guide, and source code: [github.com/hi-godot/godot-ai](https://github.com/hi-godot/godot-ai)
|
|
|
|
## License
|
|
|
|
[MIT](LICENSE)
|