Neoforge Knowledge Codex Mod FAQ
10 questions players actually ask, answered.
How do I create my first guidebook?
Create a new folder in your mod's `assets/modid/docs` directory, add a `_index.md` file with front matter (title, icon, category), then write your pages as Markdown files in that folder. The mod automatically discovers and caches your guides on startup.
What Markdown syntax does this mod support?
The mod supports headings, bold, italics, lists (ordered and unordered), tables, code blocks, images, and links. Callout boxes use special syntax like `:::tip` or `:::warning` to create colored info boxes.
How do I embed a crafting recipe in a guide page?
Use the recipe component syntax in your Markdown file to reference a crafting recipe by its registry name, and the mod will render the crafting grid with ingredients and output directly on the page.
Can I add clickable links and hover tooltips to my text?
Yes, use interactive text components to add hover tooltips that display extra information, and attach click actions to open URLs, copy text to chat, or suggest commands to the player.
How do I show a structure preview in my guidebook?
Reference a structure file (NBT format) using the structure component, and the mod will display a top-down preview with block counts, palette IDs, and entity data; hovering over blocks shows their exact coordinates.
Why are my guide pages not showing up in-game?
Check that your folder structure is correct (`assets/modid/docs/`), your `_index.md` file has valid front matter, and all Markdown files are in UTF-8 encoding; restart the game to force the mod to reload and cache your documents.
Does this mod support multiple languages?
Yes, create language-specific folders like `docs/en_us/` and `docs/fr_fr/` with translated Markdown files, and the mod automatically serves the correct language with fallback to English if a translation is missing.
Will guidebooks cause lag or stuttering when I open them?
No, the mod preloads and caches all documents during startup, so books open instantly with zero delay regardless of page size or complexity.
Can I organize a large guidebook into multiple sections or chapters?
Yes, create subdirectories within your `docs` folder and add an `_index.md` file to each one; the mod treats these as nested categories in your guidebook's navigation.
What should I do if my custom component isn't rendering correctly?
Verify the component syntax matches the mod's documentation (check for typos in registry names, file paths, and front matter), ensure referenced files exist, and check the game log for error messages that indicate what went wrong.