> For the complete documentation index, see [llms.txt](https://turfwars.isach.be/llms.txt). Markdown versions of documentation pages are available by appending `.md` to page URLs; this page is available as [Markdown](https://turfwars.isach.be/configuration/bungeecord.md).

# BungeeCord

Learn how to use Turf Wars on a BungeeCord network

Turf Wars has an optional BungeeCord support in case you're running a server dedicated to the game, which is a common practice in server networks.

Separating your servers allow for less conflicts between plugins. 512MB of RAM per server is usually enough to run flawlessly, especially with forks like [PaperMC](https://papermc.io).

Configuration for BungeeCord is located in the `config.yml` file. 

### Usage

For using the BungeeCord mode, simply go to the `config.yml` file, and set `enabled` to `true`:

```yaml
‌Bungee-Mode:
  enabled: false
```

### Features

When the BungeeCord mode is enabled, several features are available, including auto-joining the game when joining the server, an optional restart system, and a "go back to hub" item.

#### Restart System

```yaml
  restart-system:
    enabled: false
    max-games: 3
    send-to-server:
      enabled: false
      servers:
        - "server1"
        - "server2"
        - "server3"
```

To enable it, simply set `enabled` to `true`.

When enabled, the server will restart after `max-games` games have been played. 

`send-to-server` allows use to send players to random servers (e.g., hubs, lobbies) before restarting.

Note that this restart system should not be necessary on most servers. Some servers with heavy load and high player count might need this if servers tend to accumulate memory over time.

#### Go Back to Hub Item

```yaml
  go-back-to-hub-item:
    enabled: false
    id: barrier
    display-name: §c§lGo Back To Hub
    lore:
      - "&9&lClick to go back to a hub!"
      - "&3&lLine 2!"
      - "&3&lLine 3!"
    hubs:
      - "hub-1"
      - "hub-2"
      - "hub-3"
```

Similarly, first set `enabled` to `true`.

This will give players in the waiting lobby for the game an item that, when clicked, sends them to a random server.

`id`, `display-name`, and `lore` are the item details. As shown, they support coloring with `&`. [See this website](https://htmlcolorcodes.com/minecraft-color-codes/) for the color codes.

The `hubs` list defines which servers players are sent to when clicking the item. If several servers are set, a server is randomly selected for each item usage.