🎮 MiniGames Plugin

A lightweight minigames plugin.
This plugin is designed for lobbies, allowing players to play with others when they're bored.

---

🚀 Features

• Plug-and-play.
• Includes minigames.
• Inventory interfaces via Inventory Framework.
• Advanced command structure through CommandAPI.
• Paper-compatible.
• LuckPerms support.

---

📜 Commands

Command	Description
/minigames	Opens the main menu.
/minigames reload	Reload the config.
/minigames <game> [player]	Sends a game request to a player.
/minigames accept <player>	Accepts a game request.
/minigames decline <player>	Declines a game request.
/minigames toggle	Toggles invites.
/minigames quit	Let you leave a game or a queue
/minigames set <edit>	Allows you to edit the config
/minigames reload	Reloads the config
/minigames clear	Clears all lists in case you want to reload the config
/minigames help	Shows all available commands.

---

🍀 LuckPerms

Permission	Description
minigamesv4.minigames	Grants access to all minigame commands.
minigamesv4.admin	Grants access to admin-related commands.
minigamesv4.autotoggle	Automatically toggles invite settings.
minigamesv4.*	Grants access to all commands.

---

🕹️ MiniGames

Game	Description
Hide and Seek	Hide from the seeker. The seeker can find you by clicking on you. Includes a mode that lets you grow or shrink.
Rock Paper Scissors	Play against a friend - just type your move. The game listens. No commands needed.
TicTacToe	Play in a clean, intuitive GUI with a built-in randomizer to decide who starts.

🧩 Dependencies

This plugin uses the following APIs:

• Inventory Framework - tested with v0.11.0
• CommandAPI - tested with v10.0.1
• PaperMC - tested with Paper 1.21.4
• Java 21+ required.

---

📦 Plugin Metadata

This plugin uses the plugin-yml.paper Gradle-DSL to automatically generate the paper-plugin.yml at build time.

Example configuration in build.gradle.kts:

paper {
    main = "de.mikeyllp.miniGamesV4.MiniGamesV4"
    apiVersion = "1.21"
    serverDependencies {
        register("CommandAPI") {
            required = true
            load = PaperPluginDescription.RelativeLoadOrder.BEFORE
        }
    }
}

This method avoids YAML files in the repo and ensures type-safe, automatic generation during each build.

---

⚠️ Development Status Notes

This version (v0.3.0-beta) is a Beta release.
Features are unstable and will likely change before the final release.

---

🛠️ Installation

1. Download the latest .jar file from the GitHub Releases page.
2. Place the .jar file into your server’s plugins folder.
3. Start or restart your Minecraft Paper server.
4. The plugin will generate its default config files automatically.
5. Customize the config if needed, then reload the plugin with /minigames reload.

---

🧰 Build (for developers)

Build the plugin as a Shadow FatJar with:

./gradlew shadowJar

The resulting file will be located at build/libs/MiniGamesV4-0.3.0-beta-all.jar.

---

🪪 License

📦 Own Plugin

This project is licensed under the GNU General Public License v3.0.
See the LICENSE file for full license details.

📚 Third-party Licenses

This plugin uses third-party libraries:

• CommandAPI © JorelAli – MIT License
  License: THIRD_PARTY_LICENSES/commandapi.txt
  Source: https://github.com/CommandAPI/CommandAPI

• Inventory Framework © stefvanschie – The Unlicense
  License: THIRD_PARTY_LICENSES/inventoryframework.txt
  Source: https://github.com/stefvanschie/IF

---

🤝 Contributors

Thanks for testing the plugin and giving feedback! 🙌

• Alex_mhr
• Danilo888TV
• HiorCraft
• KamiIIe
• Laluck98
• PEKK29
• Pingius2031
• Qwoxelias
• RicTheCraft
• TheBjoRedCraft
• Timonso

---

📬 Feedback & Contributing

Feature requests or bugs? Feel free to create an issue or open a pull request.

---

© 2025 MikeyLLP - All rights reserved.

---

NOT AN OFFICIAL MINECRAFT PRODUCT. NOT APPROVED BY OR ASSOCIATED WITH MOJANG OR MICROSOFT.