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
Tropical Paradise Tropical Paradise Empyrean Expansion Empyrean Expansion [XM] xK0KLIN Modpack's [XM] xK0KLIN Modpack's Ashes and Iron Ashes and Iron Overcrafto Overcrafto Syntex Gaming Community Syntex Gaming Community Rust and Rituals Rust and Rituals Aeronautic Colonies Aeronautic Colonies Pino 4 Pino 4 Society Sunlit Valley Enhanced Society Sunlit Valley Enhanced Neos Colony Neos Colony Reino de Celeste Reino de Celeste A MAFIA SMP A MAFIA SMP Francis IV Francis IV From Mill to Mechanism From Mill to Mechanism Cobblemon Grand Journey Cobblemon Grand Journey Homer Pack Homer Pack NewPath - Echoes of the Wild NewPath - Echoes of the Wild CivCraft 2 CivCraft 2 Adventure & Horror Adventure & Horror A creative decorating dream. Create structures according to your imagination. A creative decorating dream. Create structures according to your imagination. Progress - Selects Progress - Selects Tech and Guns: Zombie warfare Tech and Guns: Zombie warfare Above SMP Above SMP HORYZONEA HORYZONEA Space Block Eclipse Space Block Eclipse Exlandia 5 Exlandia 5 Create Mons n Machines Create Mons n Machines Limbones Server Modpack Limbones Server Modpack Weedie's Industrial Fantasy Weedie's Industrial Fantasy All Those Tech All Those Tech Project OMEGA - Chaos Protocol Project OMEGA - Chaos Protocol  Technology Evolution  TE Technology Evolution TE The Sigmas Pack The Sigmas Pack ChaosCraft JS Edition ChaosCraft JS Edition MC Resonance Horizons MC Resonance Horizons Chris' Create Colonies Plus Chris' Create Colonies Plus Industrialization Lite Industrialization Lite Cogwork Genesis Cogwork Genesis Into The Crazy Into The Crazy All Of Create: 3 All Of Create: 3 Create Brassline Create Brassline Sublime Experience Sublime Experience Apotelesmatic Neoforge Apotelesmatic Neoforge Create Flightworks Create Flightworks IM - Industrial Magic IM - Industrial Magic OverGreg OverGreg AOR | All of the Random AOR | All of the Random Steamcreate2 Steamcreate2 Only Create Only Create Starborne create Starborne create Little Lattes Cafémon Little Lattes Cafémon Dwardsdog's Clockwork Conquest Dwardsdog's Clockwork Conquest Echo One Group Echo One Group Create Aeroexperience Create Aeroexperience MC-Ages MC-Ages Industrial Colony 2 Industrial Colony 2 Projeto Omega Projeto Omega asertopia asertopia Pickable Me Pickable Me Spiria Reincarnated Again! Spiria Reincarnated Again! PureMash Tech Lite PureMash Tech Lite Adefica T Adefica T TNIF (TECHNOLOGICAL INFECTION) TNIF (TECHNOLOGICAL INFECTION) Insurgence Insurgence Difficulty Curve Difficulty Curve Shitblock Shitblock Goofcraft 3 Goofcraft 3 LotaCraft: Lotaria LotaCraft: Lotaria FlatWorlds FlatWorlds Vanilla&Tech Vanilla&Tech Beyond Depth ( Zenith's Way ) Beyond Depth ( Zenith's Way ) Project Heroes Project Heroes Ferguson Expeditions Ferguson Expeditions Eternal of Legends Eternal of Legends LostCraft (2025) LostCraft (2025) Arkane 2 Arkane 2 TakoPack Colonies 2 TakoPack Colonies 2 Atumni Infinitum Atumni Infinitum Chronos Archives Chronos Archives Zuge [1.21.1] Zuge [1.21.1] Craft Colonies Craft Colonies CobbledMon CobbledMon DoomsDay Universe DoomsDay Universe Terceira Guerra Mundial BR Terceira Guerra Mundial BR StarbaseSMP - Apocalypse StarbaseSMP - Apocalypse CobbleFrontier CobbleFrontier A2SMP A2SMP Uiopik's Skyblock Uiopik's Skyblock TechBit TechBit Semi-realist Create Semi-realist Create CatzyCraft CatzyCraft Create: Endless Industry Create: Endless Industry Extra [Modified] Cobblemon Plus Extra [Modified] Cobblemon Plus Arcane Acres RPG 2 Arcane Acres RPG 2 Blue Skies & Black Smoke Blue Skies & Black Smoke Better Fireteam Better Fireteam Assembly Assembled | Server Assembly Assembled | Server Past Perfect Past Perfect Old Reliables 3.5 Old Reliables 3.5

External Resources