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
Who Am I - Not Me
Crafted Madness: Modern Era
JuJutsu Kaisen Rougelike
VAMPACK
Create With Friends SMP
Matti's Skyblock
Greg-E
KOTD
New Age Science and Technology Easy
Digimobs World Next Order
DragonMine Z - Minimalist Pack
Atomized
Fiction Friction Gaming
Dinosaurs and More 2
Horizon (New Dawn)
Aeroworks
Super III
Xomembers
ButterSMP Official Pack
You Like Food? 2!
antarchy craft
Naano Horizons - Utalyoa Edition
Create: Reatomized!
Monumental Experience - NeoForge
StellarisWorkshop
Clayblock
Splendid Ranching
Cobblemon Homestead
Forge of Eternity
Crazy Craft Reforged
PhoenixTech: Reloaded
Space Race 5
Infinity Pack 1
Narutoto World of Ninjas
Play Together | Multiplayer, Shared Life, Inventory & Progression (Multiplayer Experience with Friends)
All Roads Lead to The Void
HardRock Apocalypse - Plagueborn (HRAP)
Modern Revolutions Skies
Monumental Experience VI - Rise of the Dinosaurs
Creator Academy Based on Create
SwordCraft Origins
Crafttomuck
Dungeons and Shuttles Evolution
Rizmotopia
Jaffa Factory 2 - Futura Edition
MI:Lost Favor
WildLouna
Integrated MineColonies
Narutoto Epic Adventure
Crafted Create
Vanoss Crew SMP
Sky Industrialization
AllTheMons - The Void
AllCreateMods
RePalmon
All the Simple
Loyal Sky
Create: New Age
NoodlesSMP
Modustrie
Mana & Mechanisms
Create Creative and Beyond
Mystic Sky
Reclamation - Vessels Of Raven
Twisted Towns
Technical Dragonrider
Tech-Craft
Pixelmon Homestead
HeroesOfMultiverse
Plastek 3
Create Areonautics
InsaneCraft S2 (Fan Made)
CobbleMaster
VeritySurvival
Ultimate Heroes
God Of The Bosses
Pixelmon E2craft
EnchantVenture
Xomembers LITE
Horror Aeronautics with Friends
Mechanical Horizons Aeronautics
InfinityCraft Ultra
Simple Automation 2.0 | Beginner-Friendly Tech & Automation
Voltz (Volts) Reimagined - Official Server
![Shattered Skies [LC]](https://media.forgecdn.net/avatars/1452/455/638942418004153159.png)
Shattered Skies [LC]
Better Than Adventure-Forge
Fr3shpack - TooManyMods
Project Infinity - Infinite possibilities, one world
Tensura Chronicles of Tempest
Go Eevee v3 - Pixelmon/Create
Cobblemon Sky Adventure
CosmonautiCraft
ES CRAFT
SubCraft Rebirth
Reclamation - Hardcore Edition
Eclipse
Trial of the Void
Most Of The Mods
MHG: Cities!
Tensura Tainted Grace