Examples

Examples

GuideNH already ships a runtime example guide in wiki/resourcepack/. This page maps the important example files to the feature areas they demonstrate.

Core Example Pages

Runtime file	What it demonstrates
.../_en_us/index.md	frontmatter, item ids, recipes, item/block images, command links, tooltips, scenes, annotations
.../_en_us/markdown.md	plain markdown features and tables
.../_en_us/rendering.md	block-level rendering and layout behavior
.../_en_us/structure.md	<Structure> usage and coordinate format
.../_en_us/japanese.md	navigation child example
.../_en_us/subpage.md	navigation / linking example

Asset Examples

Runtime file	Purpose
wiki/resourcepack/assets/guidenh/guidenh/_en_us/test1.png	page-local image example
wiki/resourcepack/assets/guidenh/guidenh/assets/example_structure.snbt	rooted shared structure asset for <ImportStructure>

Example Snippets

Frontmatter + Navigation

item_ids:
  - guidenh:guide
navigation:
  title: Root
  icon_texture: test1.png

Relative Image

![Test Image](test1.png)

Rooted Structure Asset

<ImportStructure src="/assets/example_structure.snbt" />

Scene Annotation Tooltip

<DiamondAnnotation pos="0.5 2.2 0.5" color="#FFD24C">
  ### Activated Beacon
  <RecipeFor id="minecraft:furnace" />
</DiamondAnnotation>

Recipe Filter

<RecipesFor id="minecraft:redstone_torch" input="minecraft:stick&minecraft:redstone" limit="1" />

When To Use Which Example

• start with markdown.md if you are validating parser basics
• use index.md when testing mixed runtime features together
• use structure.md when you only need static block layout previews
• use example_structure.snbt when you need a reusable imported structure asset

Recommended Learning Order

1. Getting Started
2. Guide Page Format
3. Tags Reference
4. GameScene
5. Annotations
6. Recipes