> For the complete documentation index, see [llms.txt](https://realisticnode.gitbook.io/rnsetups/llms.txt). Markdown versions of documentation pages are available by appending `.md` to page URLs; this page is available as [Markdown](https://realisticnode.gitbook.io/rnsetups/rnchatgames/configuration/config.md).

# config.yml

Every option is explained inside the file too. Most of them can also be changed in game with [`/rncg editor`](/rnsetups/rnchatgames/configuration/editor.md).

## General

| Option                | Default                | What it does                                                                                                                                                                                                                                                                                                                    |
| --------------------- | ---------------------- | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- |
| `auto-reload`         | `true`                 | Applies the changes you save in any rnChatGames file a few seconds later, without `/rncg reload`. The running game is not stopped. A file with a mistake is not applied (the console shows the line).                                                                                                                           |
| `update-checker`      | `true`                 | Checks for new versions of rnChatGames on start and every 6 hours. When there is one, the console says so and admins (`rnchatgames.update`) are told when they join. See [Update notifications](/rnsetups/rnchatgames/getting-started/updating.md#update-notifications).                                                        |
| `language`            | `en`                   | Language of the messages: `languages/<language>.yml`.                                                                                                                                                                                                                                                                           |
| `per-player-language` | `false`                | `true` = each player sees the messages in the language of their Minecraft client when that file exists (`es_mx` → `es.yml`); others see `language`. The questions and answers (`content/`) and the toasts are the same for everybody. See [Languages](/rnsetups/rnchatgames/configuration/messages.md#language-of-each-player). |
| `content-language`    | `auto`                 | Language of the words and questions: `content/<language>.yml`. `auto` = the same as `language`.                                                                                                                                                                                                                                 |
| `prefix`              | gradient "ChatGames »" | Used as `{prefix}` in short messages.                                                                                                                                                                                                                                                                                           |
| `header`              | gradient "ChatGames"   | Used as `{header}` at the top of game announcements.                                                                                                                                                                                                                                                                            |
| `chat-width`          | `320`                  | Chat width in pixels, used by `<center>`. Adjust it (280–360) if centered lines look shifted.                                                                                                                                                                                                                                   |
| `time-limit`          | `30`                   | Default seconds to answer, for games with `time-limit: 0`.                                                                                                                                                                                                                                                                      |
| `time-decimals`       | `2`                    | Decimals in the winning time (0–3).                                                                                                                                                                                                                                                                                             |

## Automatic games

```yaml
automatic-games:
  enabled: true
  interval-min: 300     # shortest wait between games (seconds)
  interval-max: 600     # longest wait; each wait is random between both
  min-players: 2        # players who can play needed to start one
  avoid-repeat: true    # never the same game twice in a row
```

Only players who can play are counted: not hidden with `/rncg toggle`, in an enabled world, and with permission when `players.require-permission` is on. Players can see the countdown with `/rncg next`.

## Worlds

```yaml
worlds:
  mode: BLACKLIST   # BLACKLIST: every world except the list. WHITELIST: only the list
  list: []
```

The worlds are detected automatically; you can also turn them on and off in `/rncg editor` → Worlds. Players in a disabled world do not see games and can not answer.

## Players and chat

| Option                           | What it does                                                                                                |
| -------------------------------- | ----------------------------------------------------------------------------------------------------------- |
| `players.require-permission`     | `true`: only players with `rnchatgames.play` see and play games.                                            |
| `chat.hide-correct-answers`      | Hides correct answers from the chat.                                                                        |
| `chat.accept-cancelled-messages` | Also accepts answers written in chats of other plugins that cancel the message (private, faction, town...). |
| `chat.wrong-case-notice`         | Case-sensitive games: tells the player "Almost!" when only the capital letters are wrong.                   |

## Sounds

Format: `"NAME VOLUME PITCH"`. `NAME` is a key (`minecraft:entity.player.levelup`) or the classic name (`ENTITY_PLAYER_LEVELUP`). Leave it empty (`""`) to turn a sound off.

| Sound            | When                                                                 |
| ---------------- | -------------------------------------------------------------------- |
| `start`          | A game starts                                                        |
| `win`            | To the winner                                                        |
| `win-others`     | To everyone else when someone wins                                   |
| `end`            | A game with several winners ends, or time runs out after someone won |
| `timeout`        | Time runs out and nobody won                                         |
| `hint`           | The hint is shown                                                    |
| `wrong-case`     | Right answer with the wrong capital letters                          |
| `letter-found`   | Hangman: a letter that is in the word                                |
| `letter-missing` | Hangman: a letter that is not in the word                            |
| `memory-hidden`  | Memory: the code disappeared, time to write it                       |

## Display

| Option                                        | What it does                                                                                              |
| --------------------------------------------- | --------------------------------------------------------------------------------------------------------- |
| `display.title`                               | Title when a game starts (`enabled`, `fade-in`, `stay`, `fade-out` in ticks).                             |
| `display.bossbar`                             | Boss bar with the time left (`enabled`, `color`, `overlay`).                                              |
| `display.actionbar-countdown`                 | Time left in the action bar.                                                                              |
| `display.win.title-winner`                    | "You won!" title for the winner.                                                                          |
| `display.win.title-others`                    | Title for everyone else when someone wins.                                                                |
| `display.win.actionbar-others`                | "Steve won Math in 3.2s" in the action bar of everyone else.                                              |
| `display.win.toast`                           | Advancement-style popup for the winner (never shown in chat). The item is the game icon from `menus.yml`. |
| `display.win.toast-frame`                     | `TASK`, `GOAL` or `CHALLENGE` (with its own sound).                                                       |
| `display.end.title` / `display.end.actionbar` | When a game ends by time, or after the last place of a game with several winners.                         |

<figure><img src="https://348500357-files.gitbook.io/~/files/v0/b/gitbook-x-prod.appspot.com/o/spaces%2FSlVHklG0EMAOmvfqcizu%2Fuploads%2FL4w1KLxioWxymmselihO%2Frncg-real-03.png?alt=media" alt="Start title and boss bar"><figcaption><p>Start title and boss bar</p></figcaption></figure>

<figure><img src="https://348500357-files.gitbook.io/~/files/v0/b/gitbook-x-prod.appspot.com/o/spaces%2FSlVHklG0EMAOmvfqcizu%2Fuploads%2FIZgDsaRVv7es6Yhj3tNE%2Frncg-real-16.png?alt=media" alt="What the winner sees: title and toast"><figcaption><p>What the winner sees: title and toast</p></figcaption></figure>

The texts of all of them are in the [language file](/rnsetups/rnchatgames/configuration/messages.md).

## Records, streaks and console

| Option                     | What it does                                                                           |
| -------------------------- | -------------------------------------------------------------------------------------- |
| `announce-new-records`     | Announces when someone beats the fastest time of a game.                               |
| `streaks.enabled`          | Counts first places in a row. Only one player can be on a streak.                      |
| `streaks.announce-from`    | From how many wins in a row it is announced ("3 IN A ROW!"), and when someone ends it. |
| `streaks.reset-on-timeout` | `true`: a game nobody wins also ends the streak.                                       |
| `log-to-console`           | One short line per game in the console (start with the answer, winners, end).          |
| `console-game-messages`    | Also prints every game announcement in the console.                                    |
| `logs.date-format`         | Date format of `/rncg logs`.                                                           |

<figure><img src="https://348500357-files.gitbook.io/~/files/v0/b/gitbook-x-prod.appspot.com/o/spaces%2FSlVHklG0EMAOmvfqcizu%2Fuploads%2FIyHiof0DMn6dOUG6jGMy%2Frncg-real-17.png?alt=media" alt="A win streak"><figcaption><p>A win streak</p></figcaption></figure>

## Bedrock

`bedrock.forms: true` — see [Bedrock players](/rnsetups/rnchatgames/reference/bedrock.md).

## Database

`storage` — see [Database](/rnsetups/rnchatgames/reference/database.md).

## Games

`games` — see [The 16 games](/rnsetups/rnchatgames/games/games.md).
