Wiki 9Minecraft Wiki 9Minecraft

Neoforge Knowledge Codex Wiki & Guide

Java EditionModGuides 4FAQ 10Related mods 60

Adds guidebook items for in-game knowledge and crafting reference.

DownloadNeoforge Knowledge Codex

Get the files on 9Minecraft

Contents (6)
  1. Guides
  2. Items
  3. Configuration
  4. Frequently asked questions
  5. Gallery
  6. You May Also Like

Guides

Step-by-step, in-game.

Add Interactive Tooltips and Clickable TextCreating Hover Tooltips Make your guide more interactive by adding tooltips that appear when players hover over text.…Create Your First Guidebook PageSetting Up a New Guide To create a custom guidebook, you need to add Markdown files to your mod's documentation…Display Crafting Recipes in Your GuideEmbedding Recipe Previews The Knowledge Codex mod lets you show crafting recipes directly on guide pages without…Preview Structures and View Block DetailsDisplaying Structure Previews The Knowledge Codex mod includes a structure viewer that shows top-down layouts of…

Items

Ageratum Guidebook

Configuration

Every setting in the mod config file, with what it changes.

OptionWhat it does
allow_code_block_line_content_line_breaksAllow Code Block Line Content Line BreaksAllow line breaks in code block content
bread_crumbs_has_labelBread Crumbs Has LabelDo breadcrumbs record jumps from sidebar tabs
enable_previewEnable PreviewWhether to enable preview mode (enabling it will allow real-time previews of changes to documents in the specified path)
item_binding_hold_duration_msItem Binding Hold Duration MsHold duration (milliseconds) for W-key item binding navigation, default 750ms
preview_pathPreview PathPreview mode path
scaleScaleThe scaling ratio of the interface
share_guide_only_in_teamShare Guide Only In TeamShare your guide only with player from the same team
show_code_block_line_numbersShow Code Block Line NumbersShow line numbers in code blocks

Frequently asked questions

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.