---

English | 简体中文

Introduction

• GuideNH is an in-game guide framework for Minecraft 1.7.10
• It ports and extends GuideME-style Markdown documentation for GTNH-era modpacks.
• It is designed for authoring rich guide books directly from resource-pack style Markdown files.

Required Dependencies

• GTNHLib (>= 0.11.16)

Features

• Markdown pages with YAML frontmatter, navigation metadata, categories, anchors, tables, footnotes, Mermaid, LaTeX, charts, and highlighted text.
• MDX-style runtime tags such as <ItemLink>, <ItemImage>, <Recipe>, <GameScene>, <ContentTabs>, <BlockStats>, <Tooltip>, <KeyBind>, and <PlayerName>.
• Interactive 3D GameScene previews with block/entity placement, StructureLib import, Ponder playback, layer sliders, grid controls, annotations, and block statistics.
• Live guide editing mode with split editor/preview, toolbar actions, debounced saving, external-change handling, and resource-pack page creation.
• Multi-language guide folders with fallback, item index navigation, search, server integration, and resource reload support.

Authors

• Programmer: HFstudio
• Upstream inspiration: GuideME

License

• Code: LGPL-3.0
• Bundled third-party libraries keep their own licenses.

Wiki

• English Wiki
• 中文 Wiki
• Structure Export
• Runtime example resource pack

Quick Start

.\gradlew.bat spotlessApply
.\gradlew.bat build
.\gradlew.bat runClient

In game:

• Use /give Developer guidenh:guide to get the demo guide book.
• Hold G while hovering an indexed item to jump to its guide entry.
• Press F3+T to reload edited guide resources.

DefaultGuide

GuideNH automatically creates config/guidenh/DefaultGuide/ on the client. It also supports config/guidenh/DefaultGuide.zip as a standard full resource pack, and the zip is preferred when both exist.

This directory uses a native namespace-root layout:

config/guidenh/DefaultGuide/
`-- <modid>/
    `-- guidenh/
        |-- assets/
        |   `-- shared_structure.snbt
        |-- _en_us/
        |   `-- index.md
        `-- _zh_cn/
            `-- index.md

The directory starts empty. Add your own pages and assets there when you want a client-side default guide source.

If you use DefaultGuide.zip, use the normal full resource-pack layout:

config/guidenh/DefaultGuide.zip
`-- assets/
    `-- <modid>/
        `-- guidenh/
            |-- assets/
            |-- _en_us/
            `-- _zh_cn/

wiki/resourcepack/ remains the repository example resource pack. It keeps the outer assets/ directory because it is used for documentation and bundled examples.

Authoring Example

---
navigation:
  title: Machines
  parent: index.md
author: GuideNH
date: 2026-05-10
---

# Machines

Press <KeyBind action="key.attack" /> to interact.

<GameScene width="220" height="150" interactive={true}>
  <Block id="minecraft:furnace" />
  <BlockStats corner="topRight" maxWidth="120" maxHeight="72" />
</GameScene>

Develop

Guide Folder

assets/<modid>/guidenh/
|-- assets/
|   `-- shared_structure.snbt
|-- _en_us/
|   |-- index.md
|   `-- machines.md
`-- _zh_cn/
    |-- index.md
    `-- machines.md

DefaultGuide Folder

config/guidenh/DefaultGuide/
`-- <modid>/
    `-- guidenh/
        |-- assets/
        |   `-- shared_structure.snbt
        |-- _en_us/
        |   `-- index.md
        `-- _zh_cn/
            `-- index.md

DefaultGuide Zip

config/guidenh/DefaultGuide.zip
`-- assets/
    `-- <modid>/
        `-- guidenh/
            |-- assets/
            |   `-- shared_structure.snbt
            |-- _en_us/
            |   `-- index.md
            `-- _zh_cn/
                `-- index.md

Register A Guide

Guide.builder(new ResourceLocation("yourmod", "guidenh")).build();

Verification

.\gradlew.bat spotlessApply
.\gradlew.bat build --rerun-tasks

Credits

Thanks to persephone for providing the icon textures!

Thanks to the following developers for their contributions to GuideNH:

GuideNH is based on ideas from GuideME, distributed under LGPL-3.0. It also uses open-source libraries including SnakeYAML, Apache Lucene, Apache Commons Lang, FlatBuffers Java, and JLaTeXMath.