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 at GitHub
For information on how to use the mod, visit the Wiki pages at GitHub
For questions and comments, visit my IRC channel, #gigamc at EsperNET or write down in the comments section
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).
There isn't an interface to edit the books ingame WYSIWYG style?
In reply to ProsperCraft:
Not yet. I want to create one, but it will be a huge massive effort. For now you'll have to edit in a text editor and use F3+T to reload assets. I used to have a /gbook reload command in 1.12, but the new command system in 1.13 made it too hard to have client-side commands, so no replacement yet.
Is this capable of showing recipes from things other than the crafting table? Things like furnace recipes, or anything from other mods like special machines, like the recipe handlers that JEI shows/uses?
If not, any chance of adding support for that?
In reply to NFinET:
It has an API to register recipe handlers, but it doesn't support specifically JEI's recipe handlers. By default, it comes with handlers for crafting grid, and furnace.
In the unfinished 1.14 port, I plan on supporting display of any recipe registered through jsons, however proper layout of inputs/outputs will still require custom handlers, I can only display them as if they were crafting grid recipes.
In reply to gigaherz:
I see, what's the syntax for displaying a furnace recipe in a book's xml?
In reply to NFinET:
This should do it (you can pick alternative recipes by specifying index values other than 0):
<recipe type="smelting" index="0">
<recipe.result>
<stack item="minecraft:gold_ingot"/>
</recipe.result>
</recipe>
In reply to gigaherz:
Nice! Thank you very much!
1.14.4 Forge Please :(
In reply to Sepsol:
PLEASE!
In reply to Sepsol:
It WILL happen. I just don't have a date for it. Before I can finish porting the mod, I need to finish the new model loading system I'm writing for forge.
In reply to gigaherz:
Thanks a lot! xD
I can't open books now?
I'm having an incredibly hard time getting the cover to show instead of the book saying, "guidebook" and an image. I've followed the examples, nothing seems to work ;/
Hello,
I was wondering if there was a way to add commands to the book's.
IE: Clickable commands that would use the command when clicked. if not possible way to have clickable commands insta copy to chat?
This was a thing I had on my TODO list but I never added. I could easily add it, it would only take me a few minutes.
I do have a "Copy to clipboard" link, however they will always ask to confirm, as would a "run command" click action, if I implement it.
That said, I guess I could have an option to copy the command to chat, without running it -- the user pressing enter would be confirmation enough...
... and I already wrote the "copyToChat" feature while checking how hard it would be. I'll be testing it and release a small update in a few minutes, if everything goes right. :P
In reply to TheRealGigaherz:
Awesome mate!
That would be really helpful.
I'm really glad this mod exist and that you're active on it :)
There you go, 2.9.2 is up
How to include a custom template/library file? In .../config/books I have two files, a book.xml and a mystandard.xml. But how to include my library file?
<include ref="gbook:xml/mystandard.xml" /> does not work
<include ref="gbook:mystandard.xml" /> does not work
<include ref="gbook:xml/mystandard" /> does not work
<include ref="gbook:mystandard" /> does not work
If the filename is "..../config/books/mystandard.xml", it should just be ref="gbook:mystandard.xml", I'll look into it, maybe it's bugged for config folder loading...
This is now fixed in my local copy, next release will properly load libraries from the config folder.