Rulebook Engineering¶
Rulebooks are physical Minecraft items that contain a pre-defined set of event restrictions. These books can be imported into any game phase to instantly apply complex rulesets.
The Engineering Flow¶
Creating a Rulebook involves selecting events, validating them in real-time, and exporting the final data into a book.
1. Event Selection¶
Navigate through the categories to see a comprehensive list of Minecraft events.
- Green Check: The event is currently "Disallowed" (restricted).
- Yellow Cross: The event is currently "Allowed" (unrestricted).
- Click to Toggle: Instantly switch the state of an event.
2. Live Testing¶
The Test Setup feature allows you to verify your rules in real-time before exporting the book.
- Enable Test Mode: The rules you've selected are applied immediately to you.
- Validation: Try to perform the restricted action (e.g., if you disallowed
BlockBreakEvent, try breaking a block). - Live Updates: Changes you make while in Test Mode are updated instantly in the game world.
3. Finish & Export¶
Once satisfied, select Finish Events. You will be prompted to provide a unique name for your ruleset.
The framework will then generate a Physical Rulebook and place it in your inventory. This book contains all the serialized rule data and a summary of the enabled restrictions.
Importing Rules
To use your engineered rules in a match, open the Phase Editor and left-click in the air with your new Rulebook while editing the "Phase Rules" slot.