# Configuration

### Configuration

Use this page to manage the main Vxchatgames settings.

Edit the config files carefully.

Reload or reload after changes if required by your setup.

### Config files

Document the files used by Vxchatgames here.

Typical files include:

<details>

<summary>Config.yml</summary>

```yaml
# Options: SQLITE or H2
database-type: "H2"

# Time in seconds between each automated game (600 seconds = 10 minutes)
game-interval: 600

# Enable or disable specific minigames from the random rotation
enabled-games:
  math: true
  unscramble: true
  trivia: true
  type: true
  unreverse: true
  completion: true
  guess_the_number: true

guess-the-number:
  min: 1
  max: 100

# A list of worlds where chat games will not be broadcasted and answers will not be accepted
blacklisted-worlds:
  - "world_nether"
  - "world_the_end"
  - "pvp_arena"

rewards:
  reward-enable: "both"
  reward-cash: 100
  reward-command:
    - "give %player% diamond 1"



```

</details>

<details>

<summary>Lang.yml</summary>

```yaml
# VxChatGames Language Configuration

prefix: "<gradient:#00aeff:#066996>VxChatGames »</gradient> "

messages:
  # =========================================
  # CORE GAME MESSAGES
  # =========================================
  game-start: "%prefix%&fYou have started a(n) <gradient:#00aeff:#066996>%game%</gradient> &fgame!"
  game-win: "%prefix%<gradient:#00aeff:#066996>%player%</gradient> &fhas won in <gradient:#00aeff:#066996>%time% seconds</gradient>!"

  # =========================================
  # MINIGAME QUESTIONS
  # =========================================
  math-question: "%prefix%<gradient:#00aeff:#066996>Solve</gradient> &fthe equation to win!\n&b➤ &#00aeff%question%"
  unscramble-question: "%prefix%<gradient:#00aeff:#066996>Unscramble</gradient> &fthe letters to win!\n&b➤ &#00aeff%word%"
  trivia-question: "%prefix%<gradient:#00aeff:#066996>Answer</gradient> &fthe question to win!\n&b➤ &#00aeff%question%"
  type-question: "%prefix%<gradient:#00aeff:#066996>Type</gradient> &fthe text exactly to win!\n&b➤ &#00aeff%word%"
  unreverse-question: "%prefix%<gradient:#00aeff:#066996>Un-reverse</gradient> &fthe text to win!\n&b➤ &#00aeff%word%"
  completion-question: "%prefix%<gradient:#00aeff:#066996>Fill</gradient> &fin the blanks to win!\n&b➤ &#00aeff%word%"
  guess-question: "%prefix%<gradient:#00aeff:#066996>Guess</gradient> &fthe number between %min% and %max% to win!\n&b➤ &#00aeffType a number!"

  # =========================================
  # PLAYER FEATURES (Stats, Top, Toggle)
  # =========================================
  toggle-on: "%prefix%&aYou have unmuted chat games. You will now see them again!"
  toggle-off: "%prefix%&cYou have muted chat games. You will no longer see them."

  stats-header: "<gradient:#00aeff:#066996>Statistics for:</gradient> &f%player%"
  stats-columns: "&fGAME | WINS | RECORD"
  stats-row: "&b➤ <gradient:#00aeff:#066996>%game%</gradient>&f: %wins% (%time%s)"
  stats-none: "%prefix%&cNo statistics found for %player%."

  top-wins-global-header: "<gradient:#00aeff:#066996>Global Top Wins:</gradient>"
  top-wins-game-header: "<gradient:#00aeff:#066996>Top Wins for %game%:</gradient>"
  top-wins-row: "&b➤ &f#%position% <gradient:#00aeff:#066996>%player%</gradient>&f: %wins% wins"

  top-records-header: "<gradient:#00aeff:#066996>Fastest Records for %game%:</gradient>"
  top-records-row: "&b➤ &f#%position% <gradient:#00aeff:#066996>%player%</gradient>&f: %time%s"
  top-none: "%prefix%&cNo records found for this category."

  # =========================================
  # ADMIN & STAFF FEEDBACK
  # =========================================
  plugin-reloaded: "%prefix%&aConfiguration, language, and word files reloaded! Timer restarted."
  game-started-specific: "%prefix%&aStarted %game% game!"
  game-started-random: "%prefix%&aStarted a random game!"
  games-stopped: "%prefix%&cAll active games stopped."
  reset-success: "%prefix%&aSuccessfully wiped all stats and records for &f%player%&a."
  reset-not-found: "%prefix%&cNo database records found for the player &f%player%&c."

  # =========================================
  # ERRORS & USAGE ALERTS
  # =========================================
  no-permission: "%prefix%&cYou do not have permission (%permission%)."
  only-players: "%prefix%&cOnly players can do this."
  usage-custom: "%prefix%&cUsage: /vxchatgames custom <game> <word/phrase>"
  custom-failed: "%prefix%&cThat game type does not exist or does not support custom words!"
  usage-stats-console: "%prefix%&cPlease specify a player name from the console."
  usage-top: "%prefix%&cUsage: /vxchatgames top <wins/record> [game]"
  usage-top-record: "%prefix%&cYou must specify a game! Usage: /vxchatgames top record <game>"
  unknown-top-type: "%prefix%&cUnknown type. Use 'wins' or 'record'."
  usage-reset: "%prefix%&cUsage: /vxchatgames reset <player>"
  unknown-command: "%prefix%&cUnknown subcommand! Here are the valid commands:"

  # =========================================
  # COMMAND HELP MENU
  # =========================================
  help-header: "&8&m----------------------------------------\n&#00aeff&lVxChatGames Commands:"
  help-help: "&7/vxchatgames help &8- &fView help"
  help-reload: "&7/vxchatgames reload &8- &fReload plugin"
  help-start: "&7/vxchatgames start [game] &8- &fStart chat game"
  help-custom: "&7/vxchatgames custom <game> <word> &8- &fStart custom game"
  help-stop: "&7/vxchatgames stopall &8- &fStop all active games"
  help-stats: "&7/vxchatgames statistics [player] &8- &fShow stats"
  help-toggle: "&7/vxchatgames toggle &8- &fToggle visibility"
  help-top: "&7/vxchatgames top <records/wins> &8- &fView leaderboard"
  help-reset: "&7/vxchatgames reset <player> &8- &fReset player stats"
  help-footer: "&8&m----------------------------------------"
```

