What problem does it solve?
Grimoire is a reference design for a modular "magic book" system that standardizes data modeling, serialization (NBT), generation pipelines, and runtime execution for spells in Minecraft datapacks, enabling consistent development and debugging across spells.
Core Features & Use Cases
- Data model and type definitions for grimoire (ID, CastTime, CoolTime, MPCost, Script, Title, Description)
- End-to-end lifecycle: from savedata/grimoire.json entries to generated artifacts (effect/give mcfunctions)
- Runtime integration: binding to items via custom_data and triggering via cast pipelines, with support for spawn/effects and debugging
- Use Case: add a new healing spell by adding a new JSON entry and Script, then export to generate in-game functions for testing
Quick Start
Add a new grimoire entry to savedata/grimoire.json, provide its Script commands, then run the export tool to generate the corresponding mcfunction artifacts.