Guide-API Village and Pillage

Description

Guide-API-VP

This is a fork of the original mod Guide-API by TehNut and Tombenpotter released under the MIT license.
It uses a different package and a different modid (guideapi-vp).

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

Mods using this:

• Vampirism

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.

What means Verified?

• Compatibility: The mod should be compatible with the latest version of Minecraft and be clearly labeled with its supported versions.
• Functionality: The mod should work as advertised and not cause any game-breaking bugs or crashes.
• Security: The mod should not contain any malicious code or attempts to steal personal information.
• Performance: The mod should not cause a significant decrease in the game's performance, such as by causing lag or reducing frame rates.
• Originality: The mod should be original and not a copy of someone else's work.
• Up-to-date: The mod should be regularly updated to fix bugs, improve performance, and maintain compatibility with the latest version of Minecraft.
• Support: The mod should have an active developer who provides support and troubleshooting assistance to users.
• License: The mod should be released under a clear and open source license that allows others to use, modify, and redistribute the code.
• Documentation: The mod should come with clear and detailed documentation on how to install and use it.

How to Install