</details>

<details>

<summary>Words.yml</summary>

```json
# Word lists for VxChatGames

unscramble-words:
  - "vortex"
  - "studio"
  - "absolute"
  - "beautiful"
  - "character"
  - "dangerous"
  - "education"
  - "familiar"
  - "gorgeous"
  - "hospital"
  - "important"
  - "knowledge"
  - "language"
  - "medicine"
  - "national"
  - "occasion"
  - "personal"
  - "question"
  - "remember"
  - "sentence"
  - "together"
  - "umbrella"
  - "vacation"
  - "wonderful"
  - "yesterday"
  - "zeppelin"
  - "avalanche"
  - "blizzard"
  - "charisma"
  - "dynamic"
  - "elephant"
  - "festival"
  - "galaxy"
  - "harmony"
  - "invisible"
  - "justice"
  - "kangaroo"
  - "labyrinth"
  - "mystery"
  - "navigate"
  - "oceanic"
  - "pyramid"
  - "quantum"
  - "radiant"
  - "symphony"
  - "treasure"
  - "universe"
  - "volcano"
  - "waterfall"
  - "xylophone"

completion-words:
  - "vortexstudio"
  - "acceleration"
  - "biochemistry"
  - "choreography"
  - "destination"
  - "electricity"
  - "fundamental"
  - "gymnastics"
  - "horticulture"
  - "illustration"
  - "jurisdiction"
  - "kleptomania"
  - "legislation"
  - "mathematics"
  - "negotiation"
  - "opportunity"
  - "photography"
  - "qualification"
  - "restoration"
  - "temperature"
  - "terminology"
  - "ultraviolet"
  - "vaccination"
  - "workstation"
  - "architecture"
  - "dictionary"
  - "earthquake"
  - "environment"
  - "generation"
  - "helicopter"
  - "imagination"
  - "lighthouse"
  - "microphone"
  - "observation"
  - "philosophy"
  - "revolution"
  - "strawberry"
  - "technology"
  - "underneath"
  - "vocabulary"

unreverse-words:
  - "vortex"
  - "studio"
  - "animal"
  - "basket"
  - "castle"
  - "danger"
  - "energy"
  - "family"
  - "garden"
  - "health"
  - "island"
  - "jacket"
  - "kitten"
  - "liquid"
  - "market"
  - "nature"
  - "object"
  - "palace"
  - "quartz"
  - "rabbit"
  - "school"
  - "target"
  - "update"
  - "valley"
  - "wallet"
  - "xylene"
  - "yellow"
  - "zephyr"
  - "camera"
  - "guitar"
  - "jungle"
  - "knight"
  - "mirror"
  - "orange"
  - "planet"
  - "silver"
  - "tunnel"
  - "window"
  - "wizard"
  - "zombie"

type-words:
  - "Vortex Studio"
  - "Artificial Intelligence"
  - "Good morning!"
  - "How are you today?"
  - "A blessing in disguise"
  - "Beat around the bush"
  - "Call it a day"
  - "Get out of hand"
  - "Hang in there"
  - "It is not rocket science"
  - "Make a long story short"
  - "No pain no gain"
  - "Pull yourself together"
  - "Speak of the devil"
  - "Time is money"
  - "Under the weather"
  - "To be or not to be"
  - "A piece of cake"
  - "Better late than never"
  - "Bite the bullet"
  - "Break a leg"
  - "Hit the sack"
  - "Fast and Furious"
  - "The quick brown fox"
  - "Jumps over the lazy dog"

# Format: "Question": "Answer"
trivia-questions:
  "What is the capital of France?": "Paris"
  "What planet is known as the Red Planet?": "Mars"
  "How many continents are there on Earth?": "7"
  "What is the largest ocean on Earth?": "Pacific"
  "What is the hardest natural substance on Earth?": "Diamond"
  "How many legs does a spider have?": "8"
  "What is the freezing point of water in Celsius?": "0"
  "Which animal is known as the King of the Jungle?": "Lion"
  "What gas do plants absorb from the atmosphere?": "Carbon Dioxide"
  "How many colors are in a rainbow?": "7"
  "Who painted the Mona Lisa?": "Leonardo da Vinci"
  "What is the tallest mountain in the world?": "Mount Everest"
  "What is the main ingredient in guacamole?": "Avocado"
  "What force keeps us on the ground?": "Gravity"
  "How many days are in a leap year?": "366"
  "What is the chemical symbol for gold?": "Au"
  "Which planet is closest to the Sun?": "Mercury"
  "What is the largest mammal in the world?": "Blue Whale"
```

