Guide-API
Modby TehNut
Simple library mod for in-game guide creation
Type
Mod
CurseForge Downloads
83,158,568
CurseForge ID
228832
Modrinth Downloads
386,363
Modrinth ID
w5L2PHJU
Last Updated
Jun 11, 2026
Description
# Guide-API-VP aka Village and Pillage
This is a fork of the original mod Guide-API by TehNut and Tombenpotter released under the MIT license for 1.14 (Village and Pillage) and above.
It uses a different package and a different modid (guideapi-vp).
## For modders:
### About
Allows easy creation of a guide book for your mod.
Books are mostly maintained by Guide-API (it registers them, it puts them in it's own creative tab, etc).
The guide book is created mostly in code whereas e.g. Patchouli is mostly JSON based. This means:
- Add or change content based on the configuration of your mod.
- Wrap lines and pages based automatically, so localized strings don't overflow
- Refer to the set keybindings
- Refer to internal constants, balancing values etc so they are automatically changed in the book if you change them in the mod
- Add custom page types, recipe types, etc.
- Use helper methods to generate parts of the book automatically
What else?
- No hard dependency, if Guide-API is not present at runtime the book won't be there, but everything else works
- Use TextFormatting and manual \n
- Several ready-to-use page types like text, item/block focused text, recipe, and image pages
### How to use for your own mod:
https://github.com/maxanier/Guide-API#developer-information
## Credits
Original Mod: TehNut and Tombenpotter
Fork: Maxanier
## Licence
MIT license, so if necessary you can create a fork.
Also feel free to include it in your modpack.
Compatibility
Mod Loaders
Forge
Neoforge
Game Versions
1.16.4
1.16.5
1.17.1
1.18
1.18.1
1.19
1.19.2
1.19.3
1.19.4
1.20
+5 more
Screenshots
Similar Mods
Just Enough Items (JEI)
View Items and Recipes
Mod
637,313,030
Mouse Tweaks
Enhances inventory management by adding various functions to the mouse buttons.
Mod
498,540,070
Cloth Config API (Fabric/Forge/NeoForge)
Config Screen API for Minecraft
Mod
476,548,632
AppleSkin
Adds some useful information about food/hunger to the HUD
Mod
462,665,967
GeckoLib
A 3D animation library for entities, blocks, items, armor, and more!
Mod
414,632,938
Controlling
Adds a search bar to the Key-Bindings menu
Mod
406,933,839
Included in Modpacks
verdant dreams
Trusted Modded
HexCraft