GuideME
Modby shartte
A guidebook toolkit for mods and modpack makers alike with comfortable markdown formatting, and live 3d scenes!
Type
Mod
CurseForge Downloads
36,257,694
CurseForge ID
1173950
Modrinth Downloads
2,935,171
Modrinth ID
Ck4E7v7R
Last Updated
Sep 10, 2026
Description
# GuideME
This project offers the foundation for your mods or modpacks guidebook. Based on the technology powering Applied Energistics 2s guidebook, it allows you to write your guide in simple Markdown, while embedding 3d scenes straight from structure files.
For players, guides based on GuideME offer:
- Smooth scrolling goodness
- Content being front and center, with an advanced text layout engine supporting reflow and inline elements
- Interactive 3D scenes with annotations, intuitively illustrating concepts from your mod
- Cross-linking between topics and quick information in link tooltips
- Showing inline-recipes in your guidebook "JEI-Style"
- Offers the ability to "hold G" to quickly jump to the relevant guidebook page in any item tooltip
For modders, it offers a rich extensibility API, allowing you to:
- Add custom inline or block tags to Markdown, backed by a custom Widget system
- Extend the recipe rendering to display your custom recipes in the guide
- Use custom Markdown front-matter to easily add arbitrary information to guidebook pages
- Use custom indices to quickly find pages based on custom attributes
- Allow resource packs or addons to add their own content to your guide
## Example
The following is an example page from the AE2 guidebook (source).
```
---
navigation:
parent: ae2-mechanics/ae2-mechanics-index.md
title: Channels
icon: controller
---
# Channels
Applied Energistics 2's [ME Networks](me-network-connections.md) require
Channels to support [devices](../ae2-mechanics/devices.md) which use networked storage, or other network
services. Think of channels like USB cables to all your devices. A computer only has so many USB ports and can only support
so many devices connected to it. Most machines, full-block devices, and standard cables can only pass through
up to 8 channels. You can think of full-block devices and standard cables as a bundle of 8 "channel wires". However, [dense cables](../items-blocks-machines/cables.md#dense-cable) can support up
to 32 channels. The only other devices capable of transmitting 32 are
and the [Quantum Network Bridge](../items-blocks-machines/quantum_bridge.md). Each time a device uses up a channel, imagine pulling off a usb "wire" from
the bundle, which obviously means that "wire" isn't available further down the line.
```
Compatibility
Mod Loaders
Forge
Neoforge
Game Versions
1.20.1
1.20.4
1.21.1
1.21.5
1.21.8
1.21.10
1.21.11
26.1-snapshot-1
26.1-snapshot-3
26.1-snapshot-4
+2 more
Recommended Gear
AffiliateHardware and extras that pair well with this mod.
As an Amazon Associate I earn from qualifying purchases.
Screenshots
Similar Mods
Entity Culling Fabric/Forge
Using async path-tracing to hide BlockEntities/Entities that are not visible
Mod
389,594,541
Sodium
The fastest and most compatible rendering optimization mod for Minecraft. Now available for both NeoForge and Fabric!
Mod
371,237,042
JourneyMap
Real-time map used for mapping in-game or your browser as you explore.
Mod
364,021,033
Xaero's Minimap
Displays the nearby world terrain, players, mobs, entities in the corner of your screen. Lets you create waypoints which...
Mod
353,851,995
Waystones
Teleport from waystone to waystone or craft magical scrolls to warp.
Mod
339,958,664
Curios API (Forge/NeoForge)
A flexible and expandable accessory/equipment API for users and developers.
Mod
335,403,699
Included in Modpacks (1,039)
Show fewer
Seasons of Survival
Beyond Earth Journey to Agartha
Demon Slayer Roguelike
New Age 1
ReFactory: Expert
AmorfoLand 3
Origins ++ Magic & Friendship
The Last Krafter
Create Energistics (Continued)
Fortnite 3: Victory Royale
Artemis Continuum
Mutants & Multiverses
StoneBlock Project Matter
Super Enhanced Skyblock
Cogcrafter
Create: Build a Jurassic Park
NameIT
Gears & Glyphs
Mad-Kingdoms SMP
LongPlay Origins
ForgottenWinter
CreatingGregopolis
Endless Sky 2
Mangoescraft
Stage Equipment Essentials (SEE)
TARDIS & DRAGONS
The Odyssey (Create Aeronautics & Weather mods)
EaterSMP
![2Gather [Aeronautics]](https://media.forgecdn.net/avatars/1729/352/639100464334833845.png)
2Gather [Aeronautics]
Farlands - Origins Of The Olimpus
VOID-BOX2
Magic & Mechanisms - Airborne
Createch 2
Total Pack
Amperage
Mekacraft!
Omniversal Multiverse
CloverCraft (Season 1)
Irregulados
VS-Fossils and Archeology Server Pack
The Modpack of absolute all time
THE FORGOTTEN SMP
ATGC Meltdown 2 - The Sky
Stratum
Cobblemon Sink
Arceus's Cobblemon and Create
Faga's Cobblemon & Create
TURKEY SANDWICH CRAFT
Karma's Cobblemon Mechanical Magic
Fungal Engines
CrazyCrafters 3.0
Immortal Craft
Assembly Assembled
Athy's Cobbleswamp
Techno Vanilla
Dank-Dreams
GregTech Apocalypse GT-A
Luminosity
No Limits Project
Satisfactory in Minecraft
FUN CITY CRAFT - Amethyst Edition
Java Overhaul
Let's Create - The First Edition
Sitchen Kink
Jimmu's Factory 2
Ultimate Neodium
Warium Dead War Modern vs Medieval
Battlecraft 2.0
Ice and Firearms
Buddycraft - Oneblock
AP Gaming - Empowered Apocalypse
lightcraft season 2
Explorerflotte Create
RotomWorks
BeeShield Legends
The Powers that Be.
Sky Foodie
Yet Another Horror Pack
V's Fantasy Modpack
LGNcraft: Land of Tech
OriMeka Energistics: One
CrazyMC - A Special Apocalypse | Apocalypse with Quests!
Monumental Experience - Beneath the Surface
Pixelmon Adventures ( Server Pack )
Kreyc's Waterworld
Femtomancy
Maor The King Of The Light
Heroverse SMP - Official Server
![[Updated] Farming](https://media.forgecdn.net/avatars/1184/416/638758336359273427.png)
[Updated] Farming
Prism Drift
Sky Greg Fork
ExtremeCraftz
Prismatica
Mystic's Monstrosity - Avaricious Edition
SharkSquad Modpacks
Tensura Rebirth
Leyendas de Teagarden Pyroven
Tube's Not a modpack Modpack
Sabixonas
Hub-Craft