!logo for guidenh

Introduction

GuideNH is an in-game guide and documentation framework, ported from and extended based on GuideME and Sisuo.

It is mainly used to provide manuals, tutorials, and information pages for other mods or modpacks. It supports writing page content directly in Markdown and rendering it in-game as a guide system with navigation, search, page jumping, recipe display, and interactive scenes.

This mod can also be used for in-game documentation, and it extends the original framework with additional runtime tags, scene presentation capabilities, and extensible APIs.

---

Main Features

For Players

• Provides a smooth scrolling in-game reading interface
• Supports multi-page guides, hyperlinks, and navigation between pages
• Supports key-based navigation; indexed items can be opened directly by pressing "G"
• Supports Create-style "thinking/exploration" demonstrations for step-by-step showing of structures, processes, and operations
• Supports interactive 3D scenes with annotations, allowing intuitive visualization of blocks, entities, and structures
• Supports displaying recipes, usage information, tooltips, images, and formulas within pages
• Supports multilingual pages, allowing multiple languages within the same guide system

For Developers

• Write guide pages using Markdown, with frontmatter for navigation and metadata
• Extend inline and block-level content using a custom tag system
• Embed recipes, item icons, interactive scenes, tooltips, key prompts, and more
• Supports extended content such as Mermaid diagrams, LaTeX formulas, charts, and code blocks
• Supports custom indexing for fast lookup by item, category, or other attributes
• Allows adding pages and content via resource packs or plugins
• Provides rich extension APIs for integrating custom recipe displays, indexing systems, and special rendering logic