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,979,262

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
Compression Compression The Immersive Revolution: Rebirth The Immersive Revolution: Rebirth Cube Warper Cube Warper Mystic's Monstrosity Mystic's Monstrosity Ozone Skyblock Reborn 2 Ozone Skyblock Reborn 2 MC Vanilla 2.0 - QUALITY UPDATE! MC Vanilla 2.0 - QUALITY UPDATE! All The Forge All The Forge Infinite Horizons - Modded Superflat Survival Infinite Horizons - Modded Superflat Survival Building Tales 2 Building Tales 2 Create: New Horizon Create: New Horizon Craftoria 2 - Worlds Beyond Craftoria 2 - Worlds Beyond Little Bit Large Little Bit Large Create - Forge Frontier Create - Forge Frontier A True Prime Piece Experiance A True Prime Piece Experiance StaTech Industry 2 StaTech Industry 2 Naruto AHZNB  Anime Naruto AHZNB Anime Rhinocraft Rhinocraft antarchy craft antarchy craft Rubius cobblemon Rubius cobblemon RandBlock 2 Winterize RandBlock 2 Winterize [MODIFIED] Cobblemon: OVERCLOCKED! [MODIFIED] Cobblemon: OVERCLOCKED! Adventure of Tech VI Adventure of Tech VI Terramity Awakened Terramity Awakened Create Lets Create - Official Server Create Lets Create - Official Server Create: Back on Track Create: Back on Track Better Create Aeronautics | Create Aeronautics with Create Addons & Improvements Better Create Aeronautics | Create Aeronautics with Create Addons & Improvements Enigmatic Skies Enigmatic Skies TechAcademy TechAcademy Prison Escape - Beginnings Prison Escape - Beginnings EMC SubTerra Tech EMC SubTerra Tech Immersive Cobblemon | With Distant Horizons, CobbleBrain, Cobblemon Addons & Quests (Cobblemon v1.7.3) Immersive Cobblemon | With Distant Horizons, CobbleBrain, Cobblemon Addons & Quests (Cobblemon v1.7.3) Monumental Experience - In the Sky Monumental Experience - In the Sky Ultra Hardcore Renewed - Do you dare to play it? | 1.21 UPDATE! Ultra Hardcore Renewed - Do you dare to play it? | 1.21 UPDATE! New Game 3 - Immersive RPG Adventures & RPG Quests New Game 3 - Immersive RPG Adventures & RPG Quests bleach soul society renewed bleach soul society renewed More Animals 2 - Exclusive Edition with Animals Quests! More Animals 2 - Exclusive Edition with Animals Quests! CrazyCraft Revived CrazyCraft Revived Exodus (Space Mission) | Stellaris & SPACE QUESTS! Exodus (Space Mission) | Stellaris & SPACE QUESTS! Mekanism: Automation Mekanism: Automation Magitech Fantasia Magitech Fantasia WT Endless Sky Adventures - Skyblock Edition WT Endless Sky Adventures - Skyblock Edition The Last War - Guns And Adventure The Last War - Guns And Adventure Magic Valley Magic Valley Sky of Grind Sky of Grind MineColonies - Cobblemon Conquest MineColonies - Cobblemon Conquest More Decorations 2 - Exclusive Edition | Decoration Mods! More Decorations 2 - Exclusive Edition | Decoration Mods! Jaffa Factory 2 (Replica) Jaffa Factory 2 (Replica) Exosphere 2 + Create (Aeronautics) Exosphere 2 + Create (Aeronautics) Sky Frogs Sky Frogs CobbleCreate. The Cobblemon and Create combination! CobbleCreate. The Cobblemon and Create combination! Primal Apocalypse - Unusual Survival with Dinosaurs, Guns and Quests | Prehistoric Apocalypse Primal Apocalypse - Unusual Survival with Dinosaurs, Guns and Quests | Prehistoric Apocalypse Cosmic Frontiers Cosmic Frontiers NeepMeat - Trifecta NeepMeat - Trifecta [CTM] Let's Cobble these Mons - a Cobblemon modpack [CTM] Let's Cobble these Mons - a Cobblemon modpack Mystic's Monstrosity - Greedy Edition Mystic's Monstrosity - Greedy Edition Tensura All The Slime 1 Tensura All The Slime 1 TechRPG - RPG with Tech, Magic, Create, Space Exploration TechRPG - RPG with Tech, Magic, Create, Space Exploration New Age Science and Technology New Age Science and Technology Ars Eclectica: an Ars Nouveau Experience Ars Eclectica: an Ars Nouveau Experience Essentials Mods Essentials Mods Xomaps Potato Master Xomaps Potato Master Better Experience (BTV) - Last Update! | The Copper Age! Better Experience (BTV) - Last Update! | The Copper Age! Technically Industrial Technically Industrial Avaritia Project Avaritia Project Medival, Magic & Tech NeoForge Medival, Magic & Tech NeoForge Ascension of Ages Ascension of Ages Monumental Experience - Creatures Across the World Monumental Experience - Creatures Across the World More Animals 2 More Animals 2 Naruto Ninshu Origins Chakra Storm Naruto Ninshu Origins Chakra Storm Liminal Industries Acension Liminal Industries Acension Naruto Legacy of the Shinobi (Ninshu Origins) Naruto Legacy of the Shinobi (Ninshu Origins) EMC & FE ++ EMC & FE ++ Infinity Legacy Infinity Legacy High-Altitude Alchemy High-Altitude Alchemy Liminal Industries - Rescripted Liminal Industries - Rescripted Meccha Crafteleon Together ! Meccha Crafteleon Together ! IanAnderson's Modpack IanAnderson's Modpack Secret Mission: Christmas Secret Mission: Christmas Mystical Block Reloaded Mystical Block Reloaded Technological Ascent Technological Ascent Exploring the Universe - An Adventure between Planets (With Ad Astra & Quests) Exploring the Universe - An Adventure between Planets (With Ad Astra & Quests) New Age Science and Technology  Easy New Age Science and Technology Easy Impostor Syndrome Impostor Syndrome Sky Bees Reborn Sky Bees Reborn Kawaii Craftia Kawaii Craftia FTB Builders Paradise 2 FTB Builders Paradise 2 Project Spacee Project Spacee Do I am cake? Do I am cake? Factory in the Sky 4 Factory in the Sky 4 Stargate20 Stargate20 Ashes To Ashes Ashes To Ashes SMP | Somake Server SMP | Somake Server Industrial Upgrade Horizon Industrial Upgrade Horizon Create: Civilizations - C:C Create: Civilizations - C:C Thormen 1.21.1 - Mekanism -  Spaceships -  ICBMs -  Force Fields -  Nuclear Science  -  Voltz successor - Modpack server running Thormen 1.21.1 - Mekanism - Spaceships - ICBMs - Force Fields - Nuclear Science - Voltz successor - Modpack server running RAT+ RAT+ Improved Oritech | Oritech, Technology & Quests (Oritech 1.21.1) Improved Oritech | Oritech, Technology & Quests (Oritech 1.21.1) Mechanical Infinity Mechanical Infinity Extraordinary Energy : Modern Extraordinary Energy : Modern everything is random everything is random

External Resources