☠ Battle Royale X ☠

- Fully independent! The plugin can run fully by itself but you will lose some features, such as guns and vehicles.
- Auto armor equip
- Tracking compass
- Minimal arena modification is enabled. Players can place blocks and only break blocks placed by players.
- Lobby countdown shortening system! If the arena has a certain number of players the timer will be shortened to begin faster
- You can send messages to party members only by starting your message with an exclamation mark
- A profile GUI where you can see all of your stats and items and your achievements
- Amazing lightweight rollback system
- Lightweight cooldown system
- Edit arenas on the fly!
- You can spawn mobs that will attack your enemies
- Kits can apply their own potion effects and run their own commands!
- Basic API that allows developers to access players stats and get top players, and also some events
- Set the coins/exp modifier of players to any number you want! You can also reset their stats! This also applies to offline players
- You can separate the spectator's chat, arena chat, and lobby chat!
- Force start/stop arenas, and reload the plugin with a simple command rather than reloading the whole server
- Spectators can instantly join a new game
- You can create permissions that allow players to have more slots per party
- You can create permissions that allow players to have more loadouts
- You can specify a set of potion effects for each arena (Some arenas for example could have infinite Speed I or some might have infinite Strength I and so on)
- You can run your own commands on players when the arena starts or when players win
- You can have an animated scoreboard title
- An update checker to keep you alert inside your game!
- Smooth, well designed, and created to be able to handle a large number of players

config.yml
customization.yml
achievements.yml
chests.yml
shopping-station.yml
shop.yml
kits.yml
custom-recipes.yml
player.yml (Per player)
arena-settings.yml (Per arena)

You can download the free setup here:
https://1drv.ms/u/s!Ar7IHWG_oZWhgRHdc7FgWcACjAfV?e=2GvZ6b

Extract the zip file, and you will find two folders inside.
Open the 'Worlds' folder and copy all the worlds listed into your server worlds directory.
Then, copy the 'BattleRoyaleX' folder into your plugins folder. That's it! Enjoy.

You first want to set the global lobby location by doing '/brx setlobby'
so that when players do '/brx join' they will be teleported there.
now you should create some arenas

Assuming that you do not have multiverse, and your map is not loaded, you could use the command '/brx worldmanager import <Map>' and then teleport to it with '/brx worldmanager tp <Map>'

To create an arena, use '/brx create <name> <Normal/Plunder> <Min teams> <Max teams> <Team size>'
This will create a new arena with your defined name.
The arena type can be 'Normal' or 'Plunder'. Normal mode is where players compete to be the last team standing. Plunder mode is where players can keep respawning, and the winning team is the team with the highest amount of cash collected by the end of the arena timer.
<Min teams> is the minimum amount of teams required for the arena to start.
<Max teams> is the maximum amount of teams that the arena can handle
<Team size> is the size of each team. 1 means that the arena is solo, 2 means that each team can have 2 players max.
For example: if <Min teams> is 2, <Max teams> is 4, <Team size> is 3, that means that the arena will require a minimum of 2x3 = 6 players to start the countdown, and it can handle a maximum of 4x3 = 12 players.

After creating the arena, you should now set the center of the arena. Use the command '/brx setmapcenter <Arena>' to set the center at your location

[Optional], You can now use the command '/brx generatemap <Arena>', this command will create a map of the region and it will be given to players when they spawn. This command will probably tell you about missing materials from the map palette file. If the generated map looks bad, You can navigate to that file in BattleRoyaleX folder and add all missing materials and their associated colors manually. After adding them, make sure to reload the plugin and run the same command again. You can run this command multiple times until you find a map that looks good!

You can now set the plane routes. Use the command '/brx setroute' to do so. You can have multiple routes and each time a random one will be picked.
Command example:
/brx setroute <Arena> 1 Start
This will set the start of route #1 at your location
/brx setroute <Arena> 1 Finish
This will set the end of route #1 at your location

[Optional] You can add locations of supply drops! Use the command '/brx addsupplydrop <Arena>' to add as many locations as you want. Keep in mind, these places should have no blocks above them! Every while, the arena will pick a random location of these locations and drop a bunch of valuable chests from the air!

[Optional] If you have QualityArmoryVehicles2 Enabled, you can add locations where vehicles will randomly spawn using the command '/brx addvehiclespawn <Arena>'

[Optional] Shopping stations, by default, are simply ender chests. If a player right clicks an enderchest, he will open the shopping station. So add these blocks carefully.

[Optional] To make a spot on the map, for example, if you had a shopping station somewhere and wanted players to know that there is something important at this location. You can use the command '/brx addmapblip <Arena>' to add a blip at your location

