GuidebookAPI

GuidebookAPI

Allow the ease creation of guides for minecraft mods with no hard-dependency.

by
496 Downloads
fabricneoforgelibraryutility
Rent Server with this Mod

About this Mod

GuidebookAPI is currently under a rewrite!

Header

GuidebookApi is a mod that allow the ease creation of guides with no hard dependency.

Some of the features of this mod are:

  • Modify the guides has you want! You can change what guides spawn, if you want all the guides to spawn or the color of these!

  • Add or change content based on the configuration or assets of the mod.

  • Add custom page types, like recipes or any type of page do you need/want!

  • All the guides are made mostly in java-code instead of external files like other mods!

All this with no-hard dependency, this means the mods with a guide can work without the mod installed!

Credits

  • Original Mod: TehNut and Tombenpotter.
  • This mod: WonejoMB/Leo

Extras

GuidebookApi started ( and is ) a fork of the GuideAPI mod made by TehNut and Tombenpotter.

Currently the mod has some changes to the mod's internal API, but some of the code base is still there so if you are a developer you can see the ExampleBook on github or you can see the Developer Wiki of the original mod. ( Preferred see both because there are some features of the original mod removed or replaced with others )

There are other versions of GuidebookAPI but aren't here ( because of problems with the account here ) so the older versions of GuidebookAPI are on curseforge!.

This mod is under the MIT license.

Available Versions

1.20.6-3.1.1-neoforgerelease
MC 1.20.6neoforge
June 4, 2024
1.20.6-3.1.1-fabricrelease
MC 1.20.6fabric
June 4, 2024
1.20.6-3.1.0-neoforgerelease
MC 1.20.6neoforge
May 27, 2024
1.20.6-3.1.0-fabricrelease
MC 1.20.6fabric
May 27, 2024
1.20.6-3.0.0-neoforgerelease
MC 1.20.6neoforge
May 12, 2024

How to Install GuidebookAPI on Your Server

1

Order Server

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

2

Set fabric Loader

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

3

Install Mod

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

Compatibility

Mod Loaders

fabricneoforge

Minecraft Versions

1.20.6

Server-side

Required

Recommended RAM

4 GB(min. 3 GB)

Frequently Asked Questions

GuidebookAPI server crashes on startup – what to do?

Most common cause: wrong fabric 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 (1.20.6). You can switch loaders with one click in the panel.

Is GuidebookAPI compatible with fabric and neoforge?

GuidebookAPI officially supports fabric, neoforge for Minecraft 1.20.6. The Mado dashboard automatically detects incompatible loader combinations.

Server lagging with GuidebookAPI – how to optimize performance?

Recommended RAM: 4 GB (per 8 players). Use /spark profiler to check if GuidebookAPI 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 GuidebookAPI with just one click on your server.

Recommended RAM
4 GBab €8/mo
Min. 3 GB | +1 GB pro 8 Spieler
Create Server Now
1-Click Mod Install
NVMe SSD Storage
DDoS Protection included

Details

License
MIT License
Server-side
Required

Supported Versions

1.20.6