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
Cobblemon + Create - Pokemon meets Industrial Revolution! Cobblemon + Create - Pokemon meets Industrial Revolution! Xomaps Potato Sky Xomaps Potato Sky Shiner's Mushoku Tensei/Jobless Reincarnation Shiner's Mushoku Tensei/Jobless Reincarnation Adventure of Tech V Adventure of Tech V RockTown Tech World Sky Block RockTown Tech World Sky Block All Quiet on the Sink - AQS All Quiet on the Sink - AQS NinjaCraft - Official Server NinjaCraft - Official Server EnchantVenture EnchantVenture Project Arc Light - The Hanging Pavilion Project Arc Light - The Hanging Pavilion Who Am I - Not Me Who Am I - Not Me Create Outbound Create Outbound Chronicles of Magic | The First Magician Chronicles of Magic | The First Magician InfinityCraft: Hero-verse InfinityCraft: Hero-verse SwordCraft Origins SwordCraft Origins Xomaps 2 Xomaps 2 Araxer's: Ages - Staged Survival Araxer's: Ages - Staged Survival tensura exploration tensura exploration Create Areonautics Create Areonautics The Ember Project The Ember Project Create Echoes of the Great Derailment Create Echoes of the Great Derailment FriendsCraft - Designed for Multiplayer | Vanilla-Friendly FriendsCraft - Designed for Multiplayer | Vanilla-Friendly Crafted Madness: Modern Era Crafted Madness: Modern Era Dieselpunkery Dieselpunkery Play Together | Multiplayer, Shared Life, Inventory & Progression (Multiplayer Experience with Friends) Play Together | Multiplayer, Shared Life, Inventory & Progression (Multiplayer Experience with Friends) Tensura Reemerged Tensura Reemerged After Humans Retouched+ After Humans Retouched+ Project Infinity - Infinite possibilities, one world Project Infinity - Infinite possibilities, one world Narutoto Epic Adventure Narutoto Epic Adventure The Five Nights The Five Nights Cloudy Kaisen Cloudy Kaisen MHA : Heroes Journey MHA : Heroes Journey The OneBlock 1 The OneBlock 1 Bearly Vanilla (Season 0) Bearly Vanilla (Season 0) StellarisWorkshop StellarisWorkshop Farms N' Furniture Farms N' Furniture InsaneCraft S2 (Fan Made) InsaneCraft S2 (Fan Made) InteritusCraft (post-apocalyptic survival) InteritusCraft (post-apocalyptic survival) DragonMine Z - Minimalist Pack DragonMine Z - Minimalist Pack VAMPACK VAMPACK Create With Friends SMP Create With Friends SMP The Rise of Newstone Hollow The Rise of Newstone Hollow Void Nomad Void Nomad Aeroworks Aeroworks EMC Reach For The Stars EMC Reach For The Stars CobbleMaster CobbleMaster JuJutsu Kaisen Rougelike JuJutsu Kaisen Rougelike Narutoto World of Ninjas Narutoto World of Ninjas Artifice & Industry Artifice & Industry Fiction Friction Gaming Fiction Friction Gaming Digimobs World Next Order Digimobs World Next Order Reclamation - Hardcore Edition Reclamation - Hardcore Edition Friends United 2.1 Friends United 2.1 Horizon (New Dawn) Horizon (New Dawn) Tensura Pandemonium Official Tensura Pandemonium Official Cobblemon Homestead Cobblemon Homestead Monumental Experience - NeoForge Monumental Experience - NeoForge Forge of Eternity Forge of Eternity Matti's Skyblock Matti's Skyblock Create: Reatomized! Create: Reatomized! Super III Super III Atomized Atomized All the Simple All the Simple AllCreateMods AllCreateMods InfinityCraft Ultra InfinityCraft Ultra HeroesOfMultiverse HeroesOfMultiverse MI:Lost Favor MI:Lost Favor You Like Food? 2! You Like Food? 2! Xomembers Xomembers Naano Horizons - Utalyoa Edition Naano Horizons - Utalyoa Edition Crazy Holloween - The Darkest & Craziest Horror Adventure! Crazy Holloween - The Darkest & Craziest Horror Adventure! Space Race 5 Space Race 5 ButterSMP Official Pack ButterSMP Official Pack Dinosaurs and More  2 Dinosaurs and More 2 KOTD KOTD Splendid Ranching Splendid Ranching Modern Revolutions Skies Modern Revolutions Skies Creator Academy Based on Create Creator Academy Based on Create Infinity Pack 1 Infinity Pack 1 NoodlesSMP NoodlesSMP Clayblock Clayblock All Roads Lead to The Void All Roads Lead to The Void Pixelmon E2craft Pixelmon E2craft CrazyCraft Recreation CrazyCraft Recreation Flat Factory [F2] Flat Factory [F2] Secure Contain Profit Secure Contain Profit  VeritySurvival VeritySurvival Rizmotopia Rizmotopia Crazy Craft Reforged Crazy Craft Reforged HardRock Apocalypse - Plagueborn (HRAP) HardRock Apocalypse - Plagueborn (HRAP) Tensura Chronicles of Tempest Tensura Chronicles of Tempest Crafttomuck Crafttomuck PhoenixTech: Reloaded PhoenixTech: Reloaded Create: New Age Create: New Age TeamImura's DMZ (Dragon Mine Z Server) TeamImura's DMZ (Dragon Mine Z Server) Fossils and Archeology Expanded: Age of Fossils Fossils and Archeology Expanded: Age of Fossils Jaffa Factory 2 - Futura Edition Jaffa Factory 2 - Futura Edition WildLouna WildLouna Create Coasters Create Coasters Crafted Create Crafted Create RageCraft Revived RageCraft Revived

External Resources