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, ID @gigaherz#9173 on the Forge Discord and Minecraft Mod Development servers (please DO NOT DM me unless strictly necessary).
You can also find me on Guilded.gg! I created a server there as an experiment, to see how the app works. I can't ensure that it will be a permanent place.
I've got a Patreon!
Help me continue making games and mods! Click here
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?
In reply to Daichi_Lu_Azure:
That doesn't look like any version I have released. What is the full error message? There's at least one mod that forked Guidebook to change it to their needs
In reply to gigaherz:
im looking into it right now on solving the issue for daichi on the modpack were on i think there a mod conflicting somewhere
Hi gigaherz,
Cool mod. I'm testing it on our server's mod pack. I was able to add a book to the config directory. I don't know where to add the commands to have a book spawn for all players. I can't find a config file. I'm running forge 1.16. Thank you for any help you can provide.
In reply to ralonsoc:
Hi, there should be a guidebook-server.toml in the save directory, inside serverconfigs. eg, world/serverconfigs/guidebook-server.toml
how do i get version 2.9.1.s5? it for some reason is needed for a server im playing on
In reply to neondogeon:
I don't have any version with that name. It may be an unofficial build, in which case you'd have to ask the server.
In reply to gigaherz:
which server?
In reply to neondogeon:
I don't know? YOU said "for some reason is needed for a server im playing on", how am I supposed to know?
I've used this mod back in 1.12 and noticed there is no longer a place in the config file to give yourself a book in 1.16.1
S:giveOnFirstJoin <
>
}
There is no longer this method in the mods.toml file for the gbook.
Need an ingame editor so much :(
Ive been searching gbook that rockhounding requires, is this the right one?
In reply to sandytigley:
This mod's modid is certainly gbook (guidebook was used by someone else and I didn't want to risk conflicts), but I don't see anything in rockhounding that indicates it requires a "gbook" mod, either this one or any other.
In reply to gigaherz:
Oh! nevermind, I just saw in the rockhounding-chemistry page, it does link to this one.
In reply to gigaherz:
Yeah, this is the gbook rockhounding is looking for, anyway thanks im on the mod now...
love the mod. Is it possible to use url in the book to external site/discord or does the linking only work within the book itself.
In reply to ktole1999:
You can use href="http://..." in the link element, instead of ref. This will tell it to make the link open a web browser.
The idea seems flawless but unfortunately it is extremely confusing to a non programmer. i can usually figure things out just by editing existing files. but the config files appear to have nothing to do with the contents of the book and the "books" folder is empty. and the documentation doesn't clearly state how to make a book. it gives plenty of information on the context of the file but i cant seem to find anything on the basics, like where does the text doc go. i assume in the "books" folder but does it go in the resource folder? or is that intended for images for the books. i just dont know because basic information is lacking. I would love to understand how the mod works and how to use the mod effectively but the wiki skips step 1
In reply to Sleepy_CA:
I will admit that I'm not good at writing documentation. I have an examples folder in the source code repository. See: https://github.com/gigaherz/Guidebook/tree/master/examples
Is there any editor to create a book easier? A ingame editor would be realy cool.