Guide-API VP
maxanier
458.251 downloads · 27 followers
Minecraft: Minecraft 1.16.4 – 1.21.1
Runs on: Client & server
Kategori: library, utility
Compatibility by loader
- neoforge1.20 – 1.21· Latest 1.21.1-2.3.0 (11 Ağu 2024)
- forge1.16 – 1.20· Latest 1.20.1-2.2.6 (15 Eki 2023)
Overview
Guide-API-VP aka Village and Pillage
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).
For modders:
About
Allows easy creation of a guide book for your mod. Books are mostly maintained by Guide-API (it registers them, it puts them in it's own creative tab, etc).
The guide book is created mostly in code whereas e.g. Patchouli is mostly JSON based. This means:
- Add or change content based on the configuration of your mod.
- Wrap lines and pages based automatically, so localized strings don't overflow
- Refer to the set keybindings
- Refer to internal constants, balancing values etc so they are automatically changed in the book if you change them in the mod
- Add custom page types, recipe types, etc.
- Use helper methods to generate parts of the book automatically
What else?
- No hard dependency, if Guide-API is not present at runtime the book won't be there, but everything else works
- Use TextFormatting and manual \n
- Several ready-to-use page types like text, item/block focused text, recipe, and image pages
How to use for your own mod:
https://github.com/maxanier/Guide-API#developer-information
Credits
Original Mod: TehNut and Tombenpotter Fork: Maxanier
Licence
MIT license, so if necessary you can create a fork. Also feel free to include it in your modpack.
Modrinth modrinth
indexable