Guide-API VP
This version represents a fork of the original Guide-API mod created by TehNut and Tombenpotter, adapted for Minecraft 1.14 (Village and Pillage update) and later versions. The project is distributed under the MIT license and uses the unique identifier guideapi-vp.
For Mod Developers
Core Features
The library significantly simplifies the process of creating guides and references for your mods. Unlike solutions like Patchouli that primarily rely on JSON configurations, here the book is formed through program code, which offers the following advantages:
- Dynamic content changes based on your mod's settings
- Automatic text formatting and page breaks for correct display of localized strings
- Ability to reference assigned control keys
- Use of internal constants and balance values - when they change in the mod, the book content updates accordingly
- Creation of custom page types, recipes, and other elements
- Helper methods for automatic generation of individual book sections
Additional Features
- No hard dependency - if Guide-API is not installed, the book simply won't be available, but the rest of the mod's functionality will continue to work
- Support for TextFormatting and manual line break management
- Ready-made page templates: text, item/block focused, recipes, and images
Getting Started
Detailed documentation for developers is available in the project repository on GitHub.
Authorship
Original development: TehNut and Tombenpotter
Fork and maintenance: Maxanier
Licensing
The project is distributed under the MIT license, allowing free creation of forks and inclusion in modpacks.
