Skip to content

Commit 361eeb0

Browse files
dsarnoclaude
andauthored
Add LICENSE and README to plugin folder for AssetLib submission (#27)
AssetLib reviewers expect plugins to include LICENSE and README files inside the addon directory itself. Copies the root MIT license and adds a concise plugin-specific README. Co-authored-by: Claude Opus 4.6 (1M context) <noreply@anthropic.com>
1 parent 64782fc commit 361eeb0

2 files changed

Lines changed: 48 additions & 0 deletions

File tree

plugin/addons/godot_ai/LICENSE

Lines changed: 21 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,21 @@
1+
MIT License
2+
3+
Copyright (c) 2025 Godot AI contributors
4+
5+
Permission is hereby granted, free of charge, to any person obtaining a copy
6+
of this software and associated documentation files (the "Software"), to deal
7+
in the Software without restriction, including without limitation the rights
8+
to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
9+
copies of the Software, and to permit persons to whom the Software is
10+
furnished to do so, subject to the following conditions:
11+
12+
The above copyright notice and this permission notice shall be included in all
13+
copies or substantial portions of the Software.
14+
15+
THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
16+
IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
17+
FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
18+
AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
19+
LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
20+
OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
21+
SOFTWARE.

plugin/addons/godot_ai/README.md

Lines changed: 27 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,27 @@
1+
# Godot AI
2+
3+
Connect AI assistants to a live Godot editor via the [Model Context Protocol](https://modelcontextprotocol.io/introduction) (MCP).
4+
5+
Godot AI bridges Claude Code, Codex, Antigravity, and other MCP clients with your editor — inspect scenes, create nodes, modify properties, run tests, search project files, and more, all from a prompt.
6+
7+
## Quick Start
8+
9+
1. Copy `addons/godot_ai/` into your project's `addons/` folder
10+
2. Enable the plugin: **Project > Project Settings > Plugins > Godot AI**
11+
3. Pick your MCP client in the **Godot AI** dock and press **Configure**
12+
13+
The plugin auto-starts the MCP server and connects over WebSocket. No manual configuration required.
14+
15+
## Requirements
16+
17+
- Godot 4.3+ (4.4+ recommended)
18+
- [uv](https://docs.astral.sh/uv/) (used to install the Python server)
19+
- An MCP client ([Claude Code](https://docs.anthropic.com/en/docs/claude-code) | [Codex](https://openai.com/index/codex/) | [Antigravity](https://www.antigravity.dev/))
20+
21+
## Documentation
22+
23+
Full documentation, contributing guide, and source code: [github.com/hi-godot/godot-ai](https://github.com/hi-godot/godot-ai)
24+
25+
## License
26+
27+
[MIT](LICENSE)

0 commit comments

Comments
 (0)