CraftGPT is a lightweight plugin that allows you to integrate an AI-powered chatbot into your Minecraft server. With this plugin, your players can interact with an AI chatbot that uses OpenAI's API to generate responses based on the conversation.
- Lightweight plugin with minimal impact on server performance
- Easy integration into your Spigot server
- Command-based interface for generating responses
- Cooldown timer to prevent spamming
- Flexible configuration
To install CraftGPT, you will first need to sign up for an OpenAI API key, which is required to use the API. Here's how to get your API key:
- Go to the OpenAI website and create an account.
- Once you have created an account, go to the API keys page to generate an API key.
- Copy the API key to your clipboard.
Once you have your OpenAI API key, you can install CraftGPT:
- Download the plugin from SpigotMC and place it in your server's plugins directory.
- Open the
plugins/CraftGPT/config.yml
file in a text editor. - Paste your OpenAI API key into the
token
field in the configuration file. - Save the configuration file and restart your server.
That's it! CraftGPT is now installed and ready to use.
CraftGPT is highly configurable via the config.yml
file. Here are the available configuration options:
cooldown
: The cooldown time in milliseconds between/gpt
commands.show-errors
: Whether to display error messages or not.messages
: Customizable messages that are displayed to players in various situations, including cooldown messages and error messages. These messages now support formatting! Check out Formatting for info.chatgpt
: Various ChatGPT settings.
By default, CraftGPT uses the gpt-3.5-turbo
model, which is cheap, powerful, and designed specifically for conversations, and all the other settings set to OpenAI's default. However, you can change anything at any time in the chatgpt
section.
CraftGPT provides three commands:
/craftgpt
: Reload the configuration. Players must have thecraftgpt.reload
permission to use this command./gpt <text>
: Generates a response to the given text. Players must have thecraftgpt.gpt
permission to use this command. This command has a cooldown timer to prevent spamming. If a player attempts to use the command while it is on cooldown, they will receive a message indicating how long they must wait before using the command again./newchat
: Clears the chat dialog. Players must have thecraftgpt.newchat
permission to use this command.
CraftGPT provides the following permission nodes:
craftgpt.reload
: Allows players to use the/craftgpt
command.craftgpt.gpt
: Allows players to use the/gpt
command.craftgpt.newchat
: Allows players to use the/newchat
command.craftgpt.use
: Grants both of the above. This permission is granted by default.
If you have any issues with CraftGPT or need help configuring it, please visit the CraftGPT page on SpigotMC for support.
CraftGPT is not affiliated with or endorsed by OpenAI. The plugin uses OpenAI's API, but is not officially supported by OpenAI.
CraftGPT is currently in early development. While the plugin has been tested and is functional, it is not yet feature-complete and may undergo significant changes in the future. If you are interested in seeing further development of CraftGPT, please feel free to reach out to me, as I will not update it unless someone is actually using it. Your feedback and suggestions are always welcome, and will help me to improve the plugin over time.