> ## Documentation Index
> Fetch the complete documentation index at: https://pumpkings.mintlify.site/llms.txt
> Use this file to discover all available pages before exploring further.

# Configure LiricTNT Scoreboard, Tab, and Chat Format

> Full reference for config.yml, arena.yml, and chat-format.yml — MiniMessage placeholders, bossbar style, tab header/footer, and arena spawn data.

LiricTNT stores all of its runtime configuration across three YAML files inside `plugins/LiricTNT/`. You can edit any of them while the server is running and apply the changes without a full restart by executing `/tnt reload`. The three files each handle a distinct area of the plugin.

| File              | Purpose                                                                           |
| ----------------- | --------------------------------------------------------------------------------- |
| `config.yml`      | Scoreboard lines, bossbar text/style, and tab header/footer                       |
| `arena.yml`       | Global spawn locations (lobby, waiting) and per-arena templates with spawn points |
| `chat-format.yml` | Per-rank chat formatting with MiniMessage, hover events, and click events         |

## config.yml

`config.yml` controls everything players see in their HUD during waiting and in-game phases. All text fields accept MiniMessage tags (`<red>`, `<gradient:...>`, `<bold>`, `<#RRGGBB>`).

### Available Placeholders

| Placeholder | Where used          | Description                                      |
| ----------- | ------------------- | ------------------------------------------------ |
| `%players%` | Scoreboard, tab     | Number of players currently online               |
| `%arena%`   | Scoreboard, bossbar | Display name of the current arena instance       |
| `%alive%`   | Scoreboard, bossbar | Number of players still alive in the active game |
| `%mode%`    | Scoreboard          | Current game mode (`tag`, `run`, or `spleef`)    |
| `%timer%`   | Scoreboard, bossbar | Countdown or explosion timer value in seconds    |
| `<prefix>`  | Tab player-format   | LuckPerms rank prefix for the viewed player      |
| `<suffix>`  | Tab player-format   | LuckPerms rank suffix for the viewed player      |

### Default config.yml

The file below matches the default values shipped with the plugin. Text is shown as-is from the source — edit the Spanish strings to suit your server's language.

```yaml theme={null}
scoreboard:
  # Título directo y con energía
  title: " <#FF0000><b>TNT EVENT</b> "

  # Lobby de espera
  waiting:
    - ""
    - " <#00FF00>🏹 <white>Jugadores: <#00FF00>%players% / 30"
    - " <#FFFF00>⏳ <white>Estado: <#FFFF00>Esperando..."
    - " <#00FFFF>🧪 <white>Mapa: <#00FFFF>%arena%"
    - ""
    - "   <#FF00FF>By Pumpkingz"
    - ""
    - "        <#FFAA00>mc.liric.xyz"

  # Durante el juego
  ingame:
    - ""
    - " <#FF0000>☠ <white>Vivos: <#FF0000>%alive%"
    - " <#00FF00>🔥 <white>Modo: <#00FF00>%mode%"
    - " <#00FFFF>⏳ <white>Tiempo: <#00FFFF>%timer%s"
    - ""
    - " <#FF00FF>🏹 <white>Mapa: <#FF00FF>%arena%"
    - ""
    - "     <#FFAA00>mc.liric.xyz"

tab:
  player-format: "<prefix> <player> <suffix>"
  header: |
    <newline>
    <b><color:#FFCD00>LYRIC </color></b> <color:#AAAAAA>|</color> <color:#FFFFFF>Eventos</color>
    <newline>

  footer: |
    <newline>
       <#00FF00>🔔 <#FFFFFF>Jugadores: <#FFFF00>%players%   
       <#FFAA00>mc.liric.xyz   
    <newline>

bossbar:
  color: "RED"      # PINK, BLUE, RED, GREEN, YELLOW, PURPLE, WHITE
  style: "PROGRESS" # PROGRESS, NOTCHED_6, NOTCHED_10, NOTCHED_12, NOTCHED_20
  text: "🏹 <#00FFFF>Mapa: <#FFFFFF>%arena%  <#FF0000>☠ Vivos: <#FFFFFF>%alive%  <#FFFF00>⏳: <#FFFFFF>%timer%s"
```

## arena.yml

`arena.yml` is written automatically by `/tnt setup` and `/tnt arena` commands. You can inspect it to verify spawn coordinates, but editing it by hand is not recommended. After any manual change, run `/tnt reload` to pick up the new values.

The file stores a `global` section for the main lobby and waiting spawn, then one entry per registered arena template under `arenas`. Each spawn point is stored as a full Bukkit Location object. Here is an example of what a populated file looks like:

```yaml theme={null}
global:
  mainLobby:
    ==: org.bukkit.Location
    world: world
    x: 0.0
    y: 64.0
    z: 0.0
    pitch: 0.0
    yaw: 0.0
  waitingSpawn:
    ==: org.bukkit.Location
    world: world
    x: 0.0
    y: 64.0
    z: 0.0
    pitch: 0.0
    yaw: 0.0

arenas:
  MyTagMap:
    type: tag
    spawns:
      - ==: org.bukkit.Location
        world: MyTagMap
        x: 10.0
        y: 65.0
        z: 10.0
        pitch: 0.0
        yaw: 0.0
      - ==: org.bukkit.Location
        world: MyTagMap
        x: -10.0
        y: 65.0
        z: -10.0
        pitch: 0.0
        yaw: 180.0
```

<Note>
  The `world` field under each spawn must match the exact name of the `.slime` template file on disk. When `/tnt iniciar` clones that template, it uses a timestamped name for the live instance — the coordinates are copied automatically.
</Note>

## chat-format.yml

`chat-format.yml` lets you define a unique chat appearance for each LuckPerms group. Each entry under `ranks` supports a format string, a hover tooltip list, and a click-to-message action.

```yaml theme={null}
ranks:
  default:
    format: "<prefix> <player><suffix> <gray>» <white><message>"
    click: "/msg <player> "
    hover:
      - "<white>Click to send a message!"
```

Use `<player>` as the player name token and `<message>` for the chat content. MiniMessage tags are fully supported in all fields. Add additional named groups (e.g. `owner:`, `admin:`) following the same structure to override the default format for specific LuckPerms groups.

<Tip>
  The `default` group acts as a fallback — any LuckPerms group without its own entry in `chat-format.yml` will use the `default` values automatically.
</Tip>

## Applying Changes

After editing any of the three files, reload all configuration without restarting the server:

```bash theme={null}
/tnt reload
```

This reloads `config.yml`, `arena.yml` (stored arena templates), and the scoreboard manager in one step.