Modscraper Modscraper Minecraft
GuideME logo

GuideME

Mod

by shartte

A guidebook toolkit for mods and modpack makers alike with comfortable markdown formatting, and live 3d scenes!

Type

Mod

CurseForge Downloads

40,982,701

CurseForge ID

1173950

Modrinth Downloads

3,296,073

Modrinth ID

Ck4E7v7R

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>

Example

Compatibility

Mod Loaders

Forge Neoforge

Game Versions

1.20.1 1.20.4 1.21.1 1.21.10 1.21.11 1.21.5 1.21.8 26.1-snapshot-1 26.1-snapshot-3 26.1-snapshot-4 +26 more

Recommended Gear

Affiliate

Hardware and extras that pair well with this mod.

As an Amazon Associate I earn from qualifying purchases.

Screenshots

Similar Mods

Included in Modpacks (1,142)

Show fewer
PokeHarvest PokeHarvest [XM] xK0KLIN Modpack's [XM] xK0KLIN Modpack's Trademarked Trademarked Project OMEGA - Chaos Protocol Project OMEGA - Chaos Protocol FTC - Indie Games FTC - Indie Games Industrialization Lite Industrialization Lite Sublime Experience Sublime Experience Semi-realist Create Semi-realist Create Reino de Celeste Reino de Celeste Delusions Craft Delusions Craft Cobblemon Cursed Lake Cobblemon Cursed Lake Sky Energy Tech Sky Energy Tech BounceCraft: ModernConflict BounceCraft: ModernConflict Dimensional Chaos - OneBlock Dimensional Chaos - OneBlock Steamcreate2 Steamcreate2 Chronos Archives Chronos Archives Overcrafto Overcrafto AKW: Atomic Kinetic Works AKW: Atomic Kinetic Works Create - New Age Survival Create - New Age Survival CobbleFrontier CobbleFrontier Revelations Revelations Adventure's Awaits Adventure's Awaits GregTech SpeedRun GregTech SpeedRun Syntex Gaming Community Syntex Gaming Community Create Brassline Create Brassline capybara’s play oritech capybara’s play oritech PureMash Tech Lite PureMash Tech Lite Tita The Wizard And The Nuclear Apocalypse Tita The Wizard And The Nuclear Apocalypse Create Flightworks Create Flightworks Atumni Infinitum Atumni Infinitum Cogwork Genesis Cogwork Genesis ASCENSION - Iron's Spells 'n Spellbooks & Magic Overhauled [Magic & Spells Addons] ASCENSION - Iron's Spells 'n Spellbooks & Magic Overhauled [Magic & Spells Addons] Above SMP Above SMP Neos Colony Neos Colony Create Gurizes Aeronautic - [NeoForge] Create Gurizes Aeronautic - [NeoForge] BellatorGaming - Community Pack BellatorGaming - Community Pack A creative decorating dream. Create structures according to your imagination. A creative decorating dream. Create structures according to your imagination. Adefica T Adefica T Create: Nations & Frontiers Create: Nations & Frontiers Tech and Guns: Zombie warfare Tech and Guns: Zombie warfare Structural Ingenuity Structural Ingenuity Coasters, Airships and Magic, Oh My! Coasters, Airships and Magic, Oh My! Industrial Colony 2 Industrial Colony 2 Progress - Selects Progress - Selects The Sigmas Pack The Sigmas Pack Create Mons n Machines Create Mons n Machines Cosmotech Cosmotech OneDay 2.0 OneDay 2.0 Create Aeroexperience Create Aeroexperience Old Reliables 3.5 Old Reliables 3.5 Ferguson Expeditions Ferguson Expeditions The Cozy Artificer The Cozy Artificer Draconic Machinations Draconic Machinations Exlandia 5 Exlandia 5 IM - Industrial Magic IM - Industrial Magic MC Resonance Horizons MC Resonance Horizons Create: Computers & Aeronautics Create: Computers & Aeronautics Little Lattes Cafémon Little Lattes Cafémon Vanilla&Tech Vanilla&Tech Goofcraft 3 Goofcraft 3 CobbledMon CobbledMon AOR | All of the Random AOR | All of the Random IsekaiANewWorld IsekaiANewWorld Tropical Paradise Tropical Paradise Reinicio Desde De  Zero (0 To Hero) Reinicio Desde De Zero (0 To Hero) Project Heroes Project Heroes Uiopik's Skyblock Uiopik's Skyblock Difficulty Curve Difficulty Curve FlatWorlds FlatWorlds 💎 Legend Infinity Project 💎 Legend Infinity Project MC-Ages MC-Ages Create the Skies Create the Skies Tekwiz Tekwiz HurleyCraft HurleyCraft Craft Colonies Craft Colonies Mundo Mitico Mundo Mitico Insurgence Insurgence Spiria Reincarnated Again! Spiria Reincarnated Again! Stahl und Sterne Stahl und Sterne Better Fireteam Better Fireteam SE Aeroworks SE Aeroworks LotaCraft: Lotaria LotaCraft: Lotaria Wattz Wattz DoomsDay Universe DoomsDay Universe Solo Leveling: Crafted Solo Leveling: Crafted Terceira Guerra Mundial BR Terceira Guerra Mundial BR Arkane 2 Arkane 2 Echo One Group Echo One Group A2SMP A2SMP Chris' Create Colonies Plus Chris' Create Colonies Plus Trambiquecraft Trambiquecraft BoraLances Craft BoraLances Craft Community in the Skies (with Origins) Community in the Skies (with Origins) Castigo's Castigo's Past Perfect Past Perfect Dwardsdog's Clockwork Conquest Dwardsdog's Clockwork Conquest Rural Factory Rural Factory SV_Adventures V3 SV_Adventures V3 It's Party Time It's Party Time Qilby Industries Qilby Industries

External Resources