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

# Configure Per-Mode Game Settings in game-settings.yml

> Configure player counts, match timers, PvP grace periods, respawn mechanics, and more for Solo, Squad, and Deathmatch modes in game-settings.yml.

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

`game-settings.yml` is the central configuration file for all per-mode gameplay parameters. Every game mode — Solo, Squad, and Deathmatch — has its own dedicated section where you can tune player limits, match duration, combat rules, and more.

**File location:** `plugins/PrimaxBattleRoyaleX/game-settings.yml`

<Tip>
  Start with the defaults and adjust based on your player count. Lower `min-players` values mean matches start faster on smaller servers.
</Tip>

## Game Mode Settings

<Tabs>
  <Tab title="Solo">
    In Solo mode, every player competes individually. The last player standing wins.

    | Setting            | Description                                                                                                                                                      |
    | ------------------ | ---------------------------------------------------------------------------------------------------------------------------------------------------------------- |
    | `min-players`      | Minimum number of players required to start a match. The countdown will not begin until this threshold is reached.                                               |
    | `max-players`      | Maximum number of players allowed per match. Additional players are queued for the next match.                                                                   |
    | `pvp-grace-period` | Number of seconds after match start before PvP is enabled. Set to `0` to allow PvP immediately.                                                                  |
    | `match-timer`      | Maximum match duration in seconds. If time runs out, the player with the most kills wins.                                                                        |
    | `elytra-enabled`   | Whether players receive an elytra when they spawn in. Set to `true` for a classic sky-drop experience (pair with a high `spawn-height` in `world-settings.yml`). |
    | `victory-reward`   | Commands or items granted to the match winner. Supports standard Minecraft command syntax with `{player}` as a placeholder for the winner's name.                |

    ```yaml game-settings.yml theme={null}
    solo:
      min-players: 4
      max-players: 50
      pvp-grace-period: 30
      match-timer: 1800
      elytra-enabled: true
      victory-reward:
        - 'give {player} diamond 5'
    ```
  </Tab>

  <Tab title="Squad">
    In Squad mode, players are divided into teams. The last surviving team wins.

    | Setting            | Description                                                                                     |
    | ------------------ | ----------------------------------------------------------------------------------------------- |
    | `min-teams`        | Minimum number of teams required before the match countdown begins.                             |
    | `max-teams`        | Maximum number of teams allowed per match.                                                      |
    | `min-team-size`    | Minimum number of players per team. Teams below this size cannot queue.                         |
    | `max-team-size`    | Maximum number of players per team.                                                             |
    | `friendly-fire`    | Whether teammates can damage each other. Set to `false` to prevent accidental team kills.       |
    | `pvp-grace-period` | Seconds after match start before PvP is enabled between opposing teams.                         |
    | `match-timer`      | Maximum match duration in seconds. The team with the most players alive when time expires wins. |

    ```yaml game-settings.yml theme={null}
    squad:
      min-teams: 2
      max-teams: 15
      min-team-size: 2
      max-team-size: 4
      friendly-fire: false
      pvp-grace-period: 30
      match-timer: 1800
    ```
  </Tab>

  <Tab title="Deathmatch">
    In Deathmatch mode, players respawn after being eliminated and compete for the highest kill count within a time limit.

    | Setting          | Description                                                                                                   |
    | ---------------- | ------------------------------------------------------------------------------------------------------------- |
    | `min-players`    | Minimum number of players required to start a Deathmatch.                                                     |
    | `max-players`    | Maximum number of players allowed per Deathmatch session.                                                     |
    | `match-duration` | Total match length in seconds. Default is `600` (10 minutes). The player with the most kills at the end wins. |
    | `respawn-delay`  | Number of seconds a player must wait before respawning after being eliminated.                                |
    | `starting-items` | Items given to players each time they spawn or respawn. Accepts a list of Minecraft item IDs.                 |

    ```yaml game-settings.yml theme={null}
    deathmatch:
      min-players: 2
      max-players: 20
      match-duration: 600
      respawn-delay: 5
      starting-items:
        - IRON_SWORD
        - BOW
        - ARROW
    ```
  </Tab>
</Tabs>
