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

36,257,694

CurseForge ID

1173950

Modrinth Downloads

2,935,171

Modrinth ID

Ck4E7v7R

Last Updated

Sep 10, 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 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. ``` ![Example](https://cdn.modrinth.com/data/cached_images/6e2fe4965e8ddc6a440ffa085d7a5df88fbd7424.png)

Compatibility

Mod Loaders

Forge Neoforge

Game Versions

1.20.1 1.20.4 1.21.1 1.21.5 1.21.8 1.21.10 1.21.11 26.1-snapshot-1 26.1-snapshot-3 26.1-snapshot-4 +2 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,039)

Show fewer
Karmunism-Refugee Karmunism-Refugee All You Need 2 - AYN 2 All You Need 2 - AYN 2 Create&Greg 2 Create&Greg 2 BuildUp (NeoForge) BuildUp (NeoForge) Enchantments Enchantments The Song of Crafting The Song of Crafting Create - Tamed Frontiers Create - Tamed Frontiers PandaLand Pack PandaLand Pack Valley Chill Valley Chill Wheel of Mods 3 Wheel of Mods 3 Redwolf's Crazy World Redwolf's Crazy World Create Boundary Engineer Create Boundary Engineer EMERIS Endless Summer EMERIS Endless Summer CanarioLand 2 CanarioLand 2 All Ultimate Selection All Ultimate Selection NeoMinecolonies NeoMinecolonies Magecraft: A Gods Tale Magecraft: A Gods Tale Infinite Mayhem Infinite Mayhem Peace of Mind 21.1 Peace of Mind 21.1 HARDCORE EVOLUTIONS HARDCORE EVOLUTIONS TechFactory [TECH] TechFactory [TECH] Create Areo Naughts Create Areo Naughts Saturn SMP 2 Saturn SMP 2 Create Industrial Village Create Industrial Village Warspire Warspire SC Final Adventure - Machines SC Final Adventure - Machines BurningCube BurningCube TCG SMP - Prologue (Public) TCG SMP - Prologue (Public) Minecolonies Create - Aeronautics Colonies Minecolonies Create - Aeronautics Colonies PureSavage-with-shaders-and-rp PureSavage-with-shaders-and-rp Create Even Further Beyond Create Even Further Beyond GUILTY'S MEGAPACK GUILTY'S MEGAPACK Zenith Lite Zenith Lite TCC - Skyzone TCC - Skyzone Adventurecraft: Create Editon Adventurecraft: Create Editon Origins Of Cybertron Official Server Origins Of Cybertron Official Server KarmaCraft Chaos & bleibender Schaden KarmaCraft Chaos & bleibender Schaden Create Mech Create Mech Egregious Industrialization Egregious Industrialization Copper Country Furry Forge Copper Country Furry Forge Government Government Phantom Community Modpack Phantom Community Modpack Adventure's Awaits Adventure's Awaits Omega Created Technology Omega Created Technology Kat's Craft 2 Kat's Craft 2 Weedie's Undead Adventure Weedie's Undead Adventure Havoc & Haven - Blossoms and Banners Havoc & Haven - Blossoms and Banners LightCraft Season 3 LightCraft Season 3 Worlds Unbound Worlds Unbound All The Heros All The Heros Steamland - SP Steamland - SP Revelations Revelations Riders Race to Berk Riders Race to Berk Advenium 3 Advenium 3 Nightmarecraft and Complements Nightmarecraft and Complements BuddelTech BuddelTech Ride & Reign Ride & Reign InfinityMidCraft InfinityMidCraft Casino Block Casino Block PokeHarvest PokeHarvest The Oblivion verse The Oblivion verse The TaCZ x Iron's Spells 'n Spellbooks Crossoverpack The TaCZ x Iron's Spells 'n Spellbooks Crossoverpack The Old Kitchen The Old Kitchen EmberHorizon's Custom Pack EmberHorizon's Custom Pack Revitrix Revitrix SPELLCRAFT-SMP SPELLCRAFT-SMP Omniverse Heroes Omniverse Heroes Cobblemon Industrial revolution Cobblemon Industrial revolution Chaotic Modpack Chaotic Modpack the horror of the dwellers and more the horror of the dwellers and more Empires of Steam & Sky Empires of Steam & Sky Tita The Wizard And The Nuclear Apocalypse Tita The Wizard And The Nuclear Apocalypse Hero's N Villain's Reborn Hero's N Villain's Reborn Cobblemon Cursed Lake Cobblemon Cursed Lake jaaj jaaj GregTech SpeedRun GregTech SpeedRun Toky Craft Toky Craft Tensura Restricted Tensura Restricted Masters Of Aeronautics Masters Of Aeronautics RISAKU project RISAKU project Our Antarchy Craft Our Antarchy Craft Structural Ingenuity Structural Ingenuity Coziestcraft Coziestcraft Create Gurizes Aeronautic - [NeoForge] Create Gurizes Aeronautic - [NeoForge] OvermoddedCraft OvermoddedCraft Gregtech Reverberating Nexus Gregtech Reverberating Nexus Goon Crew Collection VR Goon Crew Collection VR capybara’s play oritech capybara’s play oritech Delusions Craft Delusions Craft Create - New Age Survival Create - New Age Survival Milk and Stuff: Remilked Milk and Stuff: Remilked MafiaCraft MafiaCraft Creating Sandwiches Creating Sandwiches Survival Refined Survival Refined Cosmotech Cosmotech WorldsEnd WorldsEnd Draconic Machinations Draconic Machinations FTC - Indie Games FTC - Indie Games GoatCraft BMC++ 4 [Forge] GoatCraft BMC++ 4 [Forge] Cave Factory --Reimagined-- Cave Factory --Reimagined--

External Resources