---
description: >-
  This file is the heart of GPT Games. It offers essential settings like
  language preferences, user interface options for menus, and general game
  controls. For instance:
---

# config.yml

**General Plugin Settings**:

**prefix**:

* **Purpose**: Establishes the prefix shown in all chat messages linked to GPTGames.
* **Default Value**: `&8[&6GPTGames&8] &f`

**lang**:

* **Purpose**: Identifies the language for the plugin messages. This should correlate to a specific language file in the "lang" folder of the plugin.
* **Default Value**: `english`

**User Interface Customizations**:

**menus**: In this section, you can personalize how menus appear to users:

* **reward-menu-name**:
  * **Purpose**: Titles the menu where players can view and claim rewards.
  * **Default Value**: `&6Rewards`
* **reward-display-menu-name**:
  * **Purpose**: Defines the display name for individual rewards within the rewards menu.
  * **Default Value**: `&6Reward: &f%reward%`
* **roulette-menu-name**:
  * **Purpose**: Provides a name for the roulette game menu.
  * **Default Value**: `&6Roulette`

Buttons: This segment allows for the customization of various navigational buttons in the menus:

* **back-button**:
  * **Name**: Name of the button to return to the previous screen.
  * **Lore**: Tooltip or description when hovering over the button.
  * **Item**: Icon representing the button.
  * **Default Values**:
    * Name: `&cBack`
    * Lore: `&7Click to go back`
    * Item: `ARROW`
* **next-button**:
  * **Name**: Name of the button to move to the subsequent page.
  * **Lore**: Tooltip or description when hovering over the button.
  * **Item**: Icon representing the button.
  * **Default Values**:
    * Name: `&aNext`
    * Lore: `&7Click to go to the next page`
    * Item: `ARROW`
* **close-button**:
  * **Name**: Name of the button to exit the menu.
  * **Lore**: Tooltip or description when hovering over the button.
  * **Item**: Icon representing the button.
  * **Default Values**:
    * Name: `&cClose`
    * Lore: `&7Click to close the menu`
    * Item: `BARRIER`

**Game Management Options**:

* **auto-games**:
  * **Purpose**: Decides if games start on their own or need a manual launch.
  * **Default Value**: `true`
* **game-interval**:
  * **Purpose**: Time duration between auto-started games. The countdown starts as the server initiates. This is especially beneficial for larger servers where there's no waiting between games.
  * **Default Value**: `3`

**Integration with OpenAI's GPT Models**:

**api-key**:

* **Purpose**: Input your unique OpenAI API key here, which is imperative for verifying requests with OpenAI.
* **Where to Obtain**: OpenAI's API Key Page
* **Default Value**: `X` (Ensure you replace X with your real API key.)

**Development & Debugging Options**:

**debug**:

* **Purpose**: Specifies if the plugin is in debug mode. In this mode, the server console will display supplementary details that aid debugging.
* **Consideration**: Debug mode might reduce server performance due to extensive log output. Use sparingly and deactivate when not in use.
* **Default Value**: `false`

**Note**: Before making significant changes to your configuration files, always backup. This step ensures that you can revert to an older state if issues surface or if you're unhappy with modifications.

With this understanding of the configuration possibilities, you're prepared to adapt GPTGames to the unique needs of your server. Periodically revisiting and tweaking these settings will optimize both performance and player experience.
