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'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.
is it posible to make a image clickable like an link?
<link ref="Genesis"><image src="gbook:genesis" tw="192" th="70"/></link>
this doesn't work?!?
Hmpf. It's supposed to, I'll have to look into it.
In reply to gigaherz:
Oh, I was wrong.
Seems I never actually implemented support for making images linkable
In reply to gigaherz:
it would be nice if this would be implemented. thnk you very much.
In reply to MSandro:
It is already implemented in my working copy. Next release (soon, I have some glitches to debug), will include images in links.
Hello again!
I'm running a survival server to play with my friends, and we use many mods.
So there are too many new recipes from the mods, (especially harvestcraft mod)
so I want to make the guidebook for harvestcraft craftable for my friends.
Can I add a custom guidebook recipe?? If I can, how can i add it?
sorry for my bad english
Thank you again. your mod is awesome
In reply to 0nthesky:
I've been getting better at making guides with recipes, and if you tell me some mods you want to use, I can work on making guides for those (and show you the files in progress, to help you learn how to make them).
I haven't found an existing guide for HarvestCraft. There's a wiki that lists items, but I'm not sure about recipes. I would like to put at least some of the recipes in a book that you can read in the game. When you want to make something, you would pick up the book and turn to the page that has the recipe you want to make.
I made books like this for StorageDrawers and TheCampingMod. I'm working on books for IndustrialCraft2 and BiblioCraft.
In reply to 0nthesky:
<big_recipe type="shaped"> <stack item="minecraft:iron_ingot" /> <stack item="minecraft:iron_ingot" /> <stack item="minecraft:iron_ingot" /> <space/> <stack item="minecraft:stick" /> <space/> <space/> <stack item="minecraft:stick" /> <space/> <stack item="minecraft:iron_pickaxe" /> </big_recipe>The first 3 items are in the top row of the crafting table, the next 3 in the middle row, the next 3 in the bottom row, and the last item is the result of the crafting process.
I can use this template to show recipes from most mods. If I know the mod id and the item name, I can show its recipe in my guidebook. But this is not about making new recipes.
Do you want to make a custom book for recipes that already exist for game items? Or make a new custom recipe for game items?
Hello!
Can I add a custom book cover image? Like, blue book cover, not the original brown book cover one??
thank you.
In reply to 0nthesky:
I have considered it, but it would be a bit complicated to implement. My best idea was to make the cover image gray, and apply a custom book-provided tint, with the brown being the default. Someday I'll get around to it.