> 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/rnkoth/configuration/config.md). # config.yml Every option of config.yml, grouped as in the file. `plugins/rnKoth/config.yml` holds the settings shared by every KOTH. Each option is also explained inside the file. Many of them can be changed in game with [`/koth editor`](/rnsetups/rnkoth/configuration/editor.md) → **General settings**. The settings of each KOTH (area, mode, schedule, rewards...) are in its own file. See [KOTH files](/rnsetups/rnkoth/configuration/koth-file.md). ## General | Option | Default | What it does | | --------------------- | ------- | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | | `config-version` | `1` | Version of the file, used by updates. Do not change it. | | `language` | `en` | Language of the plugin: `languages/.yml`. `en` and `es` are included. See [Languages](/rnsetups/rnkoth/configuration/languages.md). | | `per-player-language` | `false` | `true`: each player sees messages, menus and boss bars in the language of their Minecraft client, when that language file exists. `false`: everything uses `language`. | | `timezone` | `''` | Time zone of the schedules, like `Europe/Madrid`, `America/Mexico_City`, `America/Bogota`, `America/New_York` or `UTC`. Empty = the time zone of the server machine. See [Schedules](/rnsetups/rnkoth/guides/schedules.md#time-zone). | | `auto-reload` | `true` | Checks `config.yml`, `languages/` and `koths/` every few seconds and applies the changes you save by hand. Running events continue. | | `update-checker` | `true` | Checks for new versions of rnKoth on start and every 6 hours. When there is one, the console says so and players with `rnkoth.update` are told when they join. See [Update notifications](/rnsetups/rnkoth/getting-started/updating.md#update-notifications). | ## Teams ```yaml teams: mode: solo placeholder: '%simpleclans_clan_tag%' no-team-values: ['', 'none', 'wilderness', 'no clan', 'null'] ``` | Option | Default | What it does | | ---------------------- | ----------------------------------------------- | ---------------------------------------------------------------------------------------------------------------------------------------- | | `teams.mode` | `solo` | `solo`: every player alone. `scoreboard`: vanilla `/team` teams. `placeholder`: any clan, faction or town plugin through PlaceholderAPI. | | `teams.placeholder` | `%simpleclans_clan_tag%` | With `mode: placeholder`: the text this placeholder gives is the player's team. | | `teams.no-team-values` | `['', 'none', 'wilderness', 'no clan', 'null']` | Texts that mean "no team". Players with one of them play alone. | Each KOTH can also force solo play with `teams: solo` in its file. See [Teams and clans](/rnsetups/rnkoth/guides/teams.md). ## Events ```yaml events: resume-after-restart: true max-at-once: 0 death-cooldown: 5 winner-fireworks: true ``` | Option | Default | What it does | | ----------------------------- | ------- | -------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | | `events.resume-after-restart` | `true` | Running events continue where they were after a restart, with the same progress and time. The chat says `{koth_name} continues where it was`. `false`: events that were running when the server stopped are lost. (`/koth reload` never stops running events.) | | `events.max-at-once` | `0` | How many KOTHs can run (or count down) at the same time. `0` = no limit. | | `events.death-cooldown` | `5` | Seconds a player who died inside a KOTH must wait before counting again. `0` = off. | | `events.winner-fireworks` | `true` | A firework show over the KOTH when someone wins. It never hurts anyone. | {% hint style="info" %} Players with `rnkoth.bypass.rules` are not affected by the rules of a KOTH (flight, elytra, pearls, commands, blocks). Players in creative or spectator never count unless a KOTH allows it in `rules.counted-gamemodes`. See [Rules](/rnsetups/rnkoth/guides/rules.md). {% endhint %} ## Display | Option | Default | What it does | | ----------------------------- | ------------- | --------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | | `display.action-bar` | `true` | Action bar while standing in a KOTH: your progress, or why you do not count (AFK, invisible...). | | `display.locator` | `true` | Action bar for players outside a running KOTH: its name, the distance and an arrow pointing to it. Each player can turn it off with `/koth hud`. | | `display.locator-radius` | `0` | Only for KOTH files without `display.audience.locator` (older files): only players this close to the KOTH see the locator. `0` = everyone in the same world. | | `display.sidebar` | `true` | Sidebar scoreboard during events. `false` = no rnKoth sidebar in any KOTH. Who sees it is set per KOTH (`display.audience.sidebar`); players who leave it get their own scoreboard back at once. With another scoreboard plugin (TAB, AnimatedScoreboard...) hide yours while `%rnkoth_near%` is `yes`, or set this to `false`. Not shown on Folia. | | `display.sidebar-radius` | `120` | Only for KOTH files without `display.audience.sidebar` (older files): players up to this many blocks from the KOTH see the sidebar. `0` = everyone in the world. | | `display.progress-style` | `both` | How progress looks: `bar` (■■■■□□), `percent` (45% or 120/300 points) or `both`. | | `display.progress-bar.length` | `10` | Number of symbols in the bar (1 to 40). | | `display.progress-bar.symbol` | `■` | The symbol of the bar. | | `display.progress-bar.filled` | `` | Color of the filled part. | | `display.progress-bar.empty` | `` | Color of the empty part. | | `display.titles` | `true` | Titles on screen when a KOTH starts and when someone wins. | ### Sounds Any Minecraft sound key, like `block.bell.use`. `''` = no sound. | Option | Default | When | | ------------------------------ | ----------------------------- | ----------------------------------------- | | `display.sounds.start` | `block.bell.use` | A KOTH opens | | `display.sounds.countdown` | `block.note_block.hat` | Each countdown announcement | | `display.sounds.capture-start` | `block.beacon.activate` | A side starts capturing or takes the KOTH | | `display.sounds.capture-lost` | `block.beacon.deactivate` | The holder leaves and the KOTH is free | | `display.sounds.contested` | `block.note_block.bass` | The KOTH becomes contested | | `display.sounds.win` | `ui.toast.challenge_complete` | Someone wins | | `display.sounds.moved` | `entity.enderman.teleport` | A roaming KOTH moves | See [What players see](/rnsetups/rnkoth/guides/display.md) for how each part looks. ## Rewards | Option | Default | What it does | | ----------------------- | ------- | ---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | | `rewards.claim-command` | `true` | Players can open their reward box (items that did not fit) with `/koth claim`. `false` = `/koth claim` only says it is turned off, the reward box messages have no clickable button and the menu has no box button; open the box with `/koth open claim ` (an NPC, a menu plugin...). See [The reward box](/rnsetups/rnkoth/guides/rewards.md#the-reward-box). | The rewards themselves are set in each KOTH. See [Rewards](/rnsetups/rnkoth/guides/rewards.md). ## Discord ```yaml discord: enabled: false webhook-url: '' username: 'rnKoth' avatar-url: '' on-start: true on-win: true mention: '' ``` | Option | Default | What it does | | --------------------- | -------- | --------------------------------------------------------------------------------------------------------- | | `discord.enabled` | `false` | Posts to a Discord channel through a webhook. No other plugin needed. | | `discord.webhook-url` | `''` | The webhook link. In Discord: Server settings → Integrations → Webhooks → New webhook → Copy webhook URL. | | `discord.username` | `rnKoth` | Name of the bot that posts. | | `discord.avatar-url` | `''` | Link to an image for the bot. Empty = the webhook's own image. | | `discord.on-start` | `true` | Posts when a KOTH opens, with where, mode and duration. | | `discord.on-win` | `true` | Posts when a KOTH ends: the winner, time, players and score, or "ended without a winner". | | `discord.mention` | `''` | Text before the post, for example a role mention `<@&123456789>`. Empty = none. | The texts of the posts are in the language file, under `discord`. If the webhook fails, the console tells you why. {% hint style="info" %} To mention a role, enable Developer Mode in Discord (User settings → Advanced), right click the role → Copy Role ID, and write `<@&ROLE_ID>`. {% endhint %} ## Storage ```yaml storage: type: sqlite mysql: host: localhost port: 3306 database: minecraft username: root password: '' table-prefix: 'rnkoth_' pool-size: 4 parameters: 'useSSL=false&allowPublicKeyRetrieval=true&characterEncoding=utf8' ``` `sqlite` keeps the stats in one file, nothing to set up. `mysql` (MySQL or MariaDB) shares them between servers. Changes need a restart. See [Database](/rnsetups/rnkoth/reference/database.md). ## Editor | Option | Default | What it does | | --------------- | -------------------------- | -------------------------------------------------------------- | | `editor.wand` | `BLAZE_ROD` | Item of the selection wand (`/koth wand`). | | `editor.filler` | `BLACK_STAINED_GLASS_PANE` | Item in the empty slots of the menus. `''` = leave them empty. | ## World names ```yaml world-names: void: Spawn world_pvp: '/warp pvp' ``` Names shown instead of the real world names in messages (`{world}`). Default: `{}` (none). Each KOTH can also have its own with `display.world-name` in its file.