@opencharacter/5e-srd-5.1 0.1.0 → 0.3.0

package/pack.yaml

@@ -1,6 +1,6 @@
 id: 5e-srd-5.1
-version: 0.1.0
-specVersion: 0.1.0
+version: 0.3.0
+specVersion: 0.3.0
 license: CC-BY-4.0
 credit: >-
   This work includes material taken from the System Reference Document 5.1 (“SRD 5.1”) by

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@opencharacter/5e-srd-5.1",
-  "version": "0.1.0",
+  "version": "0.3.0",
   "description": "Open Character Format pack: the 5E System Reference Document 5.1.",
   "keywords": [
     "5e",
@@ -52,7 +52,7 @@
     "access": "public"
   },
   "devDependencies": {
-    "@opencharacter/engine": "0.1.0"
+    "@opencharacter/engine": "0.3.0"
   },
   "engines": {
     "node": ">=22"

package/rules/advancement.yaml

@@ -7,7 +7,30 @@ fields:
         : [0, 300, 900, 2700, 6500, 14000, 23000, 34000, 48000, 64000, 85000, 100000, 120000,
           140000, 165000, 195000, 225000, 265000, 305000, 355000][level.total]
   xp.levelUp: { type: boolean, formula: 'xp.nextLevel > 0 && xp.current >= xp.nextLevel' }
-  multiclass.qualified: { type: set, of: class }
+  # Multiclassing into a class needs 13 in each of its multiclassAll abilities and in one of its
+  # multiclassAny ones, when it lists any.
+  multiclass.qualified:
+    type: set
+    of: class
+    formula: >-
+      filterList(multiclass.classes,
+        !(x in multiclass.needs.str && abilities.str.score < 13)
+          && !(x in multiclass.needs.dex && abilities.dex.score < 13)
+          && !(x in multiclass.needs.con && abilities.con.score < 13)
+          && !(x in multiclass.needs.int && abilities.int.score < 13)
+          && !(x in multiclass.needs.wis && abilities.wis.score < 13)
+          && !(x in multiclass.needs.cha && abilities.cha.score < 13)
+          && (!(x in multiclass.oneOfListed)
+            || (x in multiclass.oneOf.str && abilities.str.score >= 13)
+            || (x in multiclass.oneOf.dex && abilities.dex.score >= 13)
+            || (x in multiclass.oneOf.con && abilities.con.score >= 13)
+            || (x in multiclass.oneOf.int && abilities.int.score >= 13)
+            || (x in multiclass.oneOf.wis && abilities.wis.score >= 13)
+            || (x in multiclass.oneOf.cha && abilities.cha.score >= 13)))
+  multiclass.classes: { type: set, of: class }
+  multiclass.oneOfListed: { type: set, of: class }
+  'multiclass.needs.{ability}': { type: set, of: class }
+  'multiclass.oneOf.{ability}': { type: set, of: class }
 
 display:
   fields:
@@ -16,62 +39,65 @@ display:
         groups: [summary],
         priority: 1,
         visibility: secondary,
+        showWhen: '!sheet.monster',
         with: [{ field: xp.nextLevel, as: max }],
       }
     xp.nextLevel:
-      { groups: [summary], priority: 2, visibility: secondary, showWhen: xp.nextLevel > 0 }
+      {
+        groups: [summary],
+        priority: 2,
+        visibility: secondary,
+        showWhen: '!sheet.monster && xp.nextLevel > 0',
+      }
     xp.levelUp: { hidden: true }
     multiclass.qualified: { hidden: true }
+    multiclass.classes: { hidden: true }
+    multiclass.oneOfListed: { hidden: true }
+    'multiclass.needs.{ability}': { hidden: true }
+    'multiclass.oneOf.{ability}': { hidden: true }
 
 effects:
-  - target: multiclass.qualified
+  # The families the qualification reads, from each class's multiclassAll and multiclassAny.
+  - { target: multiclass.classes, op: grant, value: { query: { type: class } } }
+  - target: multiclass.oneOfListed
+    op: grant
+    value: { query: { type: class, where: size(item.multiclassAny) > 0 } }
+  - target: multiclass.needs.str
     op: grant
