Styles and look¶

Every page type works in either style, so you can switch a book between them with one key. This page covers the styles, then what in book.json changes how a book looks; its colours are on Colours.

Styles¶

Set with "style" in book.json.

In both styles, other players within 16 blocks see the book in the reader's hands. A handheld book is shown at the spread being read, its leaves turning as the reader turns them.

Mods can add more styles with GuideStyles.register. A book naming a style that no mod provides is shown as a screen book.

Style keys¶

{
  "name": "Field Journal",
  "style": "handheld",
  "tilt": 10,
  "distance": 0.7,
  "page_turn": "flat",
  "handheld": { "look_around": true, "walk": false }
}

Textures¶

Both styles are drawn from texture layers. They are grey or white and tinted by the book's colours, so one set suits any book. textures names a book's own; any left out keep the default.

{
  "textures": {
    "page": "mymod:textures/book/parchment.png",
    "backdrop": "mymod:textures/book/desk.png"
  }
}

Layout¶

layout moves what sits around a page's content, in page pixels. Any value left out keeps its default. Values outside the range are clamped.

{
  "layout": {
    "tabs": { "x": 0, "y": 6, "spacing": 2 },
    "turn_buttons": { "x": 11, "y": 21 },
    "page_numbers": { "x": 0, "y": 17 }
  }
}

Models¶

The book item is drawn as a bound book in three dimensions in the hand, on the ground and in item frames, and as a flat icon in inventory slots. models changes what is drawn:

{
  "models": {
    "item": "mymod:handbook",
    "open": "mymod:handbook_open",
    "cover": "mymod:guide/handbook_cover",
    "hands": true,
    "gui": "model"
  }
}

The older "item_model" key at the top of book.json still works in place of models.item.

Where item and open point depends on the version:

Cover models¶

A cover model is a model in the block and item model format, at assets/<namespace>/models/<path>.json. It is laid on the outside of each board, mirrored on the left one:

• x runs from 0 at the spine to 16 at the board's outer edge, y from 0 at its foot to 16 at its head, and z from 0 on the board outwards, in the same units as x.
• Faces with "tintindex": 0 take the cover colour; "tintindex": 1 the book's accent.
• An element with "board": "front" or "board": "back" sits on that board only.
• An element whose name contains #shut holds the book shut, like a strap or clasp: it unlatches first as the book opens and is gone once it lies open.
• An element whose name contains #open shows only once the book lies open.
• An element whose name contains #spine wraps round the spine and bends with it as the cover opens.

Item model helpers¶

These are for item model definitions on 26.1 and later:

• folios:guide_cover tint: the cover colour of the book the stack names. With "part": "accent", the book's accent instead. One model can then suit every book.
• folios:guide_cover_text special model: the book's name and subtitle lettered on the cover. Placed in the model's own units with x (default 8), title_y (11.5), subtitle_y (4.25), z (10.21) and width (8.5), or by "markers": "<model id>": a model whose elements named #title, #subtitle and #summary mark where each line goes, centred on the element's face and sized to it.

{
  "model": {
    "type": "minecraft:composite",
    "models": [
      {
        "type": "minecraft:model",
        "model": "mymod:item/handbook",
        "tints": [
          { "type": "folios:guide_cover" },
          { "type": "folios:guide_cover", "part": "accent" }
        ]
      },
      {
        "type": "minecraft:special",
        "base": "mymod:item/handbook",
        "model": { "type": "folios:guide_cover_text", "markers": "mymod:item/handbook" }
      }
    ]
  }
}

Cover lettering¶

cover_text places the book's name (title), subtitle and summary on the cover of the book item and of a handheld book. Places are in the item model's units: the default cover runs from 3 to 13 across and from 1 (its foot) to 15 (its head) up.

summary takes the same keys, with the subtitle's defaults. A book that says nothing keeps where its item model puts the lettering.

{
  "cover_text": {
    "title": { "x": 8, "y": 11.6, "size": 1.15, "width": 6.4 },
    "subtitle": { "y": 4.05, "size": 0.85 }
  }
}

Reveal effects¶

A page's content appears once its leaf is down, through a reveal effect. Everything drawn on the page takes part, including items, scenes and pages added by other mods. A spread's two pages reveal together across the fold.

Set it for the whole book in book.json, or for one entry with reveal in the entry's file. A bare name means folios:<name>.

"reveal": "folios:ink"

"reveal": { "effect": "folios:burn", "seconds": 1.2, "once": true }

"reveal": { "effect": "folios:runes", "seconds": 1.2, "unread": true }

Mods can add effects with GuideReveals.register.