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
Are there any templates for me to build off of? I'm having a bit of trouble starting from scratch
In reply to 704Prod:
The primary example is the ingame guidebook for guidebook, which showcases most of the features. The XML for it can be found in the mod jar, or in the source repository at https://github.com/gigaherz/Guidebook/blob/master/src/main/resources/assets/gbook/xml/guidebook.xml
If you are not in 1.19 you can see the older versions of the book by changing the branch from the branch dropdown.
In reply to gigaherz:
Is there a way to edit and refresh a guide book in realtime so I can see my edits and make sure they're working? It's a bit difficult when everything is done through an XML
In reply to 704Prod:
you can reload the game assets (F3+T) after editing the xml.
has anyone else had this problem, i've been playing with a bunch of mods and i've recently had problems with guidebook, but i never had it installed only the snapshot kept showing up in my config file. like i said i don't know if anyone else had this issue but its weird.
When I open the custom book, I can't close it again, (exit the book and keep playing the game). How do I exit out of the book?
Once I have opened the book, I can't close it, there is no 'done' button like with regular vanilla books. How do I exit the book and keep playing?
In reply to destructozz1:
There should be an X button on the top left corner?
In reply to gigaherz:
There isn't, is there a key to press to close it like 'e' or something?
In reply to destructozz1:
Escape should work, like in any other gui.
Also, can you show a screenshot?
In reply to gigaherz:
escape worked, thanks so much, i don't know why I didn't try that
This is very neat mod, haven't seen anything like this even tho idea is very simple (at least it seems like it), sorry for asking but is there a small chance for fabric support in the future ?
In reply to driplock:
I don't personally care much about fabric. As a member of the forge development team, I put a lot of effort in making Forge better, so porting to fabric would mean giving up those improvements.
But as I always say, the mod is opensource, I'm not against someone forking the project and making a fabric variant. I just don't want to be doing it myself.
Is furnace recipe display broken in 1.12.2? I get this in example book: https://i.imgur.com/NSGLl80.png
EDIT: ugh, figured it out after greping source code. It's called "smelting" rather than furnace and example book needs a fix.
What would you say are the biggest differences between this and patchouli?
In reply to welpstudent:
I haven't used Patchouli myself, but my understanding is that mod has an ingame visual editor where you can design the book pages. I do not have that, I just have HTML-like syntax.
In reply to gigaherz:
So if I am experienced with html / css coding, this will work the same?
In reply to welpstudent:
Not quite. It's MUCH simpler than html, and has no CSS. It looks a bit like very old html 2/3.
My goal was to make it closer and closer to html, and maybe add some styling system in the future, but for now it's only similar to html, not the same.
Is it possible to optionally make players use a keybind instead of having an item for the guidebook? The fact one could lose it when dying could be a problem.
The MC 1.12.2 server i am trying to connect to is refusing connection due to Guidebook version 2.9.1.s5 is not on the client side. Is there a way I can get a hold of the jar file for that?