> ## Documentation Index
> Fetch the complete documentation index at: https://wiki.mrerrorx.dev/primaxbattleroyalex/llms.txt
> Use this file to discover all available pages before exploring further.

# Customize All Player-Facing Messages in messages.yml

> Edit every player-facing message in PrimaxBattleRoyaleX using messages.yml. Supports color codes and dynamic placeholders like {player} and {time}.

<Warning>
  **Server requirements:** PrimaxBattleRoyaleX generates a fresh world for every match and deletes it once the match ends. World generation runs on the server's main thread, so a weak CPU or low RAM will cause noticeable lag. A quality managed Minecraft host or a dedicated VPS with a strong single-thread CPU and ample RAM is strongly recommended. Shared or budget hosting is not suitable.
</Warning>

`messages.yml` lets you customize every message the plugin sends to players — match start announcements, elimination notices, border warnings, victory messages, and more. All messages support Minecraft color codes and dynamic placeholder values that are filled in at runtime.

**File location:** `plugins/PrimaxBattleRoyaleX/messages.yml`

***

## Placeholder Variables

Use these placeholders anywhere in your message strings. The plugin replaces them automatically with live values when the message is sent.

| Placeholder   | Description                                                             |
| ------------- | ----------------------------------------------------------------------- |
| `{player}`    | The name of the relevant player (e.g. the winner or eliminated player). |
| `{remaining}` | The number of players or teams still alive in the match.                |
| `{time}`      | The time remaining in the current match.                                |
| `{kills}`     | The player's current kill count.                                        |
| `{team}`      | The name of the player's team.                                          |

***

## Color Codes

Minecraft uses `&` as the color code prefix in plugin configuration files. Color codes can be combined with formatting codes for bold, italic, and more.

| Code                 | Effect                                                                  |
| -------------------- | ----------------------------------------------------------------------- |
| `&0`–`&9`, `&a`–`&f` | Standard Minecraft colors (e.g. `&6` = gold, `&c` = red, `&e` = yellow) |
| `&l`                 | **Bold**                                                                |
| `&o`                 | *Italic*                                                                |
| `&n`                 | Underline                                                               |
| `&m`                 | Strikethrough                                                           |
| `&r`                 | Reset all formatting                                                    |

**Example:** `&6&lBattle Royale` renders as gold, bold text.

<Tip>
  Use `&r` to reset formatting after color codes to avoid colors bleeding into the next word or line.
</Tip>

***

## Example messages.yml

```yaml messages.yml theme={null}
match-start: '&6Match started! &e{remaining} &6players remain.'
player-eliminated: '&c{player} &7has been eliminated! &e{remaining} &7remain.'
match-end-solo: '&6&l{player} &ewins the match!'
match-end-deathmatch: '&6Match over! Top player: &e{player} &6with &e{kills} &6kills.'
border-shrinking: '&cThe border is shrinking!'
```

***

<Note>
  After editing `messages.yml`, restart your server or reload the plugin with `/brreload` to apply your changes.
</Note>