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
TJP - Endless Sky TJP - Endless Sky Crashed Crashed Create: Clockwork+ [Forge] Create: Clockwork+ [Forge] Gregnautics Gregnautics Servidor Magnatas Servidor Magnatas Finality Industries - Omnia Finality Industries - Omnia Realm of Destiny Realm of Destiny Chaos OneBlock Chaos OneBlock New Age Science and Technology hard New Age Science and Technology hard EMC & FE +++ EMC & FE +++ Era Do Futuro 2025 Era Do Futuro 2025 Digimon Two World Conspiracy Digimon Two World Conspiracy Invincible: Overdrive Invincible: Overdrive Project Avaritia EMC Adventure Project Avaritia EMC Adventure BeanPack: Regurgitated BeanPack: Regurgitated Train Yard Train Yard Zuri's Heroes pack Zuri's Heroes pack Progressionistic Progressionistic Egged Up Egged Up Jaffa Factory 2 Jaffa Factory 2 Creative Drawers Producer 2 Creative Drawers Producer 2 Cozy Meadows Cozy Meadows GregTech New Frontier GregTech New Frontier Plastek 2 Plastek 2 [DD&D] Dungeons Dragons & Dimensions [DD&D] Dungeons Dragons & Dimensions Mythic: Spellbound Mythic: Spellbound Mystical Block 2 Mystical Block 2 Create:Infinity Mechanism Create:Infinity Mechanism AllCreateMods AllCreateMods Kingdom of Elchea Kingdom of Elchea Solo Leveling Monarchs Kingdom Arise Anime Solo Leveling Monarchs Kingdom Arise Anime Community Community VORTEX Foundations VORTEX Foundations Dimensional Cultivation Dimensional Cultivation TFC Evolved TFC Evolved Natural Disaster Natural Disaster Changed: Reborn Changed: Reborn Craftformers Official Server Modpack Craftformers Official Server Modpack Aetherion - The Aether II Expanded Aetherion - The Aether II Expanded DivineRPG Server pack DivineRPG Server pack Create: End Times (Apocalypse) - With Create 6.0! Create: End Times (Apocalypse) - With Create 6.0! The Skies of Newstone Hollow The Skies of Newstone Hollow Crazycrafting For The Crazycrafting Server Crazycrafting For The Crazycrafting Server Ars Expeditions Ars Expeditions Pirates on a Boat Pirates on a Boat Astral Adventures: Beyond the Horizon Astral Adventures: Beyond the Horizon Dejojo's Oritech Pack Dejojo's Oritech Pack Sandbox in a Vacuum I SiaV Sandbox in a Vacuum I SiaV Easy Create Easy Create Concatenation Lite Concatenation Lite Beyond Cosmos Beyond Cosmos MekaMiners Brasil MekaMiners Brasil GregTech Easy GregTech Easy Absurdo 2 Absurdo 2 Jujutsu Kaisen Cursed Fate Anime Jujutsu Kaisen Cursed Fate Anime Quantum Skies Quantum Skies Rick's Portal Gun - Official Server Pack Rick's Portal Gun - Official Server Pack Stargate: ReLeveled Stargate: ReLeveled Better Survival (BSurvival) Better Survival (BSurvival) Penumbralcraft Penumbralcraft Tensura Tomfoolery Tensura Tomfoolery The Modded Rizoma MC The Modded Rizoma MC Tinker's Tavern: Cobblemon Tinker's Tavern: Cobblemon Minecolonies Create - Aeronautics Colonies Minecolonies Create - Aeronautics Colonies FTB Unstable 6 FTB Unstable 6 Tensura Resurrection Tensura Resurrection Monumental Experience - In space Monumental Experience - In space The Createville Pack The Createville Pack Revelations 3 - just Tech N' building! Revelations 3 - just Tech N' building! Demon's Tech, Magic and Superheroes Demon's Tech, Magic and Superheroes Picky Picky Ben 10 100 Days Survival Ben 10 100 Days Survival Essentials Mods - Halloween Edition [CurseForge Server] Essentials Mods - Halloween Edition [CurseForge Server] ReZero Pack ReZero Pack Prison Escape - Beginnings (reborn) Prison Escape - Beginnings (reborn) Creatopia Unbound Creatopia Unbound Tensura Roguelike Tensura Roguelike Inferno - Better Hardcore Inferno - Better Hardcore Myriad Dimensional Forge [SenDims BanForges] Myriad Dimensional Forge [SenDims BanForges] Moni&ProjectE Moni&ProjectE DIS IS OneBlock DIS IS OneBlock Farmy Skyblock Farmy Skyblock TACZcraft TACZcraft Monumental Experience VI - Rise of the Dinosaurs Monumental Experience VI - Rise of the Dinosaurs Shurui's DMZ Ragnarok Shurui's DMZ Ragnarok Storm Chasers Saga 2 Storm Chasers Saga 2 Congregation - expert Gregtech pack Congregation - expert Gregtech pack Community in the Skies Community in the Skies Greg-E Greg-E TechCraftBrasil - Servidor Brasileiro - ONLINE TechCraftBrasil - Servidor Brasileiro - ONLINE Xomaps Pocket Xomaps Pocket FreakCraft - CrazyCraft Inspired FreakCraft - CrazyCraft Inspired Liminal Industries - Oil Expansion Liminal Industries - Oil Expansion Infinite Horizons 2 - Superflat Survival Infinite Horizons 2 - Superflat Survival GregTech: Flatter Than Ever (GT:FTE) GregTech: Flatter Than Ever (GT:FTE) Arkanis Terceira Temporada - FANMADE Arkanis Terceira Temporada - FANMADE PokeSMP PokeSMP All Ultimate Selection All Ultimate Selection BeetleKnight's Beyond BeetleKnight's Beyond Create Clockwork Lite Create Clockwork Lite

External Resources