Description
Gallery
Changelog
Versions
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.
All Versions
+ Add Version| Name | Game version | Platforms | Published | Downloads | Actions |
|---|---|---|---|---|---|
| 12h ago | 1 | ||||
| 12h ago | 1 | ||||
| 12h ago | 1 | ||||
| 12h ago | 1 | ||||
| 12h ago | 1 | ||||
| 12h ago | 1 | ||||
| 12h ago | 1 | ||||
| 12h ago | 1 | ||||
| 12h ago | 1 | ||||
| 12h ago | 1 | ||||
| 12h ago | 1 | ||||
| 12h ago | 1 | ||||
| 12h ago | 1 | ||||
| 12h ago | 1 | ||||
| 12h ago | 1 | ||||
| 12h ago | 1 | ||||
| 12h ago | 1 | ||||
| 12h ago | 1 | ||||
| 12h ago | 1 | ||||
| 12h ago | 1 | ||||
| 12h ago | 1 | ||||
| 12h ago | 1 | ||||
| 12h ago | 1 | ||||
| 12h ago | 1 | ||||
| 12h ago | 1 | ||||
| 12h ago | 1 | ||||
| 12h ago | 1 | ||||
| 12h ago | 1 | ||||
| 12h ago | 1 | ||||
| 12h ago | 1 | ||||
| 12h ago | 1 | ||||
| 12h ago | 1 | ||||
| 12h ago | 1 | ||||
| 12h ago | 1 | ||||
| 12h ago | 1 | ||||
| 12h ago | 1 | ||||
| 12h ago | 1 | ||||
| 12h ago | 1 | ||||
| 12h ago | 1 | ||||
| 12h ago | 1 | ||||
| 12h ago | 1 | ||||
| 12h ago | 1 | ||||
| 12h ago | 1 | ||||
| 12h ago | 1 | ||||
| 12h ago | 1 | ||||
| 12h ago | 1 | ||||
| 12h ago | 1 | ||||
| 12h ago | 1 | ||||
| 12h ago | 1 | ||||
| 12h ago | 1 | ||||
| 12h ago | 1 | ||||
| 12h ago | 1 | ||||
| 12h ago | 1 | ||||
| 12h ago | 1 | ||||
| 12h ago | 1 | ||||
| 12h ago | 1 |
[1.12-2.1.8-63] Guide-API-1.12-2.1.8-63
by ModrinthArchives on Oct 15, 2026
Download
<p>Version 2.1.8:</p><p>- Return to the page an entry is on when backing out of it<br>- When opening the search GUI, auto-focus the search bar<br>- Fix json recipe renderer spamming the log<br>- Hide categories if they're empty<br>- Add search button to all views</p>
[1.12-2.1.5-58] Guide-API-1.12-2.1.5-58
by ModrinthArchives on Oct 15, 2026
Download
<p>* TehNut: Switch to instanceof for finding the recipe renderer (#92) (#93)<br>* TehNut: Improved error handling for PageIRecipe (#94)<br>* TehNut: Soft override a future Forge feature<br> * Guides should now show up when searching for the owning mod in JEI<br>* TehNut: Fixed crash when getting sub items when creative tab was null (#97)<br>* TehNut: Add a builder for book instances<br>* TehNut: Switch search button to the magnifying glass @Elucent made me like</p>
[1.12-2.1.4-57] Guide-API-1.12-2.1.4-57
by ModrinthArchives on Oct 15, 2026
Download
<p>The-Fireplace: Updated README (#88)<br>The-Fireplace: Added PageJsonRecipe, removed PageIRecipe#fromJson (#91)<br>TehNut: Ran formatter<br>TehNut: De-lombok</p>
[1.12-2.1.4-56] Guide-API-1.12-2.1.4-56
by ModrinthArchives on Oct 15, 2026
Download
<p>nick: Added a way to make a PageIRecipe from a ResourceLocation. Closes #80<br>nick: Added priority handling. Closes #81 (#83)<br>speedynutty68: Fixed issues with registry system ordering (#77)<br>speedynutty68: Update version<br>speedynutty68: fuck javadocs right now<br>speedynutty68: delete everything related to javadocs</p>
[1.11.2-2.1.4-56] Guide-API-1.11.2-2.1.4-56
by ModrinthArchives on Oct 15, 2026
Download
<p>speedynutty68: IGuideLinked now displays a HUD element<br>speedynutty68: Allow custom display titles for recipe renderers<br>speedynutty68: Sanity check page number (#70)<br>speedynutty68: Added priority handling. Closes #81 (#83)<br>speedynutty68: Update version</p>
[1.12-2.1.3-55] Guide-API-1.12-2.1.3-55
by ModrinthArchives on Oct 15, 2026
Download
<p>TehNut: Updated to new Forge registry system</p>
[1.11.2-2.1.1-52] Guide-API-1.11.2-2.1.1-52
by ModrinthArchives on Oct 15, 2026
Download
<p>- Added ability for mod authors to specify which Creative Tab their book should display in (the-rogue)<br>- Updated some of the UI element assets to be prettier (InsomniaKitten)<br>- Added a default implementation for a Brewing Recipe page (Lothrazar)<br>- Fixed (finally) the version replacement system. No more @VERSION@ in your crash logs and other places.</p>
[1.11-2.1.0-51] Guide-API-1.11-2.1.0-51
by ModrinthArchives on Oct 15, 2026
Download
<p>TehNut: Proper method of giving an item to a player<br>TehNut: Relicense to MIT<br>TehNut: Implemented a basic search system</p>
[1.11-2.1.0-50] Guide-API-1.11-2.1.0-50
by ModrinthArchives on Oct 15, 2026
Download
<p>TehNut: Allow for much cleaner category setup<br>TehNut: Proper default return for IItemColor<br>TehNut: Remove sided-ness of setUnicodeFlag<br>TehNut: Fixed 2 bugs (#55)</p>
[1.10.2-2.0.3-46] Guide-API-1.10.2-2.0.3-46
by ModrinthArchives on Oct 15, 2026
Download
<p>speedynutty68: Add support for running things on mapping<br>speedynutty68: Fixed 2 bugs (#55)<br>noreply: Update version</p>
[1.11-2.1.0-49] Guide-API-1.11-2.1.0-49
by ModrinthArchives on Oct 15, 2026
Download
<p>TehNut: Protect against possible null when getting book stack (#58)<br>TehNut: Fix version replacement<br>TehNut: Fix NPE with info renderer (#59)</p>
[1.11-2.1.0-47] Guide-API-1.11-2.1.0-47
by ModrinthArchives on Oct 15, 2026
Download
<p>speedynutty68: Remove reequip animation code as it seems a bit broken<br>speedynutty68: Exclude test package from live builds<br>speedynutty68: Add IInfoRenderer<br>speedynutty68: Parameter renaming<br>speedynutty68: Update version</p>
[1.9.4-2.0.1-44] Guide-API-1.9.4-2.0.1-44
by ModrinthArchives on Oct 15, 2026
Download
<p>speedynutty68: Fix startup crash for realz this time</p>
[1.9.4-2.0.1-43] Guide-API-1.9.4-2.0.1-43
by ModrinthArchives on Oct 15, 2026
Download
<p>speedynutty68: Fix crash at startup speedynutty68: Mark 1.10 as compatible</p>
[1.9.4-2.0.0-42] Guide-API-1.9.4-2.0.0-42
by ModrinthArchives on Oct 15, 2026
Download
<p>speedynutty68: Cause informative crash if guide is registered too late speedynutty68: Draw stacksize text and/or damage bar on itemstacks #42 speedynutty68: Should (?) fix wildcard meta item rendering #43</p>
[1.9.4-2.0.0-40] Guide-API-1.9.4-2.0.0-40
by ModrinthArchives on Oct 15, 2026
Download
<p>speedynutty68: Revert "Allow scaling of text" speedynutty68: Helper method to set unicode flag for list of pages.</p>
[1.9.4-2.0.0-38] Guide-API-1.9.4-2.0.0-38
by ModrinthArchives on Oct 15, 2026
Download
<p>speedynutty68: Opening the GUI from mainhand should not use offhand item</p>
[1.9.4-2.0.0-37] Guide-API-1.9.4-2.0.0-37
by ModrinthArchives on Oct 15, 2026
Download
<p>speedynutty68: Fix IGuideLinked</p>
[1.9.4-2.0.0-36] Guide-API-1.9.4-2.0.0-36
by ModrinthArchives on Oct 15, 2026
Download
<p>speedynutty68: Clean up the main class a bit<br>speedynutty68: Allow users to override individual book spawn settings<br>speedynutty68: Cut off entry text if it runs off the page<br>speedynutty68: Display full entry name when hovered over<br>speedynutty68: Guide model should inherit values from parent<br>speedynutty68: Deprecated GuideRegistry should register correctly</p>
[1.9.4-2.0.0-35] Guide-API-1.9.4-2.0.0-35
by ModrinthArchives on Oct 15, 2026
Download
<p>speedynutty68: Reduce space between lines<br>speedynutty68: Fixed unescaping with localized strings</p>
[1.9.4-2.0.0-34] Guide-API-1.9.4-2.0.0-34
by ModrinthArchives on Oct 15, 2026
Download
<p>speedynutty68: Move PageSound to SoundEvent<br>speedynutty68: More formatting control for default text pages</p>
[1.9.4-2.0.0-33] Guide-API-1.9.4-2.0.0-33
by ModrinthArchives on Oct 15, 2026
Download
<p>speedynutty68: Update to 1.9.4<br>speedynutty68: Fix third person held item rendering (#29)<br>speedynutty68: Fix NPE after modifying registered books</p>
[1.9-2.0.0-32] Guide-API-1.9-2.0.0-32
by ModrinthArchives on Oct 15, 2026
Download
<p>speedynutty68: Reversing wasn't an actual problem<br>speedynutty68: Fix allowing scroll when page size is 0<br>speedynutty68: Fix crash if book attempts to open non-existent page</p>
[1.9-2.0.0-31] Guide-API-1.9-2.0.0-31
by ModrinthArchives on Oct 15, 2026
Download
<p>speedynutty68: Massive refactors + move to Forge persistent registry<br>speedynutty68: Fix NPE in registry<br>speedynutty68: Move constants to main mod class<br>speedynutty68: Move entries to a map<br>speedynutty68: If no author is set, display owner modid if advanced tooltips<br>speedynutty68: Fix ordering on entry display<br>speedynutty68: Fix wildcard usage in recipe renders<br>speedynutty68: Pass 1 at cleaning up the JSON system<br>speedynutty68: Remove raw GL calls from buttons<br>speedynutty68: Fix lighting issues when main hand was rendered<br>speedynutty68: Another case of the lighting issue<br>speedynutty68: Run formatter<br>speedynutty68: Fix syncing of current page<br>speedynutty68: Decrease registry size<br>speedynutty68: Merge GuiHomeNew into GuiHome</p>
[1.7.10-1.0.1-29] Guide-API - 1.0.1-29
by ModrinthArchives on Oct 15, 2026
Download
<p>Nick: Fix tooltips being added to null books (#24)</p>
[1.8.9-2.0.0-28] Guide-API-1.8.9-2.0.0-28
by ModrinthArchives on Oct 15, 2026
Download
<p>Nick: Some method cleanup<br>Nick: Some localization changes</p>
[1.8.9-2.0.0-27] Guide-API-1.8.9-2.0.0-27
by ModrinthArchives on Oct 15, 2026
Download
<p>Nick: Initial update to 1.8.8<br>Nick: Rendering for items<br>Nick: Generics and some unloc name changes<br>Nick: Initial 1.8.9 version done-ish<br>Nick: Update CurseGradle version</p>
[1.8-2.0.0-26] Guide-API-1.8-2.0.0-26
by ModrinthArchives on Oct 15, 2026
Download
<p>This is an API breaking change. Hence the major version number increase.</p>
<p>Nick: Fix buildscript</p>
<p>Nick: Fix buildscript</p>
[1.7.10-1.0.1-23] Guide-API - 1.0.1-23
by ModrinthArchives on Oct 15, 2026
Download
<p>Nick: Update Forge, upgradle, update build status url Nick: Fix z-level issues with tooltips</p>
[1.7.10-1.0.1-22] Guide-API - 1.0.1-22
by ModrinthArchives on Oct 15, 2026
Download
<p>tterrag1098: Fix category tooltip causing lighting bug</p>
<p>tterrag1098: Fix default recipe renderers using incorrect titles (#15)</p>
<p>speedynutty68: Update build status URL</p>
<p>Nick: Example book is now a JSON version of
<p>Nick: Shorten JSON example to 1100 lines >.></p>
<p>Nick: Button hover offset is less jarring</p>
<p>Nick: Entry hover offset is less jarring</p>
<p>Nick: Forgot about the other Entry class</p>
<p>Nick: YABEA (Yet Another Better Entry Animation)</p>
<p>Nick: Begin work on a better looking home page</p>
<p>Nick: Some Gui QoL improvements</p>
<p>Nick: Clean up base entries and add some new ones</p>
<p>Nick: Clean up base pages</p>
<p>Nick: Book item now requires you to shift click on the block to view</p>
<p>verybigbro: Create ru_RU.lang</p>
<p>tterrag1098: Fix default recipe renderers using incorrect titles (#15)</p>
<p>speedynutty68: Update build status URL</p>
<p>Nick: Example book is now a JSON version of
TestBook.java</p>
<p>Nick: Shorten JSON example to 1100 lines >.></p>
<p>Nick: Button hover offset is less jarring</p>
<p>Nick: Entry hover offset is less jarring</p>
<p>Nick: Forgot about the other Entry class</p>
<p>Nick: YABEA (Yet Another Better Entry Animation)</p>
<p>Nick: Begin work on a better looking home page</p>
<p>Nick: Some Gui QoL improvements</p>
<p>Nick: Clean up base entries and add some new ones</p>
<p>Nick: Clean up base pages</p>
<p>Nick: Book item now requires you to shift click on the block to view</p>
<p>verybigbro: Create ru_RU.lang</p>
