内容
# 芬娜拉 Godot AI
[](https://discord.com/invite/3fF4ft9PTk)
[](LICENSE.md)
芬娜拉为MCP客户端提供与Godot的实时连接。代理可以检查场景、查看脚本、捕获运行时错误,并在编辑器中验证更改,而不是仅凭项目文件进行猜测。
它适用于Godot项目,文件编辑已不能满足需求。节点路径、导出变量、场景资源、运行时日志、截图和编辑器诊断都非常重要。
芬娜拉还包括一个内置的编辑器聊天窗口,由同一个本地守护进程支持。聊天可以使用项目感知的工具,显示活动的MCP目标,在本地存储其OpenRouter密钥,并在选定的模型支持时附加图像上下文。
内置聊天需要您自己的OpenRouter API密钥。从OpenRouter密钥创建密钥,然后将其粘贴到Godot中的芬娜拉聊天设置中。芬娜拉通过守护进程在本地存储该密钥,不会将其放入Godot项目中。MCP客户端仍然可以通过其自己的模型/应用程序设置使用芬娜拉的工具。
## 要求
- Godot 4.5 或更新版本。
- 支持的桌面操作系统:Windows x86_64、Linux x86_64 或 macOS arm64。
- 具有MCP功能的编码应用程序,例如Claude、Codex、Cursor、Gemini 或 Antigravity。
- 如果您想使用内置的芬娜拉聊天窗口,则需要OpenRouter API密钥。
有关完整的安装演练,请参阅[设置](docs/setup.md)。
## 芬娜拉安装的内容
- 一个小的`fennara`命令行界面
- 由AI编码应用程序使用的本地MCP服务器
- 一个本地守护进程,将MCP/聊天请求桥接到打开的Godot编辑器
- 复制到`res://addons/fennara/`的Godot插件
- 为AI代理生成的项目指导
在Linux上,嵌入式聊天Web视图使用共享的CEF运行时,该运行时在用户的芬娜拉应用程序数据目录下安装一次。CEF运行时与Godot插件分开,因此每个项目都不需要复制浏览器引擎。
## 快速入门
按照以下步骤进行。
### 1. 安装命令行界面
Windows:
```powershell
irm https://raw.githubusercontent.com/fennaraOfficial/fennara-godot-ai/main/install.ps1 | iex
```
macOS / Linux:
```bash
curl -fsSL https://raw.githubusercontent.com/fennaraOfficial/fennara-godot-ai/main/install.sh | sh
```
检查安装:
```bash
fennara doctor
```
### 2. 将芬娜拉添加到Godot项目中
从Godot项目文件夹运行:
```bash
cd path/to/your-godot-project
fennara install
```
对于C#项目:
```bash
fennara install --csharp
```
然后在Godot中打开项目。
`fennara install`还会为AI编码代理编写项目指南:
```text
AGENTS.md
.fennara/ai/guidelines.md
```
### 3. 配置MCP应用程序
Claude Code 和 Claude Desktop:
```bash
fennara mcp-setup --claude
```
Gemini 和 Antigravity:
```bash
fennara mcp-setup --gemini
```
Cursor:
```bash
fennara mcp-setup --cursor
```
Codex:
```bash
fennara mcp-setup --codex
```
更多目标:
```bash
fennara mcp-setup --help
```
设置后重启MCP应用程序,以便它重新加载芬娜拉服务器。
### 4. 验证其是否有效
打开Godot项目后,询问您的MCP应用程序:
```text
使用Fennara MCP运行fennara_status,并告诉我哪个Godot项目已连接。
```
如果项目路径正确,则MCP服务器和Godot插件正在通信。
如果打开多个Godot项目,请使用芬娜拉窗口的MCP目标控件选择哪个项目接收外部MCP工具调用。
### 5. 稍后更新
从Godot项目文件夹运行:
```bash
cd path/to/your-godot-project
fennara update
```
`fennara update`读取发布清单,然后刷新项目插件、本地运行时包、生成的芬娜拉指南文件和当前平台所需的任何发布托管的共享Web视图运行时。在CLI指示某个版本需要更新外部CLI时,请重新运行安装脚本。
## 工具
芬娜拉提供了一组小的Godot感知工具:
- 编写或更新项目文件并返回诊断信息
- 运行一次性场景编辑脚本
- 检查场景树、节点、资源和Godot类
- 验证场景
- 捕获截图
- 启动运行时会话并读取运行时日志
- 在实时场景中运行小型运行时脚本
目标不是取代代理的正常文件工具。芬娜拉提供了缺失的Godot反馈环。
## 内置聊天
芬娜拉窗口包括Godot内部的原生Web聊天界面。它与本地守护进程通信,而不是托管的芬娜拉后端。
- 为内置聊天带来您自己的OpenRouter API密钥。
- OpenRouter API密钥由守护进程在本地保存,不在Godot项目中。
- 聊天记录存储在本地,并限定为当前项目。
- 图像附件可以从编辑器中粘贴或选择,并在选定的OpenRouter模型支持视觉时作为模型上下文发送。
- 窗口显示当前项目是否为外部MCP客户端的MCP目标。
## 演示
从这里开始:
[](https://www.youtube.com/watch?v=ztbH6zBhxMc)
更多视频:
- [芬娜拉MCP在Godot中构建了一个类似Katamari的游戏](https://www.youtube.com/watch?v=8y2Ub8pgNSs)
- [Godot MCP排名:Godot最佳AI工具](https://www.youtube.com/watch?v=2vSYP7GyA5U)
- [这个Godot插件彻底改变了AI游戏开发](https://www.youtube.com/watch?v=wKln8248y2M)
- [这个Godot插件彻底改变了AI游戏开发](https://www.youtube.com/watch?v=pijlHyiOnz4)
有关更多视频,请参阅[演示](docs/demos.md)。
## 星级历史
<a href="https://www.star-history.com/#fennaraOfficial/fennara-godot-ai&Date">
<picture>
<source media="(prefers-color-scheme: dark)" srcset="https://api.star-history.com/svg?repos=fennaraOfficial/fennara-godot-ai&type=Date&theme=dark" />
<source media="(prefers-color-scheme: light)" srcset="https://api.star-history.com/svg?repos=fennaraOfficial/fennara-godot-ai&type=Date" />
<img alt="Fennara Godot AI 星级历史" src="https://api.star-history.com/svg?repos=fennaraOfficial/fennara-godot-ai&type=Date" />
</picture>
</a>
## 仓库
有用的起点:
- [设置](docs/setup.md)
- [仓库地图](docs/repo-map.md)
- [架构](docs/architecture.md)
- [工具](docs/tools.md)
- [常见问题](docs/faq.md)
- [演示](docs/demos.md)
- [手动安装说明](docs/manual-install.md)
- [发布流程](docs/release.md)
- [贡献](CONTRIBUTING.md)
- [安全](SECURITY.md)
## 社区
Discord上欢迎提出问题、设置帮助和早期反馈:
https://discord.com/invite/3fF4ft9PTk
## 许可证
参见[LICENSE.md](LICENSE.md)。