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
TCC - Skyzone TCC - Skyzone HORYZONEA HORYZONEA Blue Skies & Black Smoke Blue Skies & Black Smoke The TaCZ x Iron's Spells 'n Spellbooks Crossoverpack The TaCZ x Iron's Spells 'n Spellbooks Crossoverpack A Crazy Adventure: Science & Survival A Crazy Adventure: Science & Survival Peace of Mind 21.1 Peace of Mind 21.1 Skyblock Alchemy Reconstruction Era Skyblock Alchemy Reconstruction Era Saturn SMP 2 Saturn SMP 2 Create&Greg 2 Create&Greg 2 Wheel of Mods 3 Wheel of Mods 3 Limbones Server Modpack Limbones Server Modpack CanarioLand 2 CanarioLand 2 Cobblemon Grand Journey Cobblemon Grand Journey Chaotic Modpack Chaotic Modpack Zuge [1.21.1] Zuge [1.21.1] Magecraft: A Gods Tale Magecraft: A Gods Tale Redwolf's Crazy World Redwolf's Crazy World Advenium 3 Advenium 3 Casino Block Casino Block Tanehu's Beyond The End Tanehu's Beyond The End Apotheosis Pack 3 Apotheosis Pack 3 Soldier On Soldier On Omega Created Technology Omega Created Technology ChaosCraft JS Edition ChaosCraft JS Edition the horror of the dwellers and more the horror of the dwellers and more Ride & Reign Ride & Reign Omniverse Heroes Omniverse Heroes BuddelTech BuddelTech Weedie's Industrial Fantasy Weedie's Industrial Fantasy Holdy's Chronicle Holdy's Chronicle Pickable Me Pickable Me Crazy Antarchy Crazy Antarchy BurningCube BurningCube LightCraft Season 3 LightCraft Season 3 Zenith Lite Zenith Lite Adventurecraft: Create Editon Adventurecraft: Create Editon Survival Refined Survival Refined Weedie's Undead Adventure Weedie's Undead Adventure OvermoddedCraft OvermoddedCraft Flookers All The Mons! Flookers All The Mons! NewPath - Echoes of the Wild NewPath - Echoes of the Wild The Song of Crafting The Song of Crafting MafiaCraft MafiaCraft Only Create Only Create SwellCraft - Create & Cobblemon SwellCraft - Create & Cobblemon Phantom Community Modpack Phantom Community Modpack Skyindustries Alchemic Skyindustries Alchemic Essence Odyssey Essence Odyssey GUILTY'S MEGAPACK GUILTY'S MEGAPACK Government Government From Mill to Mechanism From Mill to Mechanism PureSavage-with-shaders-and-rp PureSavage-with-shaders-and-rp Hero's N Villain's Reborn Hero's N Villain's Reborn MTZ EXPERTE MTZ EXPERTE Empires of Steam & Sky Empires of Steam & Sky WorldsEnd WorldsEnd EMERIS Endless Summer EMERIS Endless Summer GoatCraft BMC++ 4 [Forge] GoatCraft BMC++ 4 [Forge] Valley Chill Valley Chill Steamland - SP Steamland - SP Assembly Assembled | Server Assembly Assembled | Server Create Even Further Beyond Create Even Further Beyond Bizarre Craft (A Homage To Crazy Craft) Bizarre Craft (A Homage To Crazy Craft) Riders Race to Berk Riders Race to Berk TCG SMP - Prologue (Public) TCG SMP - Prologue (Public) PandaLand Pack PandaLand Pack Civilization Isolaria Civilization Isolaria Masters Of Aeronautics Masters Of Aeronautics Space Block Eclipse Space Block Eclipse AdvoTech Aeronautic AdvoTech Aeronautic OverGreg OverGreg Society Sunlit Valley Enhanced Society Sunlit Valley Enhanced jaaj jaaj Kat's Craft 2 Kat's Craft 2 Adventure & Horror Adventure & Horror CobbleNerd CobbleNerd Cobblemon Industrial revolution Cobblemon Industrial revolution Create MEGA - Aeronautics Edition Create MEGA - Aeronautics Edition SPELLCRAFT-SMP SPELLCRAFT-SMP Data Center in the Sky Data Center in the Sky A MAFIA SMP A MAFIA SMP Coziestcraft Coziestcraft Creating Sandwiches Creating Sandwiches EmberHorizon's Custom Pack EmberHorizon's Custom Pack Rust and Rituals Rust and Rituals KarmaCraft Chaos & bleibender Schaden KarmaCraft Chaos & bleibender Schaden HexTech: The New Age HexTech: The New Age Starfall Skies Starfall Skies All Those Tech All Those Tech Into The Crazy Into The Crazy Infinite Mayhem Infinite Mayhem Milk and Stuff: Remilked Milk and Stuff: Remilked InfinityMidCraft InfinityMidCraft Francis IV Francis IV Empyrean Expansion Empyrean Expansion Homer Pack Homer Pack Ashes and Iron Ashes and Iron Starborne create Starborne create Industrial Skies pack Industrial Skies pack Beyond Depth ( Zenith's Way ) Beyond Depth ( Zenith's Way )

External Resources