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
Civilization Isolaria
Trambiquecraft
SV_Adventures V3
AndyTech
Sarcasticraft Resurrection
It's Party Time
Dimmas91 Pixelmon 2
Femboy Foundry
Breio
Mystical Astral Infinity
The Outcasted SMP Modpack
HeliosGamesCZSK
Rural Factory
Bitz Spoon Create Season 1
💎 Legend Infinity Project
Solo Leveling: Crafted
Phonix_Project
Build Secure Protect
BounceCraft: ModernConflict
MonkTech 3
CornoPack Apocalipses
Godzillawarz's Kitchen Sink
AdvoTech Aeronautic
bliblu
Bizarre Craft (A Homage To Crazy Craft)
Cobblemon: Snackbar SMP
BoraLances Craft
OceanCastle-Modded Adventure
Better Survival (BSurvival2)
Castigo's
Ad Odyssey
Dank Division
Verlac
Jurassic world: Mesozoic Mayhem
fortcraft+
Tekwiz
Winter's Fury 2 A Journey Through The Frost
ZooTech
IsekaiANewWorld
Overclock - Tech Automation with Quests | Create, Aeronautics, AE2, Modern Industrialization & More
L'Etang
Snekrosis 2: The War for Shroomtown
Pandora's Cobblemon
CSP Revenge
TechnikDream2
Community in the Skies (with Origins)
Medieval Epic Adventure
Blad Pack
Quantum Haunt
The Fallen Worlds
The Maddest Son
Abichuelos
A Minecraft server Modpack
Destiny's Kitchen Sink
Inso's Craft
Cobblemon Forever Edition
Cobblemon Chaos Edition
BetterTech 1
Wattz
Manoelcraft World
TLSS Modpack
Souls Of Noxxastraël
Cobblemon automated
WildCraft Golden Era Reimagined
TPW: Redux
Fever MC
Chronosphere
Create: Nations & Frontiers
The Last: Between Realms
Gears of the Void
Foundry Semi-Anarchy
Vision-Craft.net
Bigger Better Experience
ModernWarfare to the Max
![Steamspire Syndicate [Season 2]](https://cdn.modrinth.com/data/GbiYSCQT/85047c982fdb23b317285603406c8aae1a0103ee_96.webp)
Steamspire Syndicate [Season 2]
Qilby Industries
The Oblivion
The Cobblemon Collective
John's Cobblemon ServerPack
Batom e Cafe
UnstableCraft
Create: Computers & Aeronautics
RanchMania
Trademarked
Brixton Buttered Crumpets
![[balls_game_2]](https://cdn.modrinth.com/data/JOXPFKbm/956494f7b7259632f6ab6b99378dc9a11cbef37c_96.webp)
[balls_game_2]
Custom Heros
Last MC 2025 JTF
Hug Trees With Gromit
Bachnet Survival
LePaquePourTous
![Aetherium [FORGE]](https://media.forgecdn.net/avatars/1416/414/638917586508409310.png)
Aetherium [FORGE]
WhatTheCluckery
Quickraft
MMOs Group Modpack
Craft Mizyen
![[GDJ] _ Dragon Farm](https://media.forgecdn.net/avatars/1301/93/638845720214716725.png)
[GDJ] _ Dragon Farm
Cobbleish
Shattered Dimensions- Mechanisms and Grimoires
Idiossincrasia