Guidebook

What is Guidebook?

Guidebook is a library and mod for Minecraft that allows creating customizable books with various content. You can add your own books through mods, resource packs, or using the configuration folder.

If you used this mod for your mod's documentation, modpack, or adventure map and want it mentioned here, be sure to let me know - I'll be glad to check it out!

Creating and Adding Books

For detailed information about XML file structure and file placement, visit the wiki pages.

Supported Features

• XML-based book files
  • Support for alternative localized books
• Book-style hierarchy inspired by HTML but adapted for Minecraft
  • book → chapters → sections → paragraphs → elements
  • support for formatted text, images, and items
• Automatic flow layout of text and images within paragraphs
• Automatic pagination of sections
• Element conditions: hiding chapters, sections, or paragraphs based on mod presence or Game Stages
• Template system: allows reusing common book structures
• Recipe support: displaying recipes by output item or recipe name
• Hyperlinks: navigation within the book, opening web URLs, or copying text to clipboard

Planned Features

From most likely to more complex:

• Server-provided book content
• Ability to bind links to command block commands
• Ability to listen for link clicks and handle them from other mods
• In-book search and index
• Bookmarks
• Quest-tracking features and achievement display
• Page-flip animation

Feel free to suggest additional features!

Can I use this in ?

Yes. Unless 's license is incompatible with this mod's license, which is unlikely.

Help and Support

For bug reports and feature requests, visit the issue tracker.

You can also find me on Discord on my small server (please use the support forum channels! Do not send direct messages unless strictly necessary).