Guidebook

WARNING: The 1.15.2 release has a known issue. I did my best to make it work from the mod side, but it will require fixing from Forge’s end, as there’s nothing else I can do.
NOTICE: The 1.14.4 port depends on the new model loading system which hasn’t been merged yet. If it ever gets merged, I’ll release soon after. If not, you’ll have to move straight to 1.15.2.

What is Guidebook?

Guidebook is a library/mod that adds customizable books.

You can add books through mods, resource packs, or using the configuration folder.

If you used the mod for your mod’s documentation or a modpack / adventure map, and want it mentioned here, feel free to tell me and I’ll be glad to check it out!

How to create and add books

Visit the wiki pages for detailed explanation about the XML file structure and where to place the files.

Supported features

• XML-based book files
  • Includes support for alternative localized books
• Book-style hierarchy inspired by HTML but adapted for Minecraft’s content
  • book > chapters > sections > paragraphs > spans
  • supports formatted text, images and item stacks
• Automatic flow layout of text and images inside paragraphs (inline style only)
• Automatic pagination of sections
• Element conditions: hide chapters, sections or paragraphs based on mod presence or Game Stages
• Template system: allows reusing common book structures
• Recipe support: allows displaying recipes by output item or recipe name
• Hyperlinks: navigate within the book, open web URLs, or copy text to the clipboard.

Planned/wanted features

From most likely to most crazy:

• Server-provided book content.
• The ability to bind links to commandblock commands.
• The 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 more features!

Can I use this in <X>?

Yes. Unless <X>’s license is incompatible with this mod’s, which is unlikely.

Help and Support

For bug reports and feature requests, visit the issue tracker (link above)

You can also find me on discord, in my little discord server (please use the support forum channels! DO NOT DM me unless strictly necessary). 

I’ve got a Patreon!

Help me continue making games and mods! Click here