> ## 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.

# PrimaxBattleRoyaleX Plugin Configuration File Overview

> A guide to all PrimaxBattleRoyaleX configuration files — what each file controls, where it lives, and when to edit it on your server.

<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>

After installing PrimaxBattleRoyaleX and starting your server for the first time, the plugin automatically generates all of its configuration files inside the `plugins/PrimaxBattleRoyaleX/` directory. Each file controls a distinct area of the plugin — from core settings and messages to per-mode gameplay and world generation.

## Configuration Files

<CardGroup cols={2}>
  <Card title="Core Settings (config.yml)" icon="gear" href="/primaxbattleroyalex/primaxbattleroyalex/quickstart">
    Core plugin settings including debug mode, automatic update checks, language selection, and lobby/spawn location storage. Full setup details are covered in the Quickstart guide.
  </Card>

  <Card title="messages.yml" icon="message" href="/primaxbattleroyalex/primaxbattleroyalex/configuration/messages">
    Every player-facing message sent by the plugin. Supports Minecraft color codes and dynamic placeholders such as `{player}` and `{time}`.
  </Card>

  <Card title="game-settings.yml" icon="swords" href="/primaxbattleroyalex/primaxbattleroyalex/configuration/game-settings">
    Per-game-mode configuration: player counts, match timers, PvP grace periods, respawn mechanics, and more for Solo, Squad, and Deathmatch.
  </Card>

  <Card title="world-settings.yml" icon="earth-americas" href="/primaxbattleroyalex/primaxbattleroyalex/configuration/world-settings">
    World generation settings, initial border size, shrink intervals, shrink target radius, and player spawn heights.
  </Card>

  <Card title="data.yml" icon="database">
    Stores player statistics such as kills and wins. This file is auto-managed by the plugin — **do not edit it manually**.
  </Card>
</CardGroup>

## Applying Configuration Changes

<Note>
  After editing any configuration file, use `/brreload` or restart the server to apply your changes. A **full server restart is recommended** to ensure all settings are loaded correctly and no stale values remain in memory.
</Note>

<Warning>
  **Do not manually edit `data.yml`.** This file stores player statistics and is managed automatically by the plugin. Manual edits may corrupt player data or cause plugin errors.
</Warning>

## File Locations

All configuration files are located in:

```text theme={null}
plugins/PrimaxBattleRoyaleX/
├── config.yml
├── messages.yml
├── game-settings.yml
├── world-settings.yml
└── data.yml
```
