Battle Games: Hunger Royale

Battle Games: Hunger Royale (BGHR) is a richly featured PvP minigame plugin inspired heavily by LibsHungergames and its “MCPVP style” addon (though it is 100% original code) that also combines modern elements from KitPvP and battle royale games in a highly customizable and efficient package.

Once installed, BGHR will automatically create a new game from one of the included sample maps. Players can view current games, join open games, or spectate games using the /games menu. Once enough players have joined the game, it will automatically start and run based on its setup/configuration. BGHR will make sure at least one game is running at all times, but administrators can start/run additional games at any time from the admin GUI.

BGHR has two primary use cases:

1. As an additional plugin on your existing server (SMP/Creative/Lobby/whatever)
   • disable the main scoreboard if you already use one
   • players can type /games at any time to view and/or join a game
   • when the game is over or if they /quit, players will return to where they were before joining
2. As a minigame server on your BungeeCord network:
   • Use your own waiting lobby as the main server world and the provided scoreboard (which shows running games/players/time left/etc.)
   • Players can join/spectate games using /games and will return to the lobby afterwards

Plugin Features

• Very easy to set up - add the plugin and restart!
• Includes 4 pre-configured sample maps of different sizes (and it’s super easy to add your own!)
• Each game runs in its own world
• No server restarts required between games
• Kits, maps and games can all be set up, saved, created, and/or configured using an in-game admin gui
• Supports running multiple games at the same time
• Random loot chest generation makes any map a PvP map!
• Scoreboards - both inside and out of games
• Player settings - GUI menu to turn scoreboards on/off and more
• Auto-updater
• Clickable Hologram displays for showing game info/joining games

Configurable Games: each game can be configured in multiple ways

• Games can be configured to start "HungerGames style" (evenly placed around a central spawn) or "Elytra Style" (launched into the air to glide back down with a temporary elytra a la Fortnite)
• 5 game phases with configurable times:
  • pregame
  • invincibility
  • main
  • border
  • postgame
• configurable shrinking world border
• configurable lives per player to allow respawns (great for fewer players on smaller maps!)
• configurable number of players needed to start the game
• configurable spawn locations (specify a block type within a radius for players to spawn on or spawn equally around the center)
• Per-game, per-map loot settings
• These settings can all be saved in a configuration file (via the gui) for repeated usage or set up without saving for a “one-off” game

Configurable Loot settings

• Each game/map can have its own unique loot settings
• Uses standard Minecraft JSON format for loot tables
• Automatically fills chests on your maps from the loot table (can be turned off)
• Randomly places loot chests in maps that don't have them making any map a PvP map and every game different!
• Despawns looted chests after some time (so that most chests players encounter will have loot in them)
• Configurable loot chest respawn timer
• Randomly-placed and respawned chests show a particle effect that disappears after it has been opened/looted (pre-placed chests do not initially show effects, but they will after despawning/respawning)

Configurable Kits and Abilities!

• Kits can be created and modified using the admin GUI (/bghr)
• Several configurable abilities are available for customizing your kits (lots more coming)
• Configurable equipment sets for your kits

REQUIREMENTS:

• A Paper server (1.16 or 1.17)
• Java 8 if running 1.16, or Java 16 if running 1.17

Installation

1. Put it in your plugins folder
2. Start the server. The first time, a few things will happen that don’t need your input:
   1. some basic pre-configured maps will be placed in a folder in your server root
   2. default plugin and game configurations will be saved and loaded
   3. some folders will be made for active game worlds and logs
3. Join the server. A game will already be started (type "/games" to see/join it)

Almost all configuration can be done in-game (except for MySQL config and dropping in loot table JSON files)


User Commands

/join - joins the first game accepting players or shows a selection gui if more than one

/games - shows all running games in a gui to join or spectate

/settings - shows player settings gui (for turning scoreboards on/off, etc)

/kitmenu - select a kit to use

/quit - leave the game you are in and return to the main/lobby world, sacrificing any remaining lives

/stats - shows your statistics, or another player's if you include their name

/topstats - shows the top 10 players for each recorded statistic

/vote - opens the GUI to vote for the next map

Admin Commands

/bghr - open admin gui menu (permission: bghr.admin.menu)


About Me

I'm a high school math teacher. I do this for fun. Everything I know about Minecraft and Java is self taught but I've been doing it for a while and I think I'm getting pretty ok at it.


Planned Features

• player statistics (done)
• scoreboard (done)
• economy support
• more kit abilities
• voting for map/game type/etc (done)
• translations (partially implemented)

Not-Planned Features (don't ask)

• older Minecraft versions (i.e. 1.8)

Source Code: https://github.com/cheracc/BattleGamesHungerRoyale


Jenkins (for 1.17/previous versions): http://jenkins.cheracc.me/job/BattleGamesHungerRoyale/


Support/Donations

If you need help or are getting errors, you can either submit an issue on GitHub or you can just post in the discussion area (using the "Discussion" tab up at the top there). I'm old and haven't jumped on the discord train yet.

I'm committed to keeping this free and updated for as long as I feel rewarded for my work. You can show your appreciation in several ways:

• Offer constructive criticism and suggestions for improvements
• A ‘thank you’ is always nice if you find this useful
• Pay it forward and be a positive example in the Minecraft community
• I’d be lying if I said I didn’t also appreciate money: https://www.paypal.com/donate?hosted_button_id=L29ZQKWJXTYL8