GuideME - Unofficial Port

IMPORTANT! The official version 26.2 (alpha) is now available! -> https://www.curseforge.com/minecraft/mc-mods/guideme

GuideME – Unofficial 26.2 Port

This is an unofficial community port of GuideME for Minecraft 26.2.

This project is not an official release and is not maintained or supported by the original GuideME developers.

About

This project brings GuideME to Minecraft 26.2, allowing mods and modpacks that depend on GuideME to be used on the newer Minecraft version.

GuideME is a powerful guidebook framework for Minecraft mods and modpacks. It provides a flexible Markdown-based system for creating rich in-game documentation, including interactive content and 3D scenes.

The purpose of this project is to maintain Minecraft 26.2 compatibility until an official version for 26.2 becomes available.

Features

GuideME provides features such as:

- Markdown-based guidebook pages

- Interactive 3D scenes

- Smooth scrolling and advanced text layouts

- Cross-links between guidebook topics

- Recipe displays directly inside guidebooks

- Context-sensitive guidebook navigation

- Extensible APIs for mod developers

- Custom Markdown tags and widgets

- Support for additional content through resource packs and addons

Minecraft 26.2

This port updates GuideME for:

Minecraft: 26.2
Mod Loader: NeoForge
Environment: Client & Server

The goal is to preserve the functionality and compatibility of the original project while adapting it to the changes introduced with Minecraft 26.2.

Please report issues related specifically to this 26.2 port here rather than to the original GuideME developers.

Original Project

GuideME was originally created and is maintained by shartte / the Applied Energistics team.

Official GuideME CurseForge:
https://www.curseforge.com/minecraft/mc-mods/guideme

Please support the original project and its developers.

This port would not exist without their work.

⚠️ Important Disclaimer

This is an UNOFFICIAL COMMUNITY PORT.

It is not affiliated with, endorsed by, or supported by the original GuideME developers.

Temporary Project

This project exists only to provide GuideME compatibility for Minecraft 26.2 while no official 26.2 release is available.

Users should then migrate to the official GuideME release.

Source & Licensing

GuideME is open-source software.

This port is based on the original GuideME source code and contains modifications required for Minecraft 26.2 compatibility.

The original copyright notices and applicable licenses remain in effect.

The main GuideME code is distributed under the GNU Lesser General Public License v3 (LGPLv3). Additional bundled components and assets may be covered by their respective licenses.

The source code for this 26.2 port is made available in accordance with those license requirements.

All credit for the original GuideME project belongs to its original authors and contributors.

Credits

Original Project: GuideME
Original Author / Maintainer: shartte / Applied Energistics team
26.2 Port: Community-maintained unofficial port

Huge thanks to the original GuideME contributors for creating and maintaining the project.