ArenaRegenerator

<p align="center"> <img src="https://github.com/Woodstop/ArenaRegenerator/blob/main/ArenaRegenerator_Small.png?raw=true" /> </p> # ArenaRegenerator !(https://img.shields.io/badge/Java-25-blue) !(https://img.shields.io/github/license/Woodstop/ArenaRegenerator) !(https://img.shields.io/github/v/release/Woodstop/ArenaRegenerator) !(https://img.shields.io/github/issues/Woodstop/ArenaRegenerator) # **ArenaRegenerator Plugin** ArenaRegenerator is a plugin for Minecraft servers that handles arena saving, resetting, and full minigame logic using WorldEdit or FAWE. This plugin manages and regenerates WorldEdit or FAWE-defined arenas. Includes full minigame support (e.g., lobby, countdown, game state, win detection) and interactive signs for easy use. ## **Table of Contents** 1. (#features) 2. (#dependencies) 3. (#installation) 4. (#usage) * (#interactive-signs) * (#commands-and-permissions) 5. (#example-configuration) 6. (#data-storage) 7. (#building-from-source) 8. (#support--contribution) ## **Features** * Arena Management: - Save WorldEdit selections as arenas. - Instantly clear or regenerate arenas. - List, delete, and view detailed information for saved arenas. * Minigame System: - **Lobby System**: Players can join an arena's lobby and wait for enough players. - **Countdown**: A configurable countdown begins when the minimum player count is met. - **Game Start**: Players are moved from the lobby to game spawn points, inventories are cleared (configurable), and game mode is set. - **Game End**: Game ends after a set duration or when a win condition (e.g., last player standing) is met. Players are teleported out, their state is restored (configurable), and the arena is reset. - **Spectator Mode**: Players leaving the arena boundaries during a game can be moved to spectator mode. - **Configurable Rules**: Set minimum/maximum players, game duration, lobby countdown, items and game mode on join, what blocks can be broken or placed, and damage prevention per arena. * Interactive Signs: - Regenerate arenas on click with `` signs - Join minigame arenas with `` signs - Leave minigame arenas with `` signs ### /arena save and /arena info <p align="center"> <img src="https://github.com/Woodstop/ArenaRegenerator/blob/main/ArenaSave.gif?raw=true" /> </p> ### /arena clear and /arena regen <p align="center"> <img src="https://github.com/Woodstop/ArenaRegenerator/blob/main/ArenaRegen.gif?raw=true" /> </p> ### Arena Regen Signs <p align="center"> <img src="https://github.com/Woodstop/ArenaRegenerator/blob/main/RegenSign.gif?raw=true" /> </p> ### Join Arena Signs <p align="center"> <img src="https://raw.githubusercontent.com/Woodstop/ArenaRegenerator/fd916e0b314a1e942c7eddfa959ab092866aa8b3/JoinArenaSign.gif" /> </p> ### Minigame Logic <p align="center"> <img src="https://raw.githubusercontent.com/Woodstop/ArenaRegenerator/1e91d9673727e0268a68fbd1a2bac4fe01e7679b/SpleefGame.gif" /> </p> ## **Dependencies** This plugin requires either **WorldEdit** or **FastAsyncWorldEdit (FAWE)** to be installed on your server. * (https://dev.bukkit.org/projects/worldedit/files) * (https://www.spigotmc.org/resources/fastasyncworldedit.13932/) **Important:** Only install ONE of these plugins (WorldEdit or FAWE) on your server. Having both can cause conflicts. ## **Installation** 1. Download the latest `ArenaRegenerator-X.X.X.jar` from the (https://github.com/Woodstop/ArenaRegenerator/releases) page (or compile it yourself). 2. Download either **WorldEdit** or **FastAsyncWorldEdit (FAWE)** that is compatible with your server version. 3. Place both `ArenaRegenerator-X.X.X.jar` and your chosen WorldEdit/FAWE JAR into your server's plugins/ folder. 4. Restart server. ## **Usage** ### **Interactive Signs** Create signs to automatically regenerate arenas, join minigames, or leave minigames. 1. Place sign. 2. Line 1: `` or `` or ``. 3. Line 2: Your exact arena name. 4. Players with appropriate permissions can click to use. 5. Default 10-second cooldown; `arenaregenerator.sign.bypass` overrides. ## **Commands and Permissions** Commands use the `/arena` prefix. An alias `/ar` is also available. Replace `<arenaName>` with your desired name for the arena. `<arenaType>` can be either `lobby`, `exit`, `spectator`, or `game`. | **Permission Node** | **Description** | **Command** | |--------------------------------------|----------------------------------------------------------------------|-------------------------------------------------------|