Keywords & Journals Quick Reference

Keywords Syntax

Custom Keywords

config MySystem {
    keywords {
        KeywordName summary: "Description text"
        KeywordName summary: "Description" icon: "fa-solid fa-icon" color: "#hex"
    }
}

Damage Type Keywords

DamageType damageTypeChoice choices: [
    Fire {color: "#dc2626", icon: "fa-solid fa-fire", summary: "Burns"},
    Ice {color: "#2563eb", icon: "fa-solid fa-snowflake"},
    Lightning {color: "#7c3aed", icon: "fa-solid fa-bolt"}
]

Status Effects Syntax

Basic Status

actor Character {
    status StatusName(svg: "path/to/icon.svg")
}

Conditional Status

actor Character {
    status Blessed(svg: "icons/svg/holy-symbol.svg", when: self.Faith > 5)
    status Stunned(svg: "icons/svg/dizzy.svg", when: self.Stunned)
}

Death Effect

The death keyword is a prefix on the status declaration. It marks this as the death effect, applied when the actor reaches 0 health. Only one death status per actor.

actor Character {
    death status Dead(svg: "icons/svg/skull.svg", when: self.HP <= 0)
}

Parameters Reference

Parameter	Purpose	Example
summary:	Description text (keywords)	summary: "Roll twice, take higher"
icon:	Font Awesome icon (keywords)	icon: "fa-solid fa-fire"
color:	Hex color code (keywords)	color: "#dc2626"
label:	Display name	label: "Alternative Name"
svg:	Status effect icon path	svg: "icons/svg/fire.svg"
when:	Conditional trigger (status)	when: self.HP <= 0

Generated Journal Structure

System Folder
└── System Name Journal
    ├── Keywords Page
    │   ├── Usage Information Box
    │   └── Keyword Entries (with badges)
    ├── Damage Types Page  
    │   ├── Effects Information Box
    │   └── Damage Type Entries (with badges)
    └── Status Effects Page
        ├── Usage Information Box
        └── Status Effect Entries (with conditions)

Condition Operators

Comparison	Preferred (word form)	Alternative (symbol)
Equal to	equals	==
Not equal to	!equals	!=
Less than	<	(same)
Greater than	>	(same)
Less than or equal	<=	(same)
Greater than or equal	>=	(same)

Best Practices

Keyword Design

✅ Keep descriptions concise - One clear sentence
✅ Use consistent colors - Match your game theme
✅ Choose meaningful icons - Visual recognition helps
✅ Group related keywords - Organize by mechanic type

Status Effects

✅ Test conditions - Ensure they trigger correctly
✅ Use descriptive names - Clear status identification
✅ Provide icons - Visual indicators for players
✅ Mark death effects - Use the death keyword

Journal Integration

✅ Enable in settings - "Create System Journal" must be on
✅ Check localization - All text can be translated
✅ Style with CSS - Use isdl- prefixed classes
✅ Link from sheets - Reference with @keyword syntax