DonutRules

DonutRules v1.0
Easy to use Rules Plugin
Overview History Analytics

DonutRules Fully Configurable Rules System

Overview
DonutRules provides a clean, professional, and fully customizable solution for displaying server rules. Designed with performance in mind for both Paper and Folia servers, this plugin ensures your community guidelines are always accessible, legible, and easy to manage. With real-time reloading and modern formatting, keeping your rules updated has never been easier.

Key Features
Native Folia Support utilizing async execution to ensure zero impact on your servers main-tick performance and TPS.
Fully Configurable through an intuitive config.yml file allowing for unlimited rule entries and categories.
Modern Formatting with complete support for MiniMessage, HEX gradients, and classic legacy color codes.
Real-Time Reloading with a dedicated command to apply changes instantly without a server restart.
Optimized for Performance using efficient data handling to display rules instantly to players.

Commands and Permissions
/rules - Displays the configured server rules to the player.
/rules reload - Instantly reloads the configuration file and rules list - Permission donutrules.admin

Technical Specifications
Folia-Ready Async Architecture designed for next-generation high-performance server clusters.
Thread-Safe Configuration Loading ensuring stability during real-time updates.
Adventure API Integration for rendering beautiful text components on all modern Minecraft clients.
Legacy Bridge functionality that automatically parses old formatting codes into modern components.

Installation

1. Place the DonutRules jar into your plugins folder.
2. Ensure you are running Java 21 and Paper or Folia 1.21.1 plus.
3. Restart the server and edit the generated config.yml file.
4. Use the reload command to apply your custom rules.

Developer Mattis
Please leave a review if you find this tool helpful for organizing your server.