GuideME

The toolkit renders guidebook pages from markdown with scrolling and an advanced text layout engine that supports reflow and inline elements. Pages can hold interactive 3D scenes with annotations that illustrate concepts from a mod, and recipes can be shown inline in a JEI-style layout. Authors can extend the markdown syntax with their own inline and block elements through a widget system, and extend recipe rendering so their own recipes appear in the guide.

Players reach the relevant page from an item tooltip by holding G, and topics link to one another with quick information in link tooltips. For modders, the library exposes an extensibility API for tags, widgets and recipe displays. Install it on the client and server together, since both sides need the mod. GuideME is published for Forge and NeoForge under a custom license that is not open source, with source code and an issue tracker linked from its listing. Files exist for 1.20.1, 1.20.4, 1.21.1, 1.21.5, 1.21.8, 1.21.10, 1.21.11, 26.1.1, 26.1.2, 26.2 and 26.3, and snapshot builds are published.