Modules

A module is a .zip archive that defines the structure of a character sheet and how the values of the automated fields are derived. It must contain the following files:

├── meta.json
├── sheet_definition.lua
└── static_data.lua

Meta

Contains the basic information of the module.

{
  "name": "Guide to Everything",
  "system": "D&D 5E",
  "version": "0.2",
  "author": "Xanathar"
}

Sheet Definition

Contains the structure and mechanics of the character sheet. The script must return a CharacterSheet object.

Static Data

Static data is a secondary lua script that returns a table that can be referenced in the lambdas calculating the values of fields in the character sheet. This is useful for separating the mechanics and structure of the character sheet (sheet_definition.lua) and larger chunks of static values and text (e.g. descriptions, common values etc.).

The contents of static_data.lua and sheet_definition.lua are combined into a single final lua script before evaluation.