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,918,575

CurseForge ID

1173950

Modrinth Downloads

3,291,887

Modrinth ID

Ck4E7v7R

Last Updated

Nov 6, 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,139)

Show fewer
All the Mods 10 - ATM10 All the Mods 10 - ATM10 All the Mods 9 - ATM9 All the Mods 9 - ATM9 All the Mods 10: To the Sky   ATM10SKY All the Mods 10: To the Sky ATM10SKY All the Mods 9 - To the Sky - atm9sky All the Mods 9 - To the Sky - atm9sky Craftoria Craftoria FTB StoneBlock 4 FTB StoneBlock 4 All the Mons - ATMons All the Mons - ATMons MC Eternal 2 MC Eternal 2 TerraFirmaGreg-Modern TerraFirmaGreg-Modern FTB OceanBlock 2 FTB OceanBlock 2 Linggango Linggango MineColonies: Dimensional Adventure MineColonies: Dimensional Adventure All the Mods 11 - ATM11 All the Mods 11 - ATM11 Prehistoric World - Dinosaurs, Adventure & Quests | NEW PREHISTORY UPDATE! Prehistoric World - Dinosaurs, Adventure & Quests | NEW PREHISTORY UPDATE! Star Technology Star Technology Project Architect 2 Project Architect 2 New Game - An Improved Experience | 1.21 UPDATE! New Game - An Improved Experience | 1.21 UPDATE! Liminal Industries Liminal Industries Reclamation - Reclaim the World! Reclamation - Reclaim the World! Lapito's Galacticraft Lapito's Galacticraft Seaopolis: Submerged Seaopolis: Submerged Slightly Flavoured Slightly Flavoured FTB Skies 2 FTB Skies 2 Age of Fate Age of Fate [TaCZ] Timeless and Classics Zero Guns + addons and other mods [TaCZ] Timeless and Classics Zero Guns + addons and other mods Essentials Mods [FORGE] - 1.21 RELEASE! Essentials Mods [FORGE] - 1.21 RELEASE! Beyond Cosmo Beyond Cosmo Techopolis 3 Techopolis 3 New Simple Mods - Easy to Understand | 1.21 UPDATE! New Simple Mods - Easy to Understand | 1.21 UPDATE! Prehistoric World Prehistoric World Monumental Experience Monumental Experience Project Infinity 0.1 Project Infinity 0.1 More Animals [FORGE] - 1.21 UPDATE! More Animals [FORGE] - 1.21 UPDATE! Monifactory Monifactory Jurassic World Reborn II Jurassic World Reborn II FTB Evolution FTB Evolution 机械动力:更多附属与优化 Creat : More Attachments and Optimization 机械动力:更多附属与优化 Creat : More Attachments and Optimization Ultimate Lucky Oneblock Ultimate Lucky Oneblock CABIN: Create Above & Beyond In Newer CABIN: Create Above & Beyond In Newer Create Chronicles: Bosses and Beyond Create Chronicles: Bosses and Beyond TNP Limitless 8 - LL8 TNP Limitless 8 - LL8 Desolate Planet - A Crash Landing Remake Desolate Planet - A Crash Landing Remake More Decorations [FORGE] - 1.21 UPDATE! More Decorations [FORGE] - 1.21 UPDATE! Farmopolis Farmopolis [MODIFIED] Cobblemon: PLUS [MODIFIED] Cobblemon: PLUS The Last War - Guns And Adventure (Survivor's World with Guns) | QUESTS UPDATE! The Last War - Guns And Adventure (Survivor's World with Guns) | QUESTS UPDATE! Ozone Skyblock Reborn Ozone Skyblock Reborn Ancient Kingdoms 3 Ancient Kingdoms 3 FTB Skies 2 Aero FTB Skies 2 Aero Create 2 Mekanism: Sky Edition 2 Create 2 Mekanism: Sky Edition 2 TNP Limitless 7 - LL7 TNP Limitless 7 - LL7 Create on a Potato PC: Ultimate Create on a Potato PC: Ultimate All the Mods 10 Aeronautics All the Mods 10 Aeronautics Create Aeronautics - Skybound | Create Aeronautics & Create Addons with Quests Create Aeronautics - Skybound | Create Aeronautics & Create Addons with Quests The Pioneers The Pioneers BTH - Beyond The Horizon BTH - Beyond The Horizon All The Mods - Gravitas² All The Mods - Gravitas² MYTHCRAFT 5 MYTHCRAFT 5 BETTER FANTASY - Overture BETTER FANTASY - Overture Horrorland 2 - Psychological and Classic Horror Modpack (with Horror Quests) Horrorland 2 - Psychological and Classic Horror Modpack (with Horror Quests) All the Magic - Arcana All the Magic - Arcana Contained Opolis (A Space Adventure) Contained Opolis (A Space Adventure) FTB Presents: Direwolf20 - Season 14 FTB Presents: Direwolf20 - Season 14 Seaopolis Submerged 2 Seaopolis Submerged 2 Mayview (with Cobblemon!) Mayview (with Cobblemon!) More Realistic [FORGE] - 1.21 UPDATE! More Realistic [FORGE] - 1.21 UPDATE! Island Adventure - Complete Overhaul | Now with Quests! Island Adventure - Complete Overhaul | Now with Quests! Enigmatica 10 - E10 Enigmatica 10 - E10 FTB Presents Architect's Exodus FTB Presents Architect's Exodus Technical Electrical Technical Electrical Verdant Idea Verdant Idea GregTech Community Pack Modern GregTech Community Pack Modern Concatenation Concatenation Skyopolis: Evolved Skyopolis: Evolved More Biomes [FORGE] - 1.21 UPDATE! More Biomes [FORGE] - 1.21 UPDATE! MineColonies - Create & Conquer MineColonies - Create & Conquer Ice and Fire Magic Ice and Fire Magic All the Mods 10 Lite All the Mods 10 Lite Solo Leveling - Shadows Solo Leveling - Shadows Roguelike Adventures and Dungeons 3 Roguelike Adventures and Dungeons 3 Cookiemon - Pokemon Cobblemon RPG & Cookies Cookiemon - Pokemon Cobblemon RPG & Cookies Opolis Inc Opolis Inc Izakji's Zombie Apocalypse II Izakji's Zombie Apocalypse II Create: Delight Remake Create: Delight Remake Modded Together Modded Together From Magic To Tech From Magic To Tech NeoTech Reborn NeoTech Reborn More Dungeons [FORGE] - QUALITY UPDATE! More Dungeons [FORGE] - QUALITY UPDATE! Agmundr - Zombie Apocalypse Agmundr - Zombie Apocalypse Frozen Apocalypse | Survive the Ice Age Apocalypse Frozen Apocalypse | Survive the Ice Age Apocalypse Sky Greg Sky Greg Fractured Opolis Fractured Opolis Naruto Ninshu Origins Anime Naruto Ninshu Origins Anime Beebeeblock_The_Skyhive Beebeeblock_The_Skyhive All Of Create All Of Create Exosphere 2 Exosphere 2 Kingdoms and Colonies Rebirth Kingdoms and Colonies Rebirth FNAF - Fazcraft Reimagined | Based on FNAF! FNAF - Fazcraft Reimagined | Based on FNAF! Create Evolution - With Create 6.0 and Quests! | +35 Create Addons Create Evolution - With Create 6.0 and Quests! | +35 Create Addons Compression Compression

External Resources