Setting Templates
Setting templates are used to extend custom data fields for characters and worlds. By defining templates, you can add exclusive properties to game objects without modifying the engine.
Feature Overview
- Create and manage custom property templates
- Support for multiple field types
- Define exclusive data structures for character or world objects
- Templates automatically appear in Character Designer and other modules
Template Concept
Each game world has its own unique setting requirements. For example, a fantasy RPG may need to record a character's "Magic Attribute" and "Race," while a school story may need to record "Class" and "Club."
Setting templates let you define these custom fields. Once created, they automatically appear in the Character Designer or other relevant modules for filling in.
Creating a Template
- Click New Template.
- Enter a template name (e.g., "Magic Settings," "Social Identity").
- Select the scope (Character or World).
- Add fields.
Field Types
Each template can contain multiple fields. The following types are supported:
| Type | Description | Use Case |
|---|---|---|
| Single-line Text | Short text input | Titles, nicknames |
| Multi-line Text | Long text input | Detailed descriptions, history |
| Number | Numeric input | Level, age, numeric attributes |
| Enum | Select from predefined options | Race, faction, blood type |
| Tags | Multiple tag selection | Skills, traits |
| Boolean | Yes/No toggle | Is noble, has magic |
| Entity Reference | Reference other entities in the project | Faction affiliation, related location |
Field Settings
Configure the following properties for each field:
- Key: Unique identifier for the field, used for internal reference.
- Label: Display name for the field.
- Type: Select from the types above.
- Required: Whether the field is required.
- Description: Explanatory text for the field to help users understand its purpose.
- Enum Options: For enum type only; defines the list of selectable options.
Managing Templates
Editing a Template
Select the template to edit in the template list, then modify the name, add or remove fields, and adjust field properties.
Deleting a Template
Delete unwanted templates. Note: After deleting a template, the corresponding data already filled in character or world objects will lose its template definition.
Using in Other Modules
Character Designer
Templates that apply to characters automatically appear in the Custom Settings area of the Character Designer. Fill in the fields defined in the template for each character.
World Objects
Templates that apply to worlds appear in the relevant world object editing interface.
Examples
Fantasy RPG Character Template
Create a character template named "Fantasy Attributes":
| Field | Type | Description |
|---|---|---|
| Race | Enum | Human / Elf / Dwarf / Orc |
| Class | Enum | Warrior / Mage / Ranger / Rogue |
| Level | Number | Character level |
| Magic Attribute | Tags | Fire / Water / Wind / Earth / Light / Dark |
| Noble Status | Boolean | Whether the character has a noble title |
| Biography | Multi-line Text | Character's detailed history |
School Story Character Template
Create a character template named "School Info":
| Field | Type | Description |
|---|---|---|
| Class | Single-line Text | e.g., 2-A |
| Club | Tags | Literature Club / Art Club / Basketball Club |
| Academic Performance | Enum | Excellent / Good / Average / Poor |
| Seat Number | Number | Seat number in the classroom |
Tips
- Complete template design during the project planning phase to avoid data mismatches from mid-project changes.
- Avoid modifying the key once set, as other references may depend on this identifier.
- Enum type is suitable for attributes with fixed, limited options; Tags type is suitable for attributes that may have multiple values.
- Add clear descriptions to fields to help other team members understand each field's purpose.