Schema

A Schema defines the structure of a specific type of game data entity. It acts as a blueprint that outlines the fields (properties) associated with the entity, much like columns in a database table or cells in a spreadsheet. Schemas are central to organizing and modeling structured game data.

Name

The Name of a schema is used as an alternative identifier to the Id and is also used in generated source code as the name of the resulting class. Therefore, it must be a valid C-style identifier: it should start with a letter and include only Latin letters, digits, or underscores.

Schema names are also used as the name of the collection when storing or exporting data. It is recommended to use PascalCase and singular form for schema names.

Display Name

The Display Name is used in the UI and can contain any characters. There are no restrictions on alphabet or character set.

Type

The Type setting defines how instances (documents) of this schema are created and managed:

Normal: Standard behavior. Documents can be created in the root collection, embedded in other documents, or may be absent entirely.
Component: These documents can only be embedded within other documents. They do not appear in the main navigation menu.
Settings: A singleton-style schema. Only one root-level document can exist, and it cannot be embedded in other documents.

Display Text Template

The Display Text Template defines how documents of this schema are presented in the UI when a textual representation is needed—e.g., in dropdowns, reference lists, or relationship views.

Icon

The Icon is displayed next to the schema name in the navigation menu or selection dialogs within the UI.

Description

The Description helps other users understand the purpose of the schema. It is shown in the UI and is also included as a documentation comment in the generated source code for the corresponding class.

Group

The Group defines the hierarchical path of the schema in the left-hand navigation menu. It behaves similarly to a folder path, with sections separated by the / character.

Id Generator

The Id Generator setting defines how the Id Property is managed for this schema. If set to None, the Id property must be configured manually.

Properties

A list of Properties that define the fields associated with this schema.