Guide-API
Simple library mod for in-game guide creation
Screenshots
About this Mod
Guide-API
Allows modders to easily create in-game documentation.
Modpack developers: Support for building your books through JSON files is in the works.
Books are maintained by Guide-API (it registers them, it puts them in it's own creative tab, etc)
All the author does is send us the information and we take care of the rest.
See the gallery for examples.
If you wish to use this in your project, read here.
Modpack Permissions
Go for it.
Legacy Information
As of build 2.1.0-51 for Minecraft version 1.11.2 (released on March 22, 2017), the license has been changed from MMPLv2 to MIT. Any build prior to that still uses MMPLv2 which you can view here
Archival notice
This mod is abandoned and has been uploaded for archival purposes. It was originally created by TehNut on Mar 23, 2015. It has been uploaded to Modrinth under the ModrinthArchives account with permission from the original author.
Available Versions
How to Install Guide-API on Your Server
Order Server
Order a Minecraft Java server with at least 3 GB RAM (4 GB recommended).
Set forge Loader
In the panel under "Egg", select the forge loader and matching Minecraft version (1.12.2).
Install Mod
Open the mod browser in the dashboard and search for "Guide-API". Click "Install" – done! Alternatively, upload the .jar via SFTP to the /mods folder.
Compatibility
Mod Loaders
Minecraft Versions
1.12.2, 1.12.1, 1.12 (+9 more)
Server-side
✓ RequiredRecommended RAM
4 GB(min. 3 GB)Frequently Asked Questions
Guide-API server crashes on startup – what to do?
Most common cause: wrong forge version or insufficient RAM. Check the server log (latest.log) for "OutOfMemoryError" or "Mixin" errors. With Mado Hosting: ensure at least 3 GB RAM is allocated and the loader matches the mod version (1.12.2). You can switch loaders with one click in the panel.
Is Guide-API compatible with forge?
Guide-API officially supports forge for Minecraft 1.12.2, 1.12.1, 1.12. The Mado dashboard automatically detects incompatible loader combinations.
Server lagging with Guide-API – how to optimize performance?
Recommended RAM: 4 GB (per 8 players). Use /spark profiler to check if Guide-API consumes the most tick time. Common fixes: reduce server view-distance to 8-10, install "performant" or "starlight" as supplementary mods on Forge. With Mado Hosting, your server runs on NVMe SSDs with dedicated CPU cores for minimal latency.
Similar Mods
Rent Modded Server
Install Guide-API with just one click on your server.