Back to mods
Guide-API VP project artwork

Modrinth · Minecraft mod

Guide-API VP

Flexible code based guide book

Choose a version Pick your version below, then grab the matching file.

Quick answer

Which Guide-API VP release should I use?

Updated 3 months ago
Latest stable file 1.21.1-2.3.0
Game version 1.21.1
Loader NeoForge

Guide-API VP 1.21.1-2.3.0 targets 1.21.1 with NeoForge. Installation on the client is optional. Installation on the dedicated server is optional. No extra mods listed for this file.

Where it goes

Is Guide-API VP required on the client, server, or both?

Installation on the client is optional. Installation on the dedicated server is optional.

Client Optional
Dedicated server Optional
Loader for this release NeoForge
Required install it here Optional supported, not mandatory Not supported do not install here Source doesn’t say do not assume

The source marks this as usable on both the client and server.

What else does Guide-API VP 1.21.1-2.3.0 need?

1.21.1-2.3.0. Change the file and its required mods may change too.

No extra mods listed for this file

This file does not list any required mods. Do not add a library just because a different file uses it.

This file does not list any required or optional mods.

Before you install it

Add Guide-API VP without breaking your instance.

Built for Guide-API VP 1.21.1-2.3.0. Pick another file and the loader, install side or required mods may change.

  1. 01

    Stick to this file

    Use 1.21.1-2.3.0. It targets 1.21.1 with NeoForge; another release may have different loader, side or dependency requirements.

  2. 02

    Bring the mods it needs

    This file does not list any required mods. Do not add a library just because a different file uses it.

  3. 03

    Put it on the correct side

    Installation on the client is optional. Installation on the dedicated server is optional.

  4. 04

    Pick the file you checked

    Use the “Get this file” button beside 1.21.1-2.3.0. It opens that exact file at the source.

About this project

What does Guide-API VP add?

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.

Project description from Modrinth.

Pick your setup

Guide-API VP by Minecraft version and loader

Choose the version and loader you play, then open the matching release.

15 available setups

Showing the newest 12 of 15 game versions. Older files are in the list below.

Check the dependencies, then try the file in a copied instance before changing a world you care about.

Recent files

Guide-API VP versions and loaders

28 of 28 releases match

Looking for an older file? The official Modrinth project page is in Resources.