Guide-API VP

Guide-API VP

Flexible code based guide book

by
425.0K Downloads
forgeneoforgelibraryutility
Rent Server with this Mod

About this Mod

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.

Available Versions

Guide-API-VP-1.21.1-2.3.0release
MC 1.21.1neoforge
August 11, 2024
Guide-API-VP-1.20.6-2.3.0release
MC 1.20.6neoforge
June 15, 2024
Guide-API-VP-1.20.1-2.2.6release
MC 1.20.1forge
October 15, 2023
Guide-API-VP-1.19.4-2.2.6release
MC 1.19.4forge
June 9, 2023
Guide-API-VP-1.19.3-2.2.5release
MC 1.19.3forge
February 13, 2023

How to Install Guide-API VP on Your Server

1

Order Server

Order a Minecraft Java server with at least 3 GB RAM (4 GB recommended).

2

Set forge Loader

In the panel under "Egg", select the forge loader and matching Minecraft version (26.1.2).

3

Install Mod

Open the mod browser in the dashboard and search for "Guide-API VP". Click "Install" – done! Alternatively, upload the .jar via SFTP to the /mods folder.

Compatibility

Mod Loaders

forgeneoforge

Minecraft Versions

26.1.2, 1.21.1, 1.21 (+12 more)

Server-side

Required

Recommended RAM

4 GB(min. 3 GB)

Frequently Asked Questions

Guide-API VP server crashes on startup – what to do?

Most common cause: wrong forge version or insufficient RAM. Check the server log (latest.log) for "OutOfMemoryError" or "Mixin" errors. With Mado Hosting: ensure at least 3 GB RAM is allocated and the loader matches the mod version (26.1.2). You can switch loaders with one click in the panel.

Is Guide-API VP compatible with forge and neoforge?

Guide-API VP officially supports forge, neoforge for Minecraft 26.1.2, 1.21.1, 1.21. The Mado dashboard automatically detects incompatible loader combinations.

Server lagging with Guide-API VP – how to optimize performance?

Recommended RAM: 4 GB (per 8 players). Use /spark profiler to check if Guide-API VP consumes the most tick time. Common fixes: reduce server view-distance to 8-10, install "performant" or "starlight" as supplementary mods on Forge. With Mado Hosting, your server runs on NVMe SSDs with dedicated CPU cores for minimal latency.

Rent Modded Server

Install Guide-API VP with just one click on your server.

Recommended RAM
4 GBfrom €5.2/mo
Minimum 3 GB | per 8 players
Create Server Now
1-Click Mod Install
NVMe SSD Storage
DDoS Protection included

Details

License
MIT License
Server-side
Required

Supported Versions

26.1.21.21.11.211.20.61.20.11.201.19.41.19.31.19.21.19+5 more