MiniGameCore

MiniGameCore

MiniGameCore is a central plugin for managing minigame lobbies in Minecraft Paper Servers. It handles hosting, joining, starting, and stopping games – with animated scoreboards, statistics, and multiverse support.

---

🔧 Installation

1. Download the latest `.jar` from Modrinth or Releases. 2. Place the file in the `plugins/` folder of your Minecraft server. 3. For permission-management, you can optionally use a plugin like LuckPerms. 4. Restart the server once.

---

📜 Commands & Permissions

| Command | Description | Permission | |-----------------------------------|------------------------------------------------------|-----------------------| | `/mg host <game>` | Creates a new lobby | `mgcore.host` | | `/mg join <lobby-id>` | Join the lobby | `mgcore.join` | | `/mg ready` | Set your Status as Ready | `mgcore.ready` | | `/mg unready` | Set your Status as not Ready | `mgcore.ready` | | `/mg confirm` | Confirm an action | `mgcore.confirm` | | `/mg leave` | Leave the lobby or game | `mgcore.leave` | | `/mg start` | Start the game manually (if allowed) | `mgcore.start` | | `/mg spectate <lobby-id|player>` | Join a game as a spectator | `mgcore.spectate` | | `/mg reload` | Reload the plugin | `mgcore.admin` | | `/mg stop <lobby-id>` | Stop a specific game | `mgcore.admin` | | `/mg stopall` | Stop all active games | `mgcore.admin` | | `/mg ban <player>` | Ban the player from using most MiniGameCore commands | `mgcore.admin` | | `/mg version` | Displays the version of MiniGameCore you are using | `mgcore.use` (default)| | `/party create <name>` | Creates a new party | `mgcore.party.create` | | `/party join <player>` | Join the player's Party | `mgcore.party.join` | | `/party leave` | Leave your party | `mgcore.party.join` | | `/party invite <player>` | Invite a player to your party | `mgcore.party.invite` | | `/party deny` | Deny a player's invitation to their party | `mgcore.party.invite` | | `/party list` | List the Party's Members | `mgcore.party.list` |

---

⚙️ Plugin-Configurations

Plugin Configurations are located in the folder: `./plugins/MiniGameCore`. The main configuration file is `config.yml`.

config.yml

Example config: ``` available-games: - Game1 - Game2 - Game3 banned-players: - 2e0749e5-4ec0-4201-b58d-c4277014749c - 337482fe-8a15-47f6-bea5-a84918a86393 keep-worlds: false ``` Note: if `keep-worlds: true`, the plugin is going to move them to `./plugins/MiniGameCore/ArchivedWorlds` instead of deleting them.

Loading Game-Worlds & Configuring them

The Folder for Gameworlds and configs is `./MiniGameCore`. Every Game World should be named like this: `<Game name>_world`. The world configs are named `config.yml` and should be located in the Game's world folder.

All available options:

| Field | Description | Required / Default | |------------------------|-------------------------------------------------------------------|--------------------| | `name` | Display name of the game, e.g. in the scoreboard or at `/mg host` | ✅ Yes | | `maxPlayers` | Maximum number of players for this game instance | ✅ Yes | | `teams` | Maximum number of teams (0 for no teams, 2-8 teams possible) | ❌ No (default: 0) | | `spawnPoints` | Default spawn points for players without a team | ✅ Depends | | `teamSpawnPoints` | Spawn points per team (e.g. `0: [...]`, `1: [...]`) | ✅ Depends | | `inventory` | Starting items at game start (e.g. `["WOODEN_SHOVEL"]`) | ❌ No | | `allowed_break_blocks` | Which blocks can be broken (e.g. `["SNOW_BLOCK"]`) | ❌ No | | `respawnMode` | Control of respawn behavior: `"true"` or `"false"` | ❌ No (default: false) | | `respawnDelay` | Seconds delay until respawn (if enabled) | ❌ No (default: 0) | | `doDurability` | Control ItemDamage: `true` (vanilla) or `false` | ❌ No (default: true) | | `allowPVP` | Allow PVP: `true` (vanilla) or `false` | ❌ No (default: true) |

Example config for an 8 player Spleef-Game: ``` game: name: Spleef maxPlayers: 8 teams: 0 spawnPoints: spawn1: x: -11 y: 64 z: 0 spawn2: x: -7 y: 64 z: -7 spawn3: x: 0 y: 64 z: -11 spawn4: x: 7 y: 64 z: -7 spawn5: x: 11 y: 64 z: 0 spawn6: x: 7 y: 64 z: 7 spawn7: x: 0 y: 64 z: 11 spawn8: x: -7 y: 64 z: 7 inventory: - "iron_shovel" allowed_break_blocks: - "snow_block" respawnMode: false doDurability: false allowPVP: false ```