Skip to main content

Book Structure

Each Modonomicon Book consists of Categories, Entries and Pages. Entries are grouped into Categories, which are grouped into the Book itself. Pages are part of the Entries and represent the actual content of the book, they can be used to display text, images, recipes and more.

The file structure looks as follows:

  • data/<mod_id>/modonomicon/books/<book_id>/
    • book.json
    • categories/
      • <category_id1>.json
      • <category_id2>.json
      • ...
    • entries/
      • <category_id1>
        • <entry_id1>.json
        • <entry_id2>.json
        • ...
      • <category_id2>
        • <entry_id3>.json
        • <entry_id4>.json
        • ...

Book.json

The book.json file contains the general settings for the book. It is located in the root of the book folder.
See Book.json for details.

Categories

Categories

Categories are a type of "Quest/Advancement"-style 2D view. A book consists of one or more categories, and each category can contain multiple entries that can be linked to each other.
See Categories for details.

Entries

Entries

Each entry is part of one category and consists of multiple pages, and may be linked to other entries.
See Entries for details.

Pages

Pages

Pages are placed inside entries and represent the actual content of the book. They can be used to display text, images, recipes and more.
See Page Types for details.