NPC-GPT Plugin for Godot

Version 1.0.0

The NPC-GPT Plugin for Godot allows game developers to integrate AI-driven character interactions into their games using the NPC- GPT API. Enhance your storytelling and gameplay by enabling dynamic conversations with AI characters, tailored to your unique game world.

Features

• Define custom character contexts (e.g., personality, background, and knowledge).
• Send player inputs to the GPT API for real-time AI responses.
• Receive and display AI-generated responses seamlessly.
• Save and load chat histories for persistent conversations.
• Fully customizable and easy to integrate into your project.

Installation

1. Download the plugin ZIP file using the button above.
2. Extract the contents to your project’s res://addons folder.
3. In Godot, go to Project → Project Settings → Plugins.
4. Enable the plugin by toggling the checkbox next to GPT Plugin.

Usage

1. Set Up Character Context

GPTManager.set_character_context({
    "name": "GPTWizard",
    "age": 100,
    "traits": "wise, mysterious, kind",
    "dialogue_style": "formal",
    "background_story": "A mystical entity protecting ancient knowledge.",
    "events_knowledge": "Knows about the ancient scroll in the Temple of Light.",
    "interests": "alchemy, ancient runes, storytelling"
});
    

2. Send User Input

GPTManager.send_to_gpt("What is the Temple of Light?");
    

3. Handle AI Responses

GPTManager.gpt_response_received.connect(_on_gpt_response_received);
func _on_gpt_response_received(user_input: String, ai_response: String):
    print("User Input:", user_input)
    print("AI Response:", ai_response);
    

4. Save and Load Chat History

# Save the chat history
GPTManager.save_chat_history();
# Load the saved chat history
GPTManager.load_chat_history();
print(GPTManager.chat_history);
    

Example Scene

An example scene is included in the examples/ folder. Open TestScene.tscn to see how the plugin works in a game environment.

Compatibility

• Godot Engine 4.3 or later.
• Requires an active Gamer Tool Studio API key.  Activate it in our website.

Support

If you encounter any issues or have questions, feel free to contact us in our Discord.

License

This plugin is distributed under the MIT License. See the included LICENSE file for details.