This repository holds common code and libraries underlying a suite of PvP minigames implemented in Minecraft.
Specifically, this repository holds minigame-related code that is not (yet) additionally useful outside of concrete minigame implementations.
- The augmented movement library is separated due to it's usefulness/inclusion in some non-minigame modules.
- The PunchTree-Util library contains generic Minecraft utility code useful across all projects.
The main responsibilities of the shared code include:
- Parameterized minigame lifecycle management classes
- Minigame lobbies
- Minigame UI elements and utilities (killfeeds, leaderboards, banners)
- Arena management and basic modeling and utilities for reading/writing arenas to YAML files
- Menu-based UIs for finding and joining lobbies and running games
- Additional utilities for common tasks, particularly around handling the base Minecraft player (preserving out-of-game player state, preserving inventory, equipping armor, etc)
Current minigames are:
- Melee - A free-for-all minigame, first to 7 (or X) kills.
- Rabbit - Capture-The-Flag meets King-of-the-Hill. Holding the flag grants double movement stamina over other players; first to hold the flag for a cumulative 2 minutes (X seconds) wins.
- Jailbreak - Like team deathmatch, except when you die you go to jail. Alive teammates can free you from jail. If your whole team is dead, you lose.
- Battle - Capture all the enemy's poles to win, but only do so when it's your turn! Deny enemies from capturing any of your team's poles for 15 seconds to turn the tide of battle!
- Siege - One side gets no respawns, lots of health, and some better equipment, and they fight their way through a large, multi-chapter map to capture the kingdom/city/etc. The other side respawns with each captured section of the map, and tries to stop the attackers from sieging their territory!
- BeachWars - An experimental turf-wars type gamemode. As your team gains kills, the sand under your feet starts to turn your team's color! Die to the enemy team and the opposite happens. Capture the whole arena to win!
Repositories under the PunchTree-Minigames umbrella currently are:
- PunchTree-Minigames - The core minigames libraries (You are here)
- Movement++ - The component-based movement augmentation system and libraries
- Melee - Contains Melee and Rabbit code. The oldest codebase and has a lot of refactoring still left to do.
- Jailbreak
- Battle
- Siege - (Still under (active) development - not currently playable, but nearly)
- BeachWars - (Developed to experimentally playable - alpha, not currently being worked on further)