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
Tales of Celerity
Omega Industrial - Expert
Rise of Power
SinnoH Sanctum Old
TurtleCraftSMP
Chime Time IX
Frisky Business: Powercraft Edition 2
Da Boys Craft - DBC
The aether of create
Assembly Assembled
FemboyFarm
NVVS New Legends
Erstwhile Journey 2
Project Obscura
UnstableCraft SMP
Immortal Craft
YeSMP
Farmageddon
Mystical Astral Infinity
Cobblemon histories
NeoBox
Impostor Syndrome - Reimagined
Stargates, Colonies, And Ridiculous Tech
Colony Equivalence
All You Need - AYN
CobbleStories - A Create Adventure
GameGarden Ultimate
New Age 1
Redstoner's Paradise
Ciscos Dragonfyre - NFN Official
BiomeMAX
modular technology
Create-O-Holics 1 dot 5
Myths & Machinery
Arcadia Unlimited
Java Overhaul
NameIT
World War 3 Server
Artemis Continuum
theboysvanilla+
Chronost Incorporated
WUC Cursed Fate
Entropy Zero Evolution
Magic & Mechanisms - Airborne
Eldoria: The Last Epoch
Antarchy - Ascension
LGNcraft: Land of Tech
The Garden Of Lilith - A vibing RPG, Tech, Magic and building pack!
Rebirth - The Dead World
CreateMons - COBBLEMON PACK
RepYS - Engine of Creation
Tensura Waka Edition
Beyond Earth Journey to Agartha
The SV Vault
Create World CZ
SL Quantum Factory
Farlands - Rising
Grinding and industrialization GANDI 1
Fungal Engines
Arcane or Alloy
Superhero SMP Cross Addition
Gregtech Voyager
A GalacticWars Story
John Hall CEu Pack
A Lightweight Skyblock
Changed World
ApocalyptiCraft
The Convergence I
Nogla and Terroriser Reacts Patreon
Aquatica
VS-Fossils and Archeology Server Pack
The Ultimate Limitless - TUL 2
Heroverse SMP - Official Server
The Last Krafter
ReFactory: Expert
No Limits Project
Origins ++ Magic & Friendship
Create: Build a Jurassic Park
Endless Sky 2
Karma's Cobblemon Mechanical Magic
Create, Lanterns and Magic!
Mythara+
Project Eternity A New Vision
Techno Vanilla
Gears & Glyphs
Sky Ground Next Level
CrazyMC - A Special Apocalypse | Apocalypse with Quests!
Femtomancy
Eterium Sky Infinity
Stratum
Irregulados
Mutants & Multiverses
Lite Oritech
New Age Branch Line
Demon Slayer Roguelike
THE FORGOTTEN SMP
Yet Another Horror Pack
Dark Matter: To The Sky!
The Modpack of absolute all time
Hub-Craft