GuideME
Modby shartte
A guidebook toolkit for mods and modpack makers alike with comfortable markdown formatting, and live 3d scenes!
Type
Mod
CurseForge Downloads
40,979,262
CurseForge ID
Modrinth Downloads
3,296,073
Modrinth ID
Last Updated
Nov 7, 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 <ItemLink id="me_p2p_tunnel" />
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.
<GameScene zoom="7" interactive={true}>
<ImportStructure src="../assets/assemblies/channel_demonstration_1.snbt" />
</GameScene>
Compatibility
Mod Loaders
Game Versions
Recommended Gear
AffiliateHardware and extras that pair well with this mod.
As an Amazon Associate I earn from qualifying purchases.
Screenshots
Similar Mods
Bookshelf
An open source library for other mods!
Entity Culling Fabric/Forge
Using async path-tracing to hide BlockEntities/Entities that are not visible
Clumps
Clumps XP orbs together to reduce lag
Sodium
The fastest and most compatible rendering optimization mod for Minecraft. Now available for both NeoForge and Fabric!
Xaero's Minimap
Displays the nearby world terrain, players, mobs, entities in the corner of your screen. Lets you create waypoints which...
JourneyMap
Real-time map used for mapping in-game or your browser as you explore.
Included in Modpacks (1,142)
Show fewer
Dungeons and Shuttles Evolution
Vanoss Crew SMP
ForgottenWinter
Xomembers LITE
Modustrie
Sky Industrialization
Simple Automation 2.0 | Beginner-Friendly Tech & Automation
Integrated MineColonies
Horror Aeronautics with Friends
InsaneCraft Reimagined
Replication Issues
Mystic's Monstrosity - Avaricious Edition
RePalmon
Createch 2
Twisted Towns
StoneBlock Project Matter
Omniversal Multiverse
Technical Dragonrider
Mana & Mechanisms
Plastek 3
AdvoTech ValkyrienSkies (abandoned)
Reclamation - Vessels Of Raven
ES CRAFT
Create Creative and Beyond
Tech-Craft
Gearspack
SMP Aesthia
God Of The Bosses
Mystic Sky
Pixelmon Homestead
![Züge [1.20.1]](https://media.forgecdn.net/avatars/1108/595/638659001884958234.jpg)
Züge [1.20.1]
Ultimate Heroes
Loyal Sky
A Bit o' Everything
AllTheMons - The Void
Better Than Adventure-Forge
Mechanical Horizons Aeronautics
Go Eevee v3 - Pixelmon/Create
Eclipse
Project Arc Light - Dimensional Rift
OmniCraft Evolved
Cobblemon Sky Adventure
GATE Guns & Magic
ReCraft S8 Project infinity 0.1
![Shattered Skies [LC]](https://media.forgecdn.net/avatars/1452/455/638942418004153159.png)
Shattered Skies [LC]
Voltz (Volts) Reimagined - Official Server
LuxeCraft SMP
Trial of the Void
Jelly&Co
Fr3shpack - TooManyMods
MHG: Cities!
SkyTech Evolution
Ribbits n' Bits
Multiversal Misadventures - The Blockhead's Guide to the Galaxy
Most Of The Mods
Dynamic Odyssey
Donna's Odyssey Fantasy RPG
CosmonautiCraft
Aeronautics-The Create Dream
SubCraft Rebirth
Farmtastic!
Create Energistics (Continued)
Shitblock
Tensura Tainted Grace
Monumental Experience - Beneath the Surface
Catch, Create, Conquer
The Odyssey (Create Aeronautics & Weather mods)
Furtastic (a changed adventure)
Galaxy Sky
DragonMine Z - Universe
Create: Cogs & Cataclysm
Our Antarchy Craft
The Great Beyond
Artemis: Project
SpHiNxX's Technical Overhaul
Applied Energestic 2 vs Refined Storage Neoforged
Joline's Bizarre adventures
Gundustry
Ultimate Neodium
ProsperityCraft
Arctania SMP
PMX
Overclock - Tech Automation with Quests | Create, Aeronautics, AE2, Modern Industrialization & More
CrazyCraft Reimagened
Lucky World Invasion (Updates & Tweaks)
Industrialized
Multi Pocket Dimensions
Create:Mechanism and Innovation
SkyFactory Reborn
Project: TFCreate
HARDCORE EVOLUTIONS
DiscoveryRPG
Almost enough content
ComboTech 4
Solar Fantasy
ProjectS
theArcadia
The Darkstorm Modpack
Stage Equipment Essentials (SEE)
Community Made