A book.json
file is what tells Modopedia the basic properties of a book such as the title, subtitle, type and many other properties. Without a book.json
, Modopedia will not be aware of your book existing and therefore be unable to load it.
Datapack Location
The book.json
for your book should be located in a datapack at data/<namespace>/modopedia/books/<book_id>.json
where namespace
is the ID of your mod or namespace of your modpack and book_id
is the ID of your book, both of these need to follow Minecraft's ResourceLocation rules. When referencing your book, for example on a book item, namespace:book_id
should be used.
JSON Schema
Heads up!
Item models for Modopedia books need to be placed inside the item/modopedia_books
folder in your resource pack to be loaded.
ID | Type | Required | Default | Description |
---|---|---|---|---|
title | String | ✓ | - | Title of the book, supports translation keys. |
subtitle | String | ✗ | - | Subtitle of the book, supports translation keys. |
type | BookType | ✗ | * | Type of book, this is further explained in Book Types. It will default to the modopedia:classic type with it's default values. |
landing_text | FString | ✗ | - | Landing text displayed on the book's front page. |
texture | ResourceLocation | ✗ | modopedia:default | GUI texture for this book. This is explained further in Book Textures |
model | ResourceLocation | ✗ | modopedia:item/modopedia_books/book_default | Item model for this book. These models must be placed in models/item/modopedia_books for Modopedia to load them for you. |
font | ResourceLocation | ✗ | modopedia:default | Default font for all formatted text in this book. Other options include minecraft:default and minecraft:uniform . |
text_colour | HString | ✗ | "000000" | Default colour for formatted text in this book. |
header_colour | HString | ✗ | "000000" | Default colour for headers in this book. |
line_width | Integer | ✗ | 100 | Default line width for formatted text in this book. |
creative_tab | ResourceLocation | ✗ | - | Creative tab this book should be added to. |
open_sound | ResourceLocation | ✗ | modopedia:book_open | Sound played when opening this book. |
flip_sound | ResourceLocation | ✗ | modopedia:book_flip | Sound played when turning pages in this book. |