</details>

### Safe edit flow

{% stepper %}
{% step %}

#### Stop or prepare your server

Avoid editing while active writes are happening.
{% endstep %}

{% step %}

#### Back up the files

Save a copy before changing values.
{% endstep %}

{% step %}

#### Edit one section at a time

Change small pieces first.
{% endstep %}

{% step %}

#### Apply the changes

Reload plugin.
{% endstep %}

{% step %}

#### Test the result

Check logs and confirm the feature works in game.
{% endstep %}
{% endstepper %}

### Example format

Use this structure for each setting:

```yml
example-setting: true
```

* **Path:** `example-setting`
* **Default:** `true`
* **Allowed values:** `true`, `false`
* **Description:** Enables the example feature.
* **Reload:** Restart recommended.

### Best practices

* Keep comments when possible.
* Avoid changing many values at once.
* Test large changes on a staging server.
* Keep backups for every release update.

{% hint style="warning" %}
Wrong indentation or invalid values can break YAML-based configs.
{% endhint %}

### Troubleshooting

#### Config changes do not apply

Check whether that option supports reload.

If not, restart the server.

#### Plugin fails after editing

Check:

* YAML indentation
* missing quotes
* invalid numbers
* unsupported values

Then review the latest logs.

#### Values reset after update

Compare your old file with the new default file.

Merge changes carefully.


---

# Agent Instructions: Querying This Documentation

If you need additional information that is not directly available in this page, you can query the documentation dynamically by asking a question.

Perform an HTTP GET request on the current page URL with the `ask` query parameter:

```
GET https://vortexstudio-1.gitbook.io/vortexstudio-docs/vxchatgames/configuration.md?ask=<question>
```

The question should be specific, self-contained, and written in natural language.
The response will contain a direct answer to the question and relevant excerpts and sources from the documentation.

Use this mechanism when the answer is not explicitly present in the current page, you need clarification or additional context, or you want to retrieve related documentation sections.