[Optional] If you created a plunder mode arena, it is recommended to add extraction points! Use the command '/brx addextractionpoint' while standing at a block inside the arena to mark that spot for a plane cash pickup. Extraction ensures teams that they will not lose their cash if they died which is a crucial part for plunder mode.

You can now set the lobby location of the arena using the command '/brx setlobby <Arena>'. This is where players will teleport when they join this specific arena.

[Optional] You can set the location that spectators teleport to. To set the location you use the command '/brx setspectators <Arena>'

After you are finished everything you can use '/brx edit <Arena>' to enable the arena and change some other settings. Don't forget to click the save and apply button if you modified anything inside the edit GUI.

To create a mystery box, simply place an ender chest in the global lobby.

--- Bungee mode setup! for this all you have to do is the same steps as before, you should make some arenas and when you think that you have enough, go to config.yml and enable bungeemode. This plugin will only be on your game server and NOT in your hub server, if you want to join through signs from your hub server, then you need to have a plugin such as TeleportSigns in your hub

If you have only 1 arena, the plugin will make players enter the 1 arena directly (No lobby) and also restart when the arena ends.
If you have 2+ arenas, then the plugin will make players enter the lobby first (Same as '/brx join') and then they will be able to select the arena they want, and no restart will occur upon end.

- To create signs, the first line must be [BRX]

- To create a lobby join sign, the second line should be 'join'
- To create an arena join sign, the second line join be 'join' and the third line should be the arena name
- To create a leave sign the second line should be 'leave'
- To create an autojoin sign the second line should be 'autojoin'
For the autojoin signs, you can also specify in the third line 'solo' or 'teams'

- To create leaderboard signs the second line should be 'top' and the third line should be the stat name, for example 'kills', 'games_played' etc...
and the fourth line should be the rank you are looking for! If you want to display the TOP player (rank 1) then write in the fourth line '1'

The API can be simply accessed using the class named BattleRoyaleXAPI.

Methods:

• getTopPlayers (Should run async)

- First argument is the players data which you can get from BattleRoyaleXAPI.getAllPlayersData()
- Second argument is the stat, for example Stat.KILLS
- Third argument is the amount of top players you are looking for

Example:

• BattleRoyaleXAPI.modifyOfflinePlayerStat (Should run async)

- First argument is the player name
- Second argument is the Stat that you want to modify, for example Stat.COINS
- Third argument is the value
- Fourth argument is a boolean which indicates whether the value (3rd argument) should be 'added' to the existing score or the stat should be just overwritten to the value.

Example:

You can also access lots of methods using class instances.
The main class instance can be retrieved using BattleRoyaleXAPI.getInstance()
You can access the customization class with Customization.getInstance() and the config class with Config.getInstance() and many other classes. But you are not really supposed to use those and they won't be documented. So ask me for help before using methods in those classes.

BRArenaStartEvent
BRArenaStopEvent
BRPlayerJoinArenaEvent
BRPlayerLeaveArenaEvent
BRPlayerDeathEvent

For internal lobby scoreboard, you can use these placeholders:
%games_played%, %coins%, %kills%, %deaths%, %projectiles_hit%, %normal_wins%, %plunder_wins%, %player_exp%, %player_rank%, %selected_kit%, %selected_celebration%, %blocks_broken%, %blocks_placed%

For arena scoreboard, you can use these placeholders:
%players%, %max_players%, %date%, %arena%, %mode%, %timer%, %border_distance%, %current_event%, %current_event_timer%

The placeholders mentioned below are for PlaceholderAPI, if you want to use MVdWPlaceholderAPI placeholders then use the same placeholders below but replace the first % with { and replace the last % with }

Not player specific placeholders:
%battleroyalex_players_count%, %battleroyalex_parties_count%, %battleroyalex_lobby_players_count%, %battleroyalex_arenas_count%, %battleroyalex_kits_count%, %battleroyalex_arena_status_<arena>%, %battleroyalex_bungee_arena_status%

Player specific placeholders:
%battleroyalex_arena%, %battleroyalex_modifier%, %battleroyalex_party_leader%, %battleroyalex_games_played%, %battleroyalex_coins%, %battleroyalex_kills%, %battleroyalex_deaths%, %battleroyalex_projectiles_hit%, %battleroyalex_normal_wins%, %battleroyalex_plunder_wins%,  %battleroyalex_player_exp%, %battleroyalex_player_rank%,  %battleroyalex_selected_kit%, %battleroyalex_selected_celebration% %battleroyalex_blocks_broken%, %battleroyalex_blocks_placed%