Guide-API Village and Pillage
This project is a fork of the original Guide-API mod created by TehNut and Tombenpotter, distributed under the MIT license. The main difference lies in the use of a different package and unique identifier (guideapi-vp).
This tool significantly simplifies the process of creating in-game guides for your mods. The system automatically registers books, places them in a special creative tab, and manages their display.
Unlike solutions such as Patchouli, which primarily work with JSON, Guide-API-VP is code-oriented, providing developers with several advantages:
- Dynamic content changes depending on your mod's configuration
- Automatic text formatting and pagination for correct display of localized strings
- Ability to reference assigned control keys
- Use of internal constants and balancing values that automatically update in the book when changed in the mod
- Creation of custom page types, recipes, and other elements
- Helper methods for automatic generation of guide sections
Additional Features
- No hard dependencies: if Guide-API is not installed, the book simply won't be displayed, but the rest of the mod's functionality remains
- Support for TextFormatting and manual line break management
- Ready-made page templates: text, item/block focused, recipes, and images
Mods Using This Library
- Vampirism
Licensing
MIT license allows free creation of forks and inclusion of the library in your modpacks.