Mods
Resource Packs
Data Packs
Modpacks
Shaders
Plugins
Mods Resource Packs Data Packs Plugins Shaders Modpacks
Get Modrinth App Upgrade to Modrinth+
Sign in
ModsPluginsData PacksShadersResource PacksModpacks
Sign in
Settings
Guide-API VP

Guide-API VP

Flexible code based guide book

86.2k
18
Library
Utility
AboutChangelogVersions

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.

90% of ad revenue goes to creators

Support creators and Modrinth ad-free with Modrinth+

Compatibility

Minecraft: Java Edition

1.21.x
1.20.6
1.20–1.20.1
1.19.2–1.19.4
1.19
1.18–1.18.1
1.17.1
1.16.4–1.16.5

Platforms

Forge
NeoForge

Supported environments

Client and server

Links

Report issues View source

Creators

maxanier
maxanier Owner

Details

Licensed MIT
Published 4 years ago
Updated 10 months ago

Modrinth is open source.

main@656c5b6

© Rinth, Inc.

Company

TermsPrivacyRulesCareers

Resources

SupportBlogDocsStatus

Interact

Discord X (Twitter) Mastodon Crowdin
Get Modrinth App Settings
NOT AN OFFICIAL MINECRAFT SERVICE. NOT APPROVED BY OR ASSOCIATED WITH MOJANG OR MICROSOFT.