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).
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.
In reply to AgentWolfTV:
I want to make one someday, but it's a whole lot of work. 😅
In reply to gigaherz:
This would be realy cool. I tryed to use Enchiridion Mod but i dont understand how i share books. Your mod is much easier.
Hi, it's amazing i will use it for sure ^^ If i may ask... is it possible to have a custom image (png or jpg) in the book? If yes, what is the max resolution?
In reply to evokenmachinima:
Yes! Any size supported by the gpu. But large images would look out of place.
Hold down the Ctrl+click on the wrench in the lower right corner of JEI to switch to Cheat Mode. Search for the guidebook and then you will be able to pull one out directly.
I too am unable to open the "Guide Book".
In reply to ClaudiusMinimus:
I have started an issue regarding getting the demo guidebook.xml working at:
https://github.com/gigaherz/Guidebook/issues/92
Hey There
At first, congrats to your mod. I've been looking through your work and you're definitely not a dabbler. I really like it.
I'm not using "Groundbreaking" and "Overall Changing" mods, so I try to keep it low as I can
Here is my issue: I still don't know, how to create a book.
I mean I've placed the demobook.xml file in the config.
I'm using 1.15.2 - Forge 31.1.14
I'm not able to use the following command in creative mode
Outcome:
I'm also not able to open the "Guide Book"
Hope you can help me out. Thank you for your work!
In reply to saintfkinjimmy:
Starting with 1.13, Minecraft doesn't have metadata values on items anymore, so that 0 number doesn't belong in the command, it's now just
/give @p gbook:guidebook 1 {Book:"gbook:demobook.xml"}Do note however, you should replace `demobook.xml` with your filename.
There isn't an interface to edit the books ingame WYSIWYG style?