BattleArena
NOTE: This project has moved to Modrinth. All future updates will be posted there and this page will no longer receive updates.
A complete match and event framework for creating arenas and minigames in Minecraft. Supports creating modes through config files, or fully custom modes through plugins.
BattleArena allows you to create your own competitions on a Minecraft server through config files. Nearly all aspects of game logic are configurable, ranging from team sizes, spawn points, maps, game mechanics and many other features.
Features
- Arena isolation - Store/restore player items when joining or leaving competitions
- Classes - Create custom kits or classes
- Dueling - Configure dueling options for your competitions
- Dynamic arenas - Scale up competitions in worlds on-demand
- Scoreboards - Configure scoreboards for competitions
- Statistic Tracking (with BattleTracker) - Store competition statistics and include leaderboards
- Team configuration - Create solo or team-based competitions
- Tournaments - Run bracket tournaments for any match type
- World restoration - Restore maps once a competition ends
Default Modes
Active games in BattleArena are referred to as Competitions. BattleArena natively supports two competition types:
Matches
A game that is started when a certain condition is met (i.e. number of players), or is always active. These games can be joined at any time, as long as there are available maps. Common examples may include Spleef, SkyWars, Survival Games, or Capture the Flag.
A list of additional gamemodes can be found here.
Events
A game that is started based on a certain interval, or when triggered by a server administrator. These games cannot be joined normally unless the event is active. Common examples may include a bracket tournament, deathmatch, or a free for all.
Builtin Match Types
- Arena: Simple duels mode that you fight with what is given to you in the config.
- Skirmish: You bring in items you want to fight with. The game is always running, and you can join and leave at any time.
- Colosseum: 4v4 team deathmatch. Last team standing wins.
- Battlegrounds: 1 minute match in which the winner is the player with the most kills.
Builtin Event Types
- Free for All: A free for all deathmatch that starts every 30 minutes. Last player alive wins.
- Deathmatch: A 2-minute event where if you die you respawn. The player with the highest number of kills wins.
- Tournament: Bracket tournament for any number of teams.
User Guide
Most all of the configurable features in BattleArena will lie in the respective <arena>.yml files located in plugins/BattleArena/arenas. These can be modified, removed, and new ones can be added.
The full user guide for BattleArena can be found at the User Guide on the BattleDocs.
For Developers
BattleArena is highly extendable and has wide support for creating your own matches, events, and even competition types. It is an event driven framework, meaning external plugins can easily add or modify behavior in numerous ways.
Full documentation for the BattleArena API can be found on the Developer Guide on the BattleDocs.
Additional Extensions and Modules
BattleArena is a framework at heart, meaning that the base plugin comes with a very standard feature set, with the bulk of additional content coming from modules and extensions. The following extensions and modules build on top of BattleArena, and allow you to further extend BattleArena's capability.
Extensions
These are plugins which add new modes to BattleArena.
- ArenaSpleef - Adds Spleef to BattleArena
- ArenaCTF - Adds Capture the Flag to BattleArena
- ArenaPaintball - Adds a Paintball mode to BattleArena
- ArenaParkour (coming soon) - Adds Parkour to BattleArena
Statistic Tracking
Statistics are tracked by our sister plugin BattleTracker. This adds functionality such as leaderboards and ranking to BattleArena. See the BattleTracker page for more information.
Modules
These extend on existing BattleArena functionality and can (often) be used in any mode, even custom ones.
Bundled: These modules come pre-installed with BattleArena.
- Arena Resoration - Allows you to restore maps at the end of a competition from a WorldEdit schematic
- Boundary Enforcer - Ensures that players do not leave the arena bounds while in a competition.
- Classes - Adds custom classes (or kits) to BattleArena.
- Duels - Allows you to duel other players in configured arenas.
- One in the Chamber - Adds One in the Chamber support to BattleArena.
- Scoreboards - Adds scoreboard support to BattleArena.
- Team Colors - Changes the color of a player's name in arenas this module is enabled in.
- Team Heads - Sets each player's head item to a wool item of their team color.
- Tournaments - Adds bracket tournament support to BattleArena.
- Vault Integration - Support for functionality with Vault, such as adding/removing currency or giving/removing permissions in arenas
Third Party:
- PhatLoots - Support for configuring and resetting loot tables inside competitions.
A full list of party modules and plugins that utilize BattleArenacan be found on the Modules and Other Tools page on the BattleDocs.
Links
- Website: https://www.battleplugins.org
- Discord: BattlePlugins Discord
- Donate: BattlePlugins Patreon
Important Mentions
Special thanks to alkarin_v for writing the original BattleArena plugin back in 2011. While very little of the original code survives today, this laid the foundation of what would eventually become the BattlePlugins suite and the innovations that followed.
Any chance of an update to work with Paper 1.16.5?
This needs to get fixed for 1.16.3++
[BattleArena] Modules (2) [Paintballs, Grenades]
How do u use said grenades cant find anything at all about them..
only thing about modules seems to be for more for arena modes and is not very descriptive on use
In reply to llimpy:
The items only appear on the game itself, not outside of it.
For it to work, you need to create an arena, configure it and then start a match.
The items that spawn on player inventory can be edited changing a file with the clases.
In reply to llimpy:
https://wiki.battleplugins.org/BattleArena/Modules
Those are just EXAMPLE modules to show developers how to create their own custom BattleArena modules by extending the ArenaModule class. Here are two more examples you can use on your server:
https://github.com/Europia79/StopInterference
https://github.com/Europia79/ArmorLock
http://rainbowcraft.sytes.net/download/plugins/BattleArena/modules/
As you can see in the wiki, you actually have to go into the config & tell BattleArena which modules you want activated for that arena type:
Will you be updating the Extensions as well? Was using CTF and Parkour... The CTF basically works. But the parkour does not allow you to set checkpoints. I was able to add them in the config when I figured out the format. But would be nice if they got updated. Thanks. And great work on the plugin.
In reply to Newpoman:
https://github.com/BattlePlugins/BattlePluginsDev/blob/master/arenas/pom.xml#L16-L49 That's the list of arena extensions that I plan to update (& create). Am I missing anything on that list ? If anything else needs updating, lemme know the arena name. If anything custom needs to be made, then lemme know what the rules are for that game-mode. The ones that are not commented out will get updated first... altho, i believe Redned has already started updating Parkour. Me personally, I am pretty anxious to get started on updates for BombArena, HostageArena, & ArenaFutbol [sic]. After that, hopefully I can quickly push out some other ones like ConquestArena... Altho, I am also very excited about BossArena (World of Warcraft style raid bosses with tank, dps, & healer classes), but since it's such an ambition project, it'll probably have to go on the back burner until some of the quicker & easier ones get attention first.
I'm excited about the news, sorry for the question but, do u have any ETA for 1.13 update?
Welcome back! :D
In reply to Lautta:
In reply to Zach443:
If anyone still cares, this plugin is back under development. 1.12 and 1.13 updates coming soon :)
In reply to Zach443:
And i'm sure i'm not alone to think that !
In reply to Zach443:
In reply to c0wg0d:
There is a little bug with the reward message: You can not change it! Can you fix this plz? Keep on the good work!
Pleas update the plugin and fix all buggs ERRORS in console and Inventory Clear bug on death
survival arena link is changed to https://dev.bukkit.org/projects/survivalarena
this is a good plugins thanks :)
i was wondering classes how do i change attack speed
No sure how, but you can add items with enchantments to any class.
Since I cant get to the website, can somebody tell me how to do the worldguard regenerations? My server is really depending upon this plugin as it is the only one of its kind that works on 1.11.2.
Thanks :D