This project provides AI-assisted code completion for the Godot game engine, targeting GDScript developers. It leverages OpenAI APIs to offer intelligent code suggestions directly within the Godot editor, aiming to accelerate development by automating repetitive coding tasks.

How It Works

Godot Copilot integrates with the Godot editor, allowing users to trigger AI code completions via a keyboard shortcut. It supports OpenAI's Completion and Chat interfaces, with specific prompt engineering for the Chat interface to ensure code is inserted correctly. The plugin sends the current script content to the OpenAI API, with mechanisms to handle context length limitations. It also injects zero-shot explanations of GDScript changes to improve model performance with Godot 4.x syntax.

Quick Start & Requirements

• Installation: Search for "Copilot" in the Godot Asset Library or manually copy the addon to res://addons/.
• Prerequisites: Godot Engine 4.x or 3.x, OpenAI API key.
• Configuration: Enable the addon in Project Settings and enter the API key in the Copilot tab.
• Documentation: [Not explicitly linked, but installation instructions are in README]

Highlighted Details

• Supports OpenAI models: text-davinci-003, gpt-3.5-turbo, gpt-4, and gpt-4-github-copilot.
• Costs vary by model: gpt-3.5-turbo is the cheapest at $0.002/1K tokens.
• Addresses GDScript's underrepresentation in training data by injecting context.
• Explains the rationale for not using Godot's native autocomplete system for AI completions.

Maintenance & Community

• Open to feature requests and contributions via GitHub issues.
• [No specific community links or contributor information provided in the README.]

Licensing & Compatibility

• License: Not specified in the README.
• Compatibility: Supports Godot 4.x and 3.x. Offers experimental support for GitHub Copilot subscriptions via API mirroring.

Limitations & Caveats

GDScript performance may vary due to OpenAI model training data limitations and Godot 4.x syntax changes. Some completions might have indentation issues or hallucinated methods. Using GitHub Copilot via this plugin carries a risk of account suspension.