Modonomicon Documentation

Modonomicon is an in-game documentation mod for Minecraft (version 1.21.1) designed to create interactive guides. It combines features from Patchouli and Thaumcraft's Thaumonomicon, offering two primary navigation modes: a 2D 'Quest/Advancement' style view and a traditional 'Index' style view. Key capabilities include:

• Data-driven creation: All books are created via datapacks, allowing both mod authors and modpack creators to add content.
• Extensibility: Supports mod-added features, such as custom recipe pages for specific crafting methods.
• Rich Text: Uses extended Markdown syntax for text styling.
• Diverse Page Types: Supports pages for text, recipes, images, and items.

Multiblocks in Modonomicon serve two primary purposes for developers:

1. Visual Documentation: They allow a multiblock structure to be displayed within a book and previewed in-world, helping players build specific shapes.
2. Functional Verification: They can be used programmatically to verify if a multiblock structure has been correctly constructed in the world, enabling the creation of custom multiblock machines.

Multiblocks in Modonomicon serve two primary purposes:

1. Visual Guidance: They allow you to display a multiblock structure within a book and provide an in-world preview to help players build specific shapes.
2. Functional Verification: They can be used programmatically to verify if a multiblock has been correctly constructed, enabling the creation of custom multiblock machines.

Multiblocks in Modonomicon serve two primary purposes:

1. Visual Representation: They allow a multiblock structure to be displayed in a book and previewed in-world, helping players build specific shapes.
2. Functional Verification: They can be used to verify if a multiblock is correctly constructed, enabling the creation of custom multiblock machines. This is handled via the MultiblockVerification class and the MultiblockRegistry#checkMultiblock() method.

Modonomicon is an in-game documentation mod for Minecraft (version 1.20.1) that combines features from Thaumcraft's Thaumonomicon and Patchouli. It allows mod developers and modpack creators to build interactive books using a data-driven approach via datapacks. Key capabilities include:

• Data-Driven Content: All books are created via datapacks, allowing both mods and modpacks to add content.
• Navigation Modes: Supports both a 2D "Quest/Advancement" style view and a traditional "Index" style view.
• Extensibility: Mods can extend the system to add custom features, such as specialized recipe pages for unique crafting methods.
• Rich Text & Media: Supports extended Markdown syntax for text styling and various page types for displaying recipes, images, and items.

Modonomicon content is structured in a four-tier hierarchy:

1. Book: The top-level container defined by book.json.
2. Categories: 2D 'Quest/Advancement'-style views that group multiple entries.
3. Entries: Individual items within a category that can be linked to other entries and contain one or more pages.
4. Pages: The actual content units within an entry used to display text, images, recipes, and other media.

Modonomicon books are organized in a strict hierarchy: a Book consists of Categories, each Category contains Entries, and each Entry contains Pages.

• Pages: Group closely related information (e.g., a furnace's description, its recipe, and an image).
• Entries: Group related pages together.
• Categories: Group related entries. Categories can be displayed in 'node mode' (node view), where entries appear as nodes on a 2D screen that can be connected with arrows to guide the player.

Modonomicon books are composed of four primary elements:

• book.json: Located in the root of the book folder, containing general settings for the book.
• Categories: 2D views (similar to Quest/Advancement screens) that group multiple entries together.
• Entries: Individual items belonging to a specific category. Entries can contain multiple pages and can be linked to other entries.
• Pages: The actual content containers within an entry used to display text, images, and recipes.

The Modonomicon datagen setup is split between common logic and platform-specific registration:

• /common/src/main/java/.../datagen/book: Contains the source code used to generate the book. This code is mod-loader independent and can be copied into any mod's datagen folder.
• /neo/src/main/java/.../datagen/DataGenerators.java: Handles the registration of the book provider and its connection to language providers. (Similar files exist for Forge and Fabric).
• /neo/src/generated/resources/data/.../demo/...: Contains the generated book definition JSON files.
• /neo/src/generated/resources/assets/.../lang/en_us.json: Contains the generated book texts. Note: Modpack creators should remove Modonomicon-specific functionality texts from this file before publishing as a resource pack.