Installation

Installation

This page covers the repository layout and the development flow for the built-in tutorial guide shipped by GuideNH.

Runtime Guide Source

GuideNH also creates config/guidenh/DefaultGuide/ on the client as an empty runtime-loaded directory for your own guide content.

GuideNH also accepts config/guidenh/DefaultGuide.zip as a normal full resource pack. If both the zip and the directory exist, the zip is preferred.

The runtime guide is authored from wiki/resourcepack/, not from src/main/resources/assets/....

The built-in example guide now lives directly under:

• wiki/resourcepack/assets/guidenh/guidenh/

The example guide content then continues inside language folders such as:

• wiki/resourcepack/assets/guidenh/guidenh/_en_us/
• wiki/resourcepack/assets/guidenh/guidenh/_zh_cn/

Build Output

During processResources, the project copies everything under wiki/resourcepack/assets/ directly into the mod jar resource tree. The bundled guide therefore ships inside the jar as normal mod resources such as:

• assets/guidenh/guidenh/_en_us/index.md
• assets/guidenh/guidenh/_zh_cn/index.md
• assets/guidenh/guidenh/assets/example_structure.snbt

DefaultGuide Layout

DefaultGuide uses a native namespace-root layout instead of an outer assets/ directory:

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

Use DefaultGuide for client-local runtime content. Use wiki/resourcepack/ when editing the repository example pack that gets bundled into the jar.

DefaultGuide.zip uses the standard full resource-pack layout with an outer assets/ directory:

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

Development Loop

1. Edit runtime pages and assets under wiki/resourcepack/.
2. Edit human documentation under wiki/*.md.
3. For fast guide-content iteration, use the live preview flow from Live Preview.
4. Rebuild resources or rerun the client when you are not using live preview, or when you changed code/build logic.

What Not To Do

• Do not put in-game MDX tags directly into the GitHub Wiki pages unless they are inside fenced code blocks.
• Do not add new built-in guide source files directly under src/main/resources/assets/...; author them from wiki/resourcepack/assets/....
• Do not reintroduce _manifest.json or resource-pack zip wrapping for runtime guide pages; the loader now scans the resource tree directly.

Related Pages

• Getting Started
• Live Preview
• Guide Page Format
• Examples