How to setup a Battlefield

Creating a new Battlefield

To create a new battlefield just execute the command /brl setup, and then go to the Battlefield Setup then New Battlefield, then you will see two options:

  • From a World

  • From a Schematic

The plugin is capable of copying an ordinary Minecraft world or a schematic, it depends on your needs. Whether it is a world or a schematic, put it in input the folder "plugins/BattleRoyale/battlefield/input".


Loading an existing Battlefield

In case you want to edit an existing battlefield just execute the command /brl setup, and then go to the Battlefield Setup then Edit Battlefield, and then select the battlefield you want to edit.


Setup Tools

The battlefield setup session provides you with multiple tools to configure the battlefield. The are some tools that are modal; this means that you must finish/cancel the tool in order to use another one. To finish/cancel a tool just drop it from your inventory.

Name

This tool is used to set the name of the battlefield; it will ask you to enter in the chat the desired name.

Note that if you have just created a new battlefield and you have not set a name yet, the other tools will not be available in the setup GUI, so you must set the name in order to enable them.


Bounds

You can think of the bounds as a box within which the game takes place.

To set the bounds, you must enclose the zone by setting the two corners/points, like you do when selecting a region with world edit. Just go to the first corner/position and left click; then go to the second corner/position and right click.

Once bounds are set, the plugin will automatically start calculating stuff (like the minimap), just be patient and wait until the process is done. Note that:

  • You will receive the minimap item once the process is done.

  • If you have just created a new battlefield and you have not set the bounds yet, the other tools will not be available in the setup GUI, so you must set the bounds in order to enable them.


Border Resize Succession

The border resize succession determines how the border is going to be resized.

It's a succession as it is made up of points that the plugin generates randomly. Each point will have a certain size and a certain location within the battlefield.

All you have to do is provide some data that the plugin will use to randomly generate the points of the succession:

  • Minimum radius: The radius that the border will have at the end of the succession. In other words, how big the border will be after the resize succession is finished.

  • Full time: How long the succession lasts. In other words, how long it will take for the border to reach its final size (minimum radius).

  • Divisions: How many points are going to be generated.

  • Minimum damage: The minimum damage that can be inflicted on players when caught outside the border (the smaller the border, the greater the damage).

  • Maximum damage: The maximum damage that can be inflicted on players when caught outside the border (the smaller the border, the greater the damage).


Bus Spawns

Bus spawns are made up of a starting point, a direction, and a "door" point.

  • Starting point: The location where the bus route begins.

  • Direction: The direction the bus is heading to.

  • Door point: The point on the route where the bus door opens, allowing the player to jump.

To add a bus spawn, go to the position where you want the route to start (this will be the starting point), look in the direction you want the bus to go (this will be the direction) and then right click; the spawn will be added, and then, you will see the manipulator, which allows you to modify the spawn. There will be three wools:

  1. The first (in red) represents the starting point. You can left click it to remove the spawn.

  2. The second (in green) represents the door point. You can right click, to move it in the direction you are facing.

  3. The third (in constant motion) shows how the bus will travel on the route. You can right click it to increase/decrease the speed of the bus.


Player Spawns

Tool to set where players will spawn. You can set multiple spawns around the battlefield; players will randomly spawn in one of the spawns.

Note that player spawns only work if no bus spawns are set.

To add a player spawn, go to the position where you want the spawn to be at, and then right click; the spawn will be added, and the, you will see the manipulator, which allows you to move the spawn by right clicking it. To remove the spawn just left click it.


Loot Chests

Tool to set where loot chests will spawn. You can place as many loot chests as you want around the battlefield.

To remove a loot chest to break it.

To configure the loot of the chests go to the loot configuration your battlefield is using. [IMPL: Link to Loot Configuration]


Air Supplies

Tool to configure the air supply generator.

All you have to do is provide a minimum and a maximum number that the plugin will use to randomly drop air supplies around the battlefield. If for example you set the minimum to 3 then you are telling the plugin that at least 3 air supplies should be dropped; and if you set the maximum to 15 then you are telling the plugin that no more than 15 air supplies should be dropped.

To configure the loot of the air supplies go to the loot configuration your battlefield is using. [IMPL: Link to Loot Configuration]


Bombing Zones

Tool to configure the bombing zone generator.

All you have to do is provide a minimum and a maximum number that the plugin will use to randomly generate bombing zones around the battlefield each time a new point of the resize succession starts. If for example you set the minimum to 1 then you are telling the plugin that at least 1 bombing zone should be generated; and if you set the maximum to 3 then you are telling the plugin that no more than 3 bombing zones should be generated.


Vehicle Spawns

Tool to set where vehicles will spawn. You can set as many spawns as you want around the battlefield.

To add a vehicle spawn, go to the position where you want the spawn to be at, and then right click; the spawn will be added, and the, you will see the manipulator, which allows you to move the spawn by right clicking it. To remove the spawn just left click it.


Vehicles Configuration

Tool to set what vehicles configuration the battlefield will use.

The vehicles configuration system works in a similar way to the arena system. Each .yml inside the folder "plugins/BattleRoyale/vehicle" is a different configuration. This way you can have a different vehicles configuration per battlefield. Vehicle configuration file is pretty much the same as a loot configuration file, but instead of items, you are configuring the possible vehicles that can spawn around the battlefield.

For more information about how to setup a vehicles configuration, go to: Vehicle Configuration


Loot Configuration

Tool to set what loot configuration the battlefield will use.

The loot configuration system works in a similar way to the arena system. Each .yml inside the folder "plugins/BattleRoyale/loot" is a different configuration. This way you can have a different loot configuration per battlefield.

For more information about how to setup the loot, go to: Loot Configuration

Last updated