Opus (Guidebooks)

Minecraft Versions

• 26.2: supported

Opus is a documentation mod. A book is just a folder of Markdown files in a resource pack, so there is no Java and no JSON to write. Folders become chapters, files become pages, and an index.md introduces its chapter.

Current Features

• Table of contents sidebar with search, back history, and previous/next buttons
• CommonMark with tables, strikethrough, task lists, and callouts
• YAML frontmatter for titles, icons, ordering, tags, hidden pages, and advancement-gated pages
• Links between pages that are checked when the book loads
• Recipe, item, and mob widgets written as fenced blocks
• Translations that fall back to the book's default language
• A validator that finds broken links and bad widgets before your players do

Planned Features (in no particular order)

• Tabs, accordions, etc
• Custom theming / skins for books
• Tag index pages
• Bookmarks
• Multi-block preview widget
• Advancement-gated content

Issues & Suggestions

Please use the GitHub issue tracker to report any bugs you find or suggest new features.

Credits

Obviously this mod would not be possible if not for the people at Mojang making an awesome game. Thanks also go to the developers of the Fabric and NeoForge mod loaders and the Architectury API.

Beyond those groups, huge credit goes to Vazkii and others who came before and created great mods like Patchouli, Modnomicon, and others.

License

This mod is released under the MIT license. The full text of the license can be found here.