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
OneBlock Evolution OneBlock Evolution Total Pack Total Pack AmorfoLand 3 AmorfoLand 3 Eternal of Legends Eternal of Legends Battlecraft 2.0 Battlecraft 2.0 Farlands - Origins Of The Olimpus Farlands - Origins Of The Olimpus Fortnite 3: Victory Royale Fortnite 3: Victory Royale United SMP Revamp United SMP Revamp RotomWorks RotomWorks Cobblemon To The Skies Cobblemon To The Skies Mekacraft! Mekacraft! Sitchen Kink Sitchen Kink Ninjacat Skies Ninjacat Skies AP Gaming - Empowered Apocalypse AP Gaming - Empowered Apocalypse Mad-Kingdoms SMP Mad-Kingdoms SMP Lilith's Queer Cobblemon Extravaganza Lilith's Queer Cobblemon Extravaganza LongPlay Origins LongPlay Origins AVP Tech AVP Tech Echoes of Kaepora Echoes of Kaepora Cogcrafter Cogcrafter Kreyc's Waterworld Kreyc's Waterworld Amperage Amperage Arceus's Cobblemon and Create Arceus's Cobblemon and Create EaterSMP EaterSMP TURKEY SANDWICH CRAFT TURKEY SANDWICH CRAFT TARDIS & DRAGONS TARDIS & DRAGONS Sky Foodie Sky Foodie Prismatica Prismatica Super Enhanced Skyblock Super Enhanced Skyblock  2Gather [Aeronautics] 2Gather [Aeronautics] FUN CITY CRAFT - Amethyst Edition FUN CITY CRAFT - Amethyst Edition VOID-BOX2 VOID-BOX2 lightcraft season 2 lightcraft season 2 CloverCraft (Season 1) CloverCraft (Season 1) CivCraft 2 CivCraft 2 Pixelmon Adventures   ( Server Pack ) Pixelmon Adventures ( Server Pack ) GregTech Apocalypse GT-A GregTech Apocalypse GT-A CreatingGregopolis CreatingGregopolis Warium Dead War Modern vs Medieval Warium Dead War Modern vs Medieval Cave Factory --Reimagined-- Cave Factory --Reimagined-- OriMeka Energistics: One OriMeka Energistics: One Create & Conquer Create & Conquer Tinkers Construct Pack TCP Tinkers Construct Pack TCP TurboWarp SMP TurboWarp SMP Vix Vix Crafted Chaos Crafted Chaos Dank-Dreams Dank-Dreams Zoo and Adventures Forge Edition Zoo and Adventures Forge Edition Explorerflotte Create Explorerflotte Create Seasons of Survival Seasons of Survival Satisfactory in Minecraft Satisfactory in Minecraft Mangoescraft Mangoescraft ATGC Meltdown 2 - The Sky ATGC Meltdown 2 - The Sky Buddycraft - Oneblock Buddycraft - Oneblock ZonaCero Apocalypse Enhanced ZonaCero Apocalypse Enhanced Viriatus Viriatus Create - Tamed Frontiers Create - Tamed Frontiers Let's Create - The First Edition Let's Create - The First Edition Faga's Cobblemon & Create Faga's Cobblemon & Create The Powers that Be. The Powers that Be. Create Areo Naughts Create Areo Naughts V's Fantasy Modpack V's Fantasy Modpack Winter Leveling Winter Leveling SharkSquad Modpacks SharkSquad Modpacks Attack of the new B-Team Attack of the new B-Team Luminosity Luminosity CrazyCrafters 3.0 CrazyCrafters 3.0 Technia GTe Technia GTe Apotelesmatic Neoforge Apotelesmatic Neoforge RISAKU project RISAKU project Ice and Firearms Ice and Firearms Jimmu's Factory 2 Jimmu's Factory 2 GregTech Mechanical Era GregTech Mechanical Era Cobblemon Sink Cobblemon Sink The Collective, The Aeronautical Edition The Collective, The Aeronautical Edition Warspire Warspire From the Stone Age to the Stars From the Stone Age to the Stars Stellar Foundry Stellar Foundry Peaceful Adventures Peaceful Adventures Eight Seas Eight Seas Leyendas de Teagarden Pyroven Leyendas de Teagarden Pyroven Tube's Not a modpack Modpack Tube's Not a modpack Modpack The Old Kitchen The Old Kitchen Sky Greg Fork Sky Greg Fork Create: Endless Industry Create: Endless Industry ExtremeCraftz ExtremeCraftz Create Boundary Engineer Create Boundary Engineer Cobblemon: Age Of Industry Cobblemon: Age Of Industry oneblock but have cool technology oneblock but have cool technology BeeShield Legends BeeShield Legends Create With A Slight Twist Create With A Slight Twist Star Wars Aeronautics and superheroes Star Wars Aeronautics and superheroes fortcraft+ fortcraft+ Create Waves Create Waves Jurassic Block World Jurassic Block World ComboTech 4 Sky High ComboTech 4 Sky High gears guns and dragons gears guns and dragons Prism Drift Prism Drift Paleo Project Paleo Project Athy's Cobbleswamp Athy's Cobbleswamp

External Resources