-    value: { formula: '@classes.barbarian' }
-    when: abilities.str.score >= 13
-  - target: multiclass.qualified
+    value: { query: { type: class, where: "'str' in item.multiclassAll" } }
+  - target: multiclass.needs.dex
     op: grant
-    value: { formula: '@classes.bard' }
-    when: abilities.cha.score >= 13
-  - target: multiclass.qualified
+    value: { query: { type: class, where: "'dex' in item.multiclassAll" } }
+  - target: multiclass.needs.con
     op: grant
-    value: { formula: '@classes.cleric' }
-    when: abilities.wis.score >= 13
-  - target: multiclass.qualified
+    value: { query: { type: class, where: "'con' in item.multiclassAll" } }
+  - target: multiclass.needs.int
     op: grant
-    value: { formula: '@classes.druid' }
-    when: abilities.wis.score >= 13
-  - target: multiclass.qualified
+    value: { query: { type: class, where: "'int' in item.multiclassAll" } }
+  - target: multiclass.needs.wis
     op: grant
-    value: { formula: '@classes.fighter' }
-    when: abilities.str.score >= 13 || abilities.dex.score >= 13
-  - target: multiclass.qualified
+    value: { query: { type: class, where: "'wis' in item.multiclassAll" } }
+  - target: multiclass.needs.cha
     op: grant
-    value: { formula: '@classes.monk' }
-    when: abilities.dex.score >= 13 && abilities.wis.score >= 13
-  - target: multiclass.qualified
+    value: { query: { type: class, where: "'cha' in item.multiclassAll" } }
+  - target: multiclass.oneOf.str
     op: grant
-    value: { formula: '@classes.paladin' }
-    when: abilities.str.score >= 13 && abilities.cha.score >= 13
-  - target: multiclass.qualified
+    value: { query: { type: class, where: "'str' in item.multiclassAny" } }
+  - target: multiclass.oneOf.dex
     op: grant
-    value: { formula: '@classes.ranger' }
-    when: abilities.dex.score >= 13 && abilities.wis.score >= 13
-  - target: multiclass.qualified
+    value: { query: { type: class, where: "'dex' in item.multiclassAny" } }
+  - target: multiclass.oneOf.con
     op: grant
-    value: { formula: '@classes.rogue' }
-    when: abilities.dex.score >= 13
-  - target: multiclass.qualified
+    value: { query: { type: class, where: "'con' in item.multiclassAny" } }
+  - target: multiclass.oneOf.int
     op: grant
-    value: { formula: '@classes.sorcerer' }
-    when: abilities.cha.score >= 13
-  - target: multiclass.qualified
+    value: { query: { type: class, where: "'int' in item.multiclassAny" } }
+  - target: multiclass.oneOf.wis
     op: grant
-    value: { formula: '@classes.warlock' }
-    when: abilities.cha.score >= 13
-  - target: multiclass.qualified
+    value: { query: { type: class, where: "'wis' in item.multiclassAny" } }
+  - target: multiclass.oneOf.cha
     op: grant
-    value: { formula: '@classes.wizard' }
-    when: abilities.int.score >= 13
+    value: { query: { type: class, where: "'cha' in item.multiclassAny" } }
 
 followUps:
   - id: level-up
@@ -89,6 +115,7 @@ actions:
           - when: true
             flags: { maxBefore: hp.max }
       - id: class
+        tags: [level-up.class]
         kind: choice
         options:
           content:
@@ -98,6 +125,7 @@ actions:
                 && countCopies(copy.type == 'class' && !(copy.item in multiclass.qualified)) == 0)
         prefer: sumCopies(copy.state.level, copy.type == 'class' && copy.item == item.id)
       - id: gain
+        tags: [level-up.gain]
         kind: changes
         changes:
           - type: adjustState
@@ -110,6 +138,7 @@ actions:
             when: '!(steps.class.picked in classes.held)'
             entry: { item: steps.class.picked, state: { level: 1 } }
       - id: hitPoints
+        tags: [level-up.hit-points]
         kind: choice
         options: [{ id: roll }, { id: fixed }]
         recommend: "'fixed'"

package/rules/checks.yaml

@@ -177,7 +177,7 @@ situational:
 resultBands:
   dc:
     - { id: rolled, when: flags.dc < 0 }
-    - { id: success, when: roll.total >= flags.dc }
+    - { id: success, when: roll.total >= flags.dc, success: true }
     - { id: failure, when: true }
 
 actions:

