Back to mods
Guide-API Village and Pillage project artwork

CurseForge · Minecraft mod

Guide-API Village and Pillage

Guide-API fork for 1.14+ - Allows modders to easily create in-game documentation.

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

Quick answer

Which Guide-API Village and Pillage release should I use?

Updated 2 months ago
Latest stable file Guide-API-VP-1.21.1-2.3.0
Game version 1.21.1
Loader NeoForge

Guide-API Village and Pillage Guide-API-VP-1.21.1-2.3.0 targets 1.21.1 with NeoForge. The project page does not say whether it belongs on the client. The project page does not say whether it belongs on the dedicated server. No extra mods listed for this file.

Where it goes

Is Guide-API Village and Pillage required on the client, server, or both?

The project page does not say whether it belongs on the client. The project page does not say whether it belongs on the dedicated server.

Client Source doesn’t say
Dedicated server Source doesn’t say
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 does not explicitly classify this release as client-only or server-only.

What else does Guide-API Village and Pillage Guide-API-VP-1.21.1-2.3.0 need?

Guide-API-VP-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 Village and Pillage without breaking your instance.

Built for Guide-API Village and Pillage 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 Guide-API-VP-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

    The project page does not say whether it belongs on the client. The project page does not say whether it belongs on the dedicated server.

  4. 04

    Pick the file you checked

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

About this project

What does Guide-API Village and Pillage add?

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.

Project description from CurseForge.

Pick your setup

Guide-API Village and Pillage by Minecraft version and loader

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

25 available setups

Showing the newest 12 of 22 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 Village and Pillage versions and loaders

42 of 42 releases match

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