config.yml

The config.yml for GPTAssistant outlines the primary settings, and this guide clarifies each for optimal customization.

General Plugin Settings

• prefix:

  • Purpose: Sets the prefix that will be shown in all chat messages related to GPTAssistant.

  • Default Value: &8[&6GPTAssistant&8]&7

• lang:

  • Purpose: Determines the language used for plugin messages. This value should correspond to a language file present in the "lang" folder of the plugin.

  • Default Value: english

• use-active-chatbot:

  • Purpose: We'll be checking chat messages for questions and responding to them if true.

  • Default Value: true

• use-tag-system:

  • Purpose: We'll be checking chat messages for tags and responding to them if true.

  • Default Value: true

• reload-sound:

  • Purpose: Sets the sound to play when the plugin is reloaded.

  • Default Value: ENTITY_PLAYER_LEVELUP

• default-chatbot:

  • Purpose: Defines the default assistant to use when no assistant is specified and when the active chatbot is enabled. It should match the id of the chatbot in the "chatbot" folder.

  • Default Value: steve

This section focuses on the interaction and integration with OpenAI's GPT models:

• api-key:

  • Purpose: Here, you input your unique OpenAI API key. This key is crucial for authenticating requests with OpenAI and ensuring that the AI can provide responses.

  • Where to Obtain: OpenAI's API Key Page

  • Default Value: X (Ensure you replace X with your actual API key.)

Development & Debugging Options:

While these options are geared more towards developers or those looking to troubleshoot issues, they can be handy for server administrators as well:

• debug:

  • Purpose: Determines whether the plugin operates in debug mode. In this mode, additional information (useful for debugging) will be outputted to the server console.

  • Consideration: Do remember that operating in debug mode might decrease the server's performance due to the increased log output. Use it judiciously and turn it off when not required.

  • Default Value: false

---

Note: Always make backups of your configuration files before implementing substantial modifications. This will allow you to revert to a previous state should issues arise or if you're unsatisfied with the changes.

With a good grasp of the configuration options, you're now well-equipped to tailor GPTAssistant to your server's specific needs. Ensure you review and adjust the settings periodically to optimize performance and user experience.