ModsFinder

Guide-API VP

by maxanier

Guide-API VP is a Forge and NeoForge library that provides a code-based guide book framework, which other mods use to build in-game books.

ForgeNeoForgeClient and serverMIT LicenseOpen source1.16.4 – 26.1.2

What it does

Guide-API VP lets a mod author define a guide book in code. Book content can change with the configuration of the mod that owns it, and constants or balancing values referenced from the mod update automatically inside the book when they change. Lines and pages are wrapped automatically so localized strings do not overflow, and text can use formatting codes and manual line breaks.

The library is a fork carried on under the MIT License. It uses its own package and mod identifier, guideapi-vp. It has no hard dependency: if Guide-API VP is missing at runtime the book is simply absent, and the rest of the mod keeps working. Environment is client and server, so the server and every player need it. Files are published for Forge and NeoForge across 15 release versions, 1.16.4 – 26.1.2.

Key features

  1. Configuration-driven content

    Book entries can be added or changed according to the configuration of the owning mod.

  2. Automatic text wrapping

    Lines and pages are wrapped by the library, so translated strings fit the page without manual splitting.

  3. Live constant references

    Internal constants and balancing values referenced in the book update when the mod changes them.

  4. Custom page and recipe types

    Authors can register their own page types and recipe types for use in the book.

  5. Ready-made page types

    Text, item or block focused text, recipe and image pages are available without writing new code.

Compatibility

Latest build for each game version and loader.

26.x1 of 1 version with builds
26.1.2Not available26.1.2-3.0.0-beta.1
1.21.x2 of 2 versions with builds
1.21.1Not available1.21.1-2.3.0
1.21Not available1.21-2.3.0-beta.1
1.20.x3 of 3 versions with builds
1.20.6Not available1.20.6-2.3.0
1.20.11.20.1-2.2.6Not available
1.201.20-2.2.6-alpha+20230609-2303Not available
1.19.x4 of 4 versions with builds
1.19.41.19.4-2.2.6Not available
1.19.31.19.3-2.2.5Not available
1.19.21.19.2-2.2.4Not available
1.191.19-2.2.4-beta.1Not available
1.18.x2 of 2 versions with builds
1.18.11.18.1-2.2.3Not available
1.181.18-2.2.3-alpha+20211201-2224Not available
1.17.x1 of 1 version with builds
1.16.x2 of 2 versions with builds
ReleaseBetaAlphaNot available

Only full game releases are shown. This mod publishes no snapshot builds.

How it compares

Full comparison

GuidebookAPI is a Fabric and NeoForge library for 1.20.6, released under the MIT License and open source. GuideNH is a Forge-only library for 1.7.10 under the GNU Lesser General Public License v3.0 only, and is open source. Guide-API VP covers Forge and NeoForge across 1.16.4 – 26.1.2 under the MIT License, so the two differ in loader and version range.

ModLoadersGame versionsEnvironmentUpdated
Guide-API VPForge and NeoForge1.16.4 – 26.1.2Client and server2026-05-10
GuidebookAPIFabric and NeoForge1.20.6Client and server2024-06-04
GuideNHForge1.7.10Client and server2026-07-12

Questions

Does Guide-API VP need to be installed on a server?

Yes. Installation covers the server and each player's game.

Which loader should a mod author target for Guide-API VP?

Builds exist for both Forge and NeoForge, with Forge 1.20.1-2.2.6 for 1.20.1 and NeoForge 26.1.2-3.0.0-beta.1 for 26.1.2 as the latest files.

What happens if Guide-API VP is removed?

The book is not present at runtime, but the other content of the mod that uses it continues to work, because the library is not a hard dependency.

In the catalog

Guide-API VP is one of 3,514 Library mods on ModsFinder, and one of 1,576 Library mods for Forge. 15,189 mods support Minecraft 26.1.2.

More from maxanier

All projects

Similar mods

What the author says

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). What else? - No hard dependency, if Guide-API is not present at runtime the book won't be there, but…
maxanier, on the Modrinth page

Official listing

Owner
maxanier
Published
2021-06-26
Updated on Modrinth
2026-05-10
Facts verified
2026-10-15

Tags