Skip to content

Localization

ABKQPO edited this page Apr 25, 2026 · 3 revisions

Localization

GuideNH supports localized guide pages and localized guide assets.

Folder Layout

Runtime localization is folder-based:

wiki/resourcepack/assets/<modid>/guidenh/
|-- _en_us/
|   `-- index.md
`-- _zh_cn/
    `-- index.md

Language folders are recognized only in the underscored form. Plain folders such as en_us/ and zh_cn/ are no longer treated as localization roots.

Page Lookup Order

For each requested page id, GuideNH tries:

  1. _<current language>/<page>
  2. if the current language is not the guide default language, _<default language>/<page>
  3. <page> without a language folder

In practice, you should keep page files in underscored language folders and rely on the default language as the main fallback.

Asset Lookup Order

Guide assets use a slightly richer fallback order:

  1. _<current language>/<path>
  2. if the current language is not the guide default language, _<default language>/<path>
  3. <path>

This makes it possible to localize images or texture-like assets when needed.

Search And Language

Search documents store both the raw Minecraft language and the analyzer language used for Lucene. If the current Minecraft language is not mapped to a known analyzer, search falls back to English tokenization.

Ignore Translation Config

GuideNH exposes a client configuration option named Ignore Guide Translations. When enabled, the original guide language is used regardless of the current UI language.

Authoring Advice

  • always keep one fully complete default language
  • translate pages first, then translate assets only when text is embedded in the asset
  • avoid language-specific asset filenames when a rooted shared asset would do

Example

wiki/resourcepack/assets/guidenh/guidenh/_en_us/index.md
wiki/resourcepack/assets/guidenh/guidenh/_zh_cn/index.md
wiki/resourcepack/assets/guidenh/guidenh/_en_us/test1.png
wiki/resourcepack/assets/guidenh/guidenh/_zh_cn/test1.png

Related Pages

Clone this wiki locally