package/rules/classes.yaml

@@ -39,7 +39,6 @@ fields:
   sacredWeapon.active: { type: boolean, input: true, default: false }
   hideInPlainSight.active: { type: boolean, input: true, default: false }
   foeSlayer.bonus: { type: integer, formula: 0 }
-  hunter.colossusSlayer: { type: boolean, formula: false }
   sneakAttack.dice: { type: integer, formula: 0 }
   sorcery.points: { type: integer, formula: 0 }
   sorcery.left:
@@ -49,8 +48,6 @@ fields:
         copy.type == 'class' && has(copy.state.sorceryPointsSpent))
   sorcery.shortRestRegain: { type: integer, formula: 0 }
   sorcery.metamagic: { type: boolean, formula: false }
-  draconic.damageType:
-    { type: enum, values: [none, acid, cold, fire, lightning, poison], formula: "'none'" }
   elementalAffinity.resistant: { type: boolean, input: true, default: false }
   dragonWings.active: { type: boolean, input: true, default: false }
   warlock.boons: { type: set, of: pactBoon }
@@ -59,14 +56,38 @@ fields:
       type: integer,
       formula: 'level.total >= 17 ? 4 : level.total >= 11 ? 3 : level.total >= 5 ? 2 : 1',
     }
-  eldritchBlast.range: { type: integer, formula: 120 }
   eldritchBlast.push: { type: integer, formula: 0 }
 
 contentTypes:
+  # The Hunter's options, by the feature that offers them.
+  hunterTactic:
+    grantOnly: true
+    copies: { max: 0 }
+    fields:
+      feature:
+        type: enum
+        values: [hunters-prey, defensive-tactics, multiattack, superior-hunters-defense]
+        required: true
+
+  metamagic:
+    grantOnly: true
+    copies: { max: 0 }
+    effects:
+      - { target: sorcery.metamagic, op: set, value: sorcery.left > 0 }
+
   invocation:
+    grantOnly: true
     copies: { max: 0 }
+    # An invocation usable once per rest keeps `used` on its pick.
+    effects:
+      - target: { steps: [rest.long] }
+        op: changes
+        when: has(self.used) && self.used
+        value:
+          changes: [{ type: setState, pick: owner, key: used, value: false }]
 
   pactBoon:
+    grantOnly: true
     copies: { max: 0 }
     effects:
       - target: warlock.boons

package/rules/combat.yaml

@@ -15,6 +15,7 @@ viewFields:
     combat.spellAttackersDisadvantage: { type: boolean, default: false }
     creature.type:
       type: enum
+      open: true
       values:
         [
           aberration,
@@ -139,7 +140,7 @@ situational:
   - id: colossusSlayer
     type: boolean
     default: false
-    available: hunter.colossusSlayer
+    available: "@hunter-tactics.colossus-slayer in picksOf('subclasses.hunter', 'hunters-prey')"
     rolls: [damage.weapon]
     effects:
       - target: { rolls: [damage.weapon] }
@@ -293,7 +294,7 @@ resultBands:
     - { id: critical, when: 'roll.kept[0] >= flags.crit' }
     - { id: natural-miss, when: 'roll.kept[0] == 1' }
     - { id: rolled, when: flags.ac < 0 }
-    - { id: hit, when: roll.total >= flags.ac }
+    - { id: hit, when: roll.total >= flags.ac, success: true }
     - { id: miss, when: true }
 
 actions:
@@ -754,6 +755,7 @@ actions:
   - id: breath-weapon
     tags: [breath-weapon]
     results: [breathed]
+    available: '!self.used'
     participants:
       target: {}
     steps:
@@ -788,6 +790,10 @@ actions:
               - save-half
               - { formula: "'save.' + item.save" }
               - { formula: "steps.saves.result == 'success' ? 'save-success' : 'save-failure'" }
+      - id: spend
+        kind: changes
+        changes:
+          - { type: setState, pick: self, key: used, value: true }
       - id: result
         kind: outcome
         result: "'breathed'"

package/rules/conditions.yaml

@@ -7,6 +7,7 @@ contentTypes:
       by:
         {
           type: enum,
+          open: true,
           values:
             [
               aberration,

package/rules/content-types.yaml

@@ -26,11 +26,13 @@ contentTypes:
               thunder,
             ],
           required: true,
+          open: true,
         }
       versatileDamage: { type: dice }
       normalRange: { type: integer }
       longRange: { type: integer }
-      ammunition: { type: enum, values: [arrow, blowgun-needle, crossbow-bolt, sling-bullet] }
+      ammunition:
+        { type: enum, values: [arrow, blowgun-needle, crossbow-bolt, sling-bullet], open: true }
       weight: { type: decimal } # pounds
       cost: { type: decimal } # gold pieces
     state:
@@ -38,9 +40,17 @@ contentTypes:
       attuned: { type: boolean, default: false }
       stowed: { type: boolean, default: false } # in an extradimensional container (equipment.yaml)
       quivered: { type: boolean, default: false } # in an Efficient Quiver (equipment.yaml)
+      usedToday: { type: set, of: string, default: [] }
     actions:
       - use: weapon-attack
     effects:
+      # An attuned item for other classes than the character's (attunementClasses).
+      - target: attunement.classUnmet
+        op: add
+        value: 1
+        when: >-
+          self.attuned && has(item.attunementClasses) && size(item.attunementClasses) > 0
+            && countList(item.attunementClasses, x in classes.held) == 0
       - id: magic-attack
         target: { rolls: [attack.melee, attack.ranged], from: self }
         op: add
@@ -77,8 +87,16 @@ contentTypes:
     state:
       attuned: { type: boolean, default: false }
       stowed: { type: boolean, default: false } # in an extradimensional container (equipment.yaml)
+      usedToday: { type: set, of: string, default: [] }
     # Every armor item has these effects; the shield switches off the first three (`suppress`).
     effects:
+      # An attuned item for other classes than the character's (attunementClasses).
+      - target: attunement.classUnmet
+        op: add
+        value: 1
+        when: >-
+          self.attuned && has(item.attunementClasses) && size(item.attunementClasses) > 0
+            && countList(item.attunementClasses, x in classes.held) == 0
       - id: base-ac
         target: combat.ac
         op: set
@@ -121,6 +139,25 @@ contentTypes:
     copies: { perItem: 1 }
     fields:
       hitDie: { type: dice, required: true }
+      # Its own starting-equipment action gives its starting kit.
+      startingKit: { type: boolean, default: false }
+      # The abilities multiclassing into it needs 13 in: all of these, and one of those.
+      multiclassAll: { type: set, of: string, default: [] }
+      multiclassAny: { type: set, of: string, default: [] }
+      # The abilities a random start raises first, in order.
+      abilityPriority:
+        type: list
+        of: field
+        unique: true
+        default:
+          [
+            abilities.str.score,
+            abilities.con.score,
+            abilities.dex.score,
+            abilities.wis.score,
+            abilities.cha.score,
+            abilities.int.score,
+          ]
     state:
       level: { type: integer, default: 1, min: 1, max: 20 }
       startingClass: { type: boolean, default: false }
@@ -131,16 +168,20 @@ contentTypes:
       - use: spend-hit-die
 
   subclass:
+    grantOnly: true
     copies: { max: 0 }
     fields:
       class: { type: id, of: class, required: true }
 
   fightingStyle:
+    grantOnly: true
     copies: { max: 0 }
 
-  feature: {}
+  feature:
+    grantOnly: true
 
   improvement:
+    grantOnly: true
     copies: { max: 0 }
 
   spell:
@@ -165,6 +206,7 @@ contentTypes:
               transmutation,
             ],
           required: true,
+          open: true,
         }
       classes: { type: set, of: class }
       ritual: { type: boolean }
@@ -221,6 +263,7 @@ contentTypes:
               slashing,
               thunder,
             ],
+          open: true,
         }
       damage: { type: dice }
       damageBonus: { type: integer }
@@ -248,6 +291,7 @@ contentTypes:
               slashing,
               thunder,
             ],
+          open: true,
         }
       damage2: { type: dice }
       upcast2Dice: { type: integer }
@@ -257,7 +301,8 @@ contentTypes:
       upcastHealDice: { type: integer }
       upcastHealBonus: { type: integer }
 
-  trait: {}
+  trait:
+    grantOnly: true
 
   race:
     copies: { max: 1 }
@@ -270,6 +315,7 @@ contentTypes:
       - { id: race, target: creature.race, op: set, value: item.id }
 
   subrace:
+    grantOnly: true
     copies: { max: 0 }
     fields:
       race: { type: id, of: race, required: true }
@@ -284,18 +330,32 @@ contentTypes:
 
   # Each ancestry item carries its resistance, since incoming-change tags can't be computed.
   draconicAncestry:
+    grantOnly: true
     copies: { max: 0 }
     fields:
       damageType: { type: enum, values: [acid, cold, fire, lightning, poison], required: true }
       area: { type: enum, values: [line, cone], required: true }
       save: { type: enum, values: [dex, con], required: true }
+    # Once until a short or long rest, on the ancestry's pick.
+    state:
+      used: { type: boolean, default: false }
     actions:
       - use: breath-weapon
+    effects:
+      - target: { steps: [rest.short, rest.long] }
+        op: changes
+        when: self.used
+        value:
+          changes: [{ type: setState, pick: owner, key: used, value: false }]
 
   background:
     copies: { max: 1 }
+    fields:
+      startingKit: { type: boolean, default: false }
 
   backgroundFeature:
+    grantOnly: true
     copies: { max: 0 }
 
-  feat: {}
+  feat:
+    grantOnly: true

package/rules/core.yaml

@@ -49,6 +49,7 @@ fields:
   creature.type:
     {
       type: enum,
+      open: true,
       values:
         [
           aberration,
@@ -110,6 +111,7 @@ fields:
         : creature.size == 'huge' ? 4 : creature.size == 'gargantuan' ? 8 : 1)
 
   classes.held: { type: set, of: class }
+  attunement.classUnmet: { type: integer, formula: 0 }
   creature.race: { type: string, formula: "''" }
   magicItems.ignoreRequirements: { type: boolean, formula: false }
 
@@ -118,22 +120,10 @@ fields:
 constraints:
   - id: attunement-requirement
     check: >-
-      magicItems.ignoreRequirements || countCopies(has(copy.state.attuned) && copy.state.attuned
-        && (('attunement.spellcaster' in copy.tags && spellcasting.casterLevel == 0 && pactSlots.max == 0)
-          || ('attunement.dwarf' in copy.tags && creature.race != @races.dwarf)
-          || (('attunement.barbarian' in copy.tags || 'attunement.bard' in copy.tags || 'attunement.cleric' in copy.tags || 'attunement.druid' in copy.tags || 'attunement.fighter' in copy.tags || 'attunement.monk' in copy.tags || 'attunement.paladin' in copy.tags || 'attunement.ranger' in copy.tags || 'attunement.rogue' in copy.tags || 'attunement.sorcerer' in copy.tags || 'attunement.warlock' in copy.tags || 'attunement.wizard' in copy.tags)
-            && !(('attunement.barbarian' in copy.tags && @classes.barbarian in classes.held)
-          || ('attunement.bard' in copy.tags && @classes.bard in classes.held)
-          || ('attunement.cleric' in copy.tags && @classes.cleric in classes.held)
-          || ('attunement.druid' in copy.tags && @classes.druid in classes.held)
-          || ('attunement.fighter' in copy.tags && @classes.fighter in classes.held)
-          || ('attunement.monk' in copy.tags && @classes.monk in classes.held)
-          || ('attunement.paladin' in copy.tags && @classes.paladin in classes.held)
-          || ('attunement.ranger' in copy.tags && @classes.ranger in classes.held)
-          || ('attunement.rogue' in copy.tags && @classes.rogue in classes.held)
-          || ('attunement.sorcerer' in copy.tags && @classes.sorcerer in classes.held)
-          || ('attunement.warlock' in copy.tags && @classes.warlock in classes.held)
-          || ('attunement.wizard' in copy.tags && @classes.wizard in classes.held))))) == 0
+      magicItems.ignoreRequirements || (attunement.classUnmet == 0
+        && countCopies(has(copy.state.attuned) && copy.state.attuned
+          && (('attunement.spellcaster' in copy.tags && spellcasting.casterLevel == 0 && pactSlots.max == 0)
+            || ('attunement.dwarf' in copy.tags && creature.race != @races.dwarf))) == 0)
   - id: attunement-limit
     check: countCopies(has(copy.state.attuned) && copy.state.attuned) <= 3
     data: