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
Kreyc's Overgrown Pack Kreyc's Overgrown Pack One Block to Rule Them All One Block to Rule Them All Absolute Industrialization Absolute Industrialization Most the Mods official Mod pack Most the Mods official Mod pack Dark Chocolate Edition Dark Chocolate Edition Suscraft Recharged Suscraft Recharged Scientific Rocketry 2 Scientific Rocketry 2 Immortal Craft Reimagined Immortal Craft Reimagined Mystic's Monstrosity - Immersive Edition Mystic's Monstrosity - Immersive Edition Better Survival (BSurvival2) Better Survival (BSurvival2) Origins Of Cybertron Official Server Origins Of Cybertron Official Server Maor The King Of The Light Maor The King Of The Light theajpack! theajpack! TNIF (TECHNOLOGICAL INFECTION) TNIF (TECHNOLOGICAL INFECTION) Gregtech Reverberating Nexus Gregtech Reverberating Nexus Create Industrial Village Create Industrial Village PureMash Tech PureMash Tech [Updated] Farming [Updated] Farming Tensura Rebirth Tensura Rebirth Pebblecraft: Stratum Pebblecraft: Stratum Enchantments Enchantments Please Send Resources Please Send Resources SC Final Adventure - Machines SC Final Adventure - Machines Cobbled Industries 2 Cobbled Industries 2 Sabixonas Sabixonas All Of Create: 3 All Of Create: 3 NeoMinecolonies NeoMinecolonies Only Create It Only Create It Comfy SkyBlock 3 - Rebirth of the Void (RotV) Comfy SkyBlock 3 - Rebirth of the Void (RotV) Create - Means of Production Create - Means of Production HenryCraft HenryCraft Pino 4 Pino 4 Superhero and Ben10 SMP Superhero and Ben10 SMP Projeto Omega Projeto Omega Create Mech Create Mech Alamaos' Code: AgriTech Alamaos' Code: AgriTech BuildUp (NeoForge) BuildUp (NeoForge) Tensura Industries Tensura Industries KaijuuCraft KaijuuCraft RatProject RatProject Warcrimes Central Warcrimes Central StormCore StormCore Gearfall Gearfall Copper Country Furry Forge Copper Country Furry Forge Pixelmon Adventure and RPG Pixelmon Adventure and RPG StealthCraft Season 2 StealthCraft Season 2 Tensura Restricted Tensura Restricted Mystical goo Mystical goo IkeTech 2.0 IkeTech 2.0 CatzyCraft CatzyCraft The Oblivion verse The Oblivion verse asertopia asertopia Tensura: Unbound (with Tensura: Reincarnated, Tensura: Unique Monsters and More Addons) Tensura: Unbound (with Tensura: Reincarnated, Tensura: Unique Monsters and More Addons) The Iron Frontier The Iron Frontier Karmunism-Refugee Karmunism-Refugee Aiko's Dimensions Aiko's Dimensions Xomaps Decay Xomaps Decay Worlds Unbound Worlds Unbound Lumin Origins Lumin Origins Nightmarecraft and Complements Nightmarecraft and Complements Factory Age Factory Age AllTheAvaritia ATA1 AllTheAvaritia ATA1 Gray's Tensura Season 1 Gray's Tensura Season 1 Create Continents Create Continents Concatenation Lumineth Concatenation Lumineth Goon Crew Collection Goon Crew Collection Enigmatica 10 - Bosses Unleashed Enigmatica 10 - Bosses Unleashed  Technology Evolution  TE Technology Evolution TE CleanCraft by ACUL [Neoforged] CleanCraft by ACUL [Neoforged] Infinity Questing Systems Infinity Questing Systems Bomb's Tech Utopia Bomb's Tech Utopia Projet N-Tech Projet N-Tech MysteriaSMP MysteriaSMP N-Tech RockBlock 4 N-Tech RockBlock 4 Glowstone Galaxy Create Edition Glowstone Galaxy Create Edition Measured Infinity Measured Infinity All The Heros All The Heros VACraft VACraft Alex's Pack 1.21.1 Alex's Pack 1.21.1 Havoc & Haven - Blossoms and Banners Havoc & Haven - Blossoms and Banners TechFactory [TECH] TechFactory [TECH] Random House - Interestelar Random House - Interestelar Aeternis Aeternis Egregious Industrialization Egregious Industrialization [TaCZ] Unofficial Enhancement Modpack [TaCZ] Unofficial Enhancement Modpack Goon Crew Collection VR Goon Crew Collection VR MewmiCraft MewmiCraft MayraLand MayraLand Revitrix Revitrix Nightmare-Pack Sky Unlockt Nightmare-Pack Sky Unlockt All You Need 2 - AYN 2 All You Need 2 - AYN 2 BecksCraft BecksCraft Aeronautic Colonies Aeronautic Colonies Voloron 4 Voloron 4 Cobblemon aBunchaMods Cobblemon aBunchaMods Toky Craft Toky Craft AstroGregExsilium AstroGregExsilium Build Secure Protect Build Secure Protect Forge & Frontier [FORGE] Forge & Frontier [FORGE] Guns, Dragons, and Death! Guns, Dragons, and Death!

External Resources