Modrinth · Forge, NeoForge

Guide-API VP on your Minecraft server

Guide-API VP runs on Minecraft servers with Forge or NeoForge. Order your server, set the loader in the panel and install the mod with one click in the mod browser.

Flexible code based guide book

Downloads
456.8K
Author
maxanier
Loader
Forge, NeoForge
Minecraft
1.16.4 – 26.1.2
Updated
–

Setup

Install Guide-API VP on your server

The server and players need the same loader and Minecraft version. Back up the world before adding or updating mods.

  1. 01

    Configure

    4 GB of RAM is preselected. You choose the term and add-ons and pay by credit card or PayPal.

  2. 02

    Set the loader

    In the panel, set the server software to Forge or NeoForge and choose the matching Minecraft version, for example 26.1.2.

  3. 03

    Install the mod

    Search the mod browser for “Guide-API VP” and install the release for your loader. Alternatively, upload the .jar to the mods folder via SFTP. Required dependencies are listed on the project page.

  4. 04

    Connect

    Every player installs the same Guide-API VP release locally and connects using the server address from the panel.

On the server
Required
On the client
Required
Loader
Forge, NeoForge
Minecraft
26.1.2, 1.21.1, 1.21 +12 more
License
MIT License

The panel

Install mods, find errors.

Real screenshots from the Mado panel. Both come with every Minecraft server.

Mod browser

Modrinth and CurseForge, right in the panel.

The browser filters by your Minecraft version. Install mods with one click, without uploading .jar files.

Browser in the Mado panel with search, a CurseForge or Modrinth source switch and install buttons.

AI crash analysis

When a mod crashes, the analyzer reads the log.

Mods often fail on a wrong loader version, Java version or missing dependency. The analyzer names a likely cause and suggests a fix.

Optimization page in the Mado panel with the AI Log Analyzer enabled and a “Server Crashed” notice with an “Analyze Now” button.

Releases

Published releases

Pick the file that matches your server’s loader and Minecraft version. The server and players need the same release.

Guide-API VP · Modrinth
Original description by the project author

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.

FAQ

Guide-API VP questions

Question not listed? Ask our team.

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

Common causes: the loader or Minecraft version does not match the mod file, a dependency is missing, or RAM is too low. Check the log (latest.log) for “OutOfMemoryError”, “Mixin” or missing mods. At Mado, the AI crash analysis reads the log and suggests a cause. You can change the loader and version in the panel.

Which loader does Guide-API VP run on?

According to Modrinth, Guide-API VP supports Forge, NeoForge for Minecraft 26.1.2, 1.21.1, 1.21.

How much RAM does a server with Guide-API VP need?

As guidance, 3–4 GB for a server with this mod. This is an estimate, not a measured minimum. More mods, many players and long view distances need more. The spark profiler shows whether a mod is costing tick time.

Ready for your server with Guide-API VP?

4 GB of RAM from €8.00 per month. 35% off your first month with MADO35.

Order server