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

package/README.md

@@ -14,6 +14,9 @@ out.
 pnpm add @opencharacter/engine @opencharacter/5e-srd-5.1
 ```
 
+This release needs spec 0.3: `@opencharacter/engine` 0.3.0 or later. An engine for an older
+spec refuses it (`spec-version-unsupported`).
+
 The package's default export is the built pack (a `PackRelease`), and `i18n/en` its English
 text:
 
@@ -28,9 +31,9 @@ const { ruleset } = loaded;
 
 // A new character, made by the random creation start: every pick is drawn, so it finishes.
 const blank = {
-  specVersion: '0.2.0',
+  specVersion: '0.3.0',
   id: 'new-character',
-  packs: [{ id: '5e-srd-5.1', version: '0.2.0' }],
+  packs: [{ id: '5e-srd-5.1', version: '0.3.0' }],
   creating: true,
 };
 const created = startAction(ruleset, blank, {
@@ -241,7 +244,8 @@ Where the SRD is unclear or silent, the pack reads it this way:
   run the attacks they name; legendary actions spend their cost; recharge and per-day actions
   are copies with their own state; Spellcasting and Innate Spellcasting cast with the printed
   numbers; the vampire and the lycanthropes change form. Languages only monsters speak aren't
-  offered to players.
+  offered to players. A monster's sheet leaves out experience points, character level (at 0) and
+  death saves, and shows carrying weight only once it carries something.
 - **Resting:** `death-save`, `spend-hit-die`, `short-rest` and `long-rest` (spent hit dice back
   up to half the total level, the player choosing the classes).
 - **Follow-ups:** concentration checks, a failed death save from damage at 0 hit points,
@@ -269,6 +273,52 @@ Where the SRD is unclear or silent, the pack reads it this way:
 - **Sheet layout:** display groups for actions and content, with units (feet, pounds, gold
   pieces, miles per hour) and a compact `summary` view.
 
+## Add-on packs
+
+A pack that depends on this one can add content of its types, and it flows into the same
+processes:
+
+- **Classes** take part in creation, random starts and multiclassing through item fields: a
+  `kit` action (`listed: false`, a `random` parameter) with `startingKit: true` gives the
+  starting equipment; `abilityPriority` lists a random start's abilities, best first (`abilities.str.score`, …);
+  `multiclassAll` and `multiclassAny` name the abilities multiclassing into it needs 13 in. Like a
+  core class, it carries the `multiclass` prerequisite
+  (`(self.startingClass && self.level == level.total) || item.id in multiclass.qualified`).
+- **Backgrounds** bring their starting equipment the same way (`startingKit` and a `kit` action).
+- **Magic items** and magic weapon or armor templates restricted to classes list them in
+  `attunementClasses`.
+- **Metamagic options** are `metamagic` content and the Hunter's options `hunterTactic` content
+  (`feature` names the choice that offers them). Containers add to `carrying.stowCapacity`,
+  `carrying.stowUnlimited` or `carrying.quivers`, and content resets its uses on a rest with a
+  `changes` effect on the `rest.long` or `rest.short` step. A weapon tagged `quiver.javelin` goes
+  in an Efficient Quiver's javelin compartment.
+- **Open enums** (`extendEnums`): weapon `damageType` and `ammunition`, gear `category` and
+  `ammunition`, tool, vehicle and magic item `category`, spell `school`, `damageType` and
+  `damage2Type`, monster `subtype`, and monster action `damageType`, `damage2Type` and
+  `saveDamageType`, and the `item-power` action's `damageType`
+  (`5e-srd-5.1:actions.item-power.params.damageType`). A new damage type also needs its tag
+  (`damage.sonic`), declared and named in the add-on.
+- **Creature types:** a new one goes in `5e-srd-5.1:fields.creature.type`, the monster's
+  `creatureType`, a condition's `by` (`types.condition.state.by`) and the Arrow of Slaying's
+  `slays` (`magic-items.arrow-of-slaying.state.slays`); an attack reads the target's type through
+  an open view field, so a target of the added type is attacked as any other.
+- **Choices** (`extendChoices`): a class's listed choices (skills, fighting styles, expertise)
+  take values and items; choices over a type (subclasses, spells, feats) offer the add-on's
+  content already.
+- **Naming what an add-on adds:** it names each added value, option or key in its own text,
+  under the key this pack would use, and `createText` finds it there when the app passes the
+  ruleset's `enumOrigins`, `optionOrigins` and `familyOrigins`. For example,
+  `sonic` added to `5e-srd-5.1:types.weapon.fields.damageType` is
+  `types.weapon.fields.damageType.values.sonic.name: Sonic` (through `enumOrigins`).
+- **Step tags** for rules-level `option` and `changes` effects: `creation.race`,
+  `creation.subrace`, `creation.class`, `creation.background`, `creation.method` and
+  `creation.finish` (guided and random creation), `level-up.class`, `level-up.hit-points` and
+  `level-up.gain`, `rest.long` and `rest.short`, and the attack's `weapon-hit` and
+  `ammunition`.
+
+Still closed: the abilities, skills, weapon and armor categories and conditions are the game's
+fixed sets.
+
 ## Limitations
 
 Of the 152 class and subclass features, 8 have no mechanics, and 63 of the 318 magic items are

package/content/backgrounds/acolyte.yaml

@@ -1,5 +1,7 @@
 id: backgrounds.acolyte
 type: background
+fields:
+  startingKit: true
 effects:
   - { target: proficiencies.skills, op: grant, value: { tag: skill.insight } }
   - { target: proficiencies.skills, op: grant, value: { tag: skill.religion } }
@@ -11,3 +13,23 @@ choices:
     unique: languages
     from: { type: language, where: "!('secret' in item.tags) && !('monster' in item.tags)" }
     eligible: '!(item.id in proficiencies.languages) || item.id in choice.picks'
+actions:
+  - id: kit
+    listed: false
+    params:
+      random: { type: boolean, default: false }
+    steps:
+      - id: acolyteSymbol
+        kind: choice
+        options: { content: { type: gear, where: "item.category == 'holy-symbol'" } }
+        random: params.random
+        changes:
+          - { type: addItem, entry: { item: picked.id } }
+      - id: acolyteKit
+        kind: changes
+        changes:
+          - { type: addItem, entry: { item: "'gear.book'" } }
+          - { type: addItem, entry: { item: "'gear.incense'", quantity: 5 } }
+          - { type: addItem, entry: { item: "'gear.vestments'" } }
+          - { type: addItem, entry: { item: "'gear.common-clothes'" } }
+          - { type: addItem, entry: { item: "'gear.pouch'" } }

package/content/classes/barbarian.yaml

@@ -2,6 +2,17 @@ id: classes.barbarian
 type: class
 fields:
   hitDie: 1d12
+  startingKit: true
+  abilityPriority:
+    [
+      abilities.str.score,
+      abilities.con.score,
+      abilities.dex.score,
+      abilities.wis.score,
+      abilities.cha.score,
+      abilities.int.score,
+    ]
+  multiclassAll: [str]
 state:
   rageSpent: { type: integer, default: 0, min: 0 }
   relentlessRageSpent: { type: integer, default: 0, min: 0 }
@@ -57,3 +68,49 @@ choices:
   - id: primal-path
     from: { type: subclass, where: 'item.class == @classes.barbarian' }
     when: self.level >= 3
+actions:
+  - id: kit
+    listed: false
+    params:
+      random: { type: boolean, default: false }
+    steps:
+      - id: barbarianWeapon
+        kind: choice
+        options:
+          - id: greataxe
+            changes:
+              - { type: addItem, entry: { item: "'weapons.greataxe'", equipped: true } }
+          - id: martial-melee
+        recommend: options[0]
+        random: params.random
+      - id: barbarianMartial
+        kind: choice
+        when: "steps.barbarianWeapon.picked == 'martial-melee'"
+        options:
+          content: { type: weapon, where: "item.category == 'martial' && item.range == 'melee'" }
+        random: params.random
+        changes:
+          - { type: addItem, entry: { item: picked.id, equipped: true } }
+      - id: barbarianSecond
+        kind: choice
+        options:
+          - id: two-handaxes
+            changes:
+              - type: addItem
+                entry: { item: "'weapons.handaxe'", quantity: 2, equipped: true }
+          - id: simple
+        recommend: options[0]
+        random: params.random
+      - id: barbarianSimple
+        kind: choice
+        when: "steps.barbarianSecond.picked == 'simple'"
+        options: { content: { type: weapon, where: "item.category == 'simple'" } }
+        random: params.random
+        changes:
+          - { type: addItem, entry: { item: picked.id, equipped: true } }
+      - id: barbarianKit
+        kind: changes
+        changes:
+          - { type: addItem, entry: { item: "'gear.explorers-pack'" } }
+          - type: addItem
+            entry: { item: "'weapons.javelin'", quantity: 4, equipped: true }

package/content/classes/bard.yaml

@@ -2,6 +2,17 @@ id: classes.bard
 type: class
 fields:
   hitDie: 1d8
+  startingKit: true
+  abilityPriority:
+    [
+      abilities.cha.score,
+      abilities.dex.score,
+      abilities.con.score,
+      abilities.wis.score,
+      abilities.int.score,
+      abilities.str.score,
+    ]
+  multiclassAll: [cha]
 state:
   bardicInspirationSpent: { type: integer, default: 0, min: 0 }
 prerequisites:
@@ -132,3 +143,60 @@ choices:
   - id: bard-college
     from: { type: subclass, where: 'item.class == @classes.bard' }
     when: self.level >= 3
+actions:
+  - id: kit
+    listed: false
+    params:
+      random: { type: boolean, default: false }
+    steps:
+      - id: bardWeapon
+        kind: choice
+        options:
+          - id: rapier
+            changes:
+              - { type: addItem, entry: { item: "'weapons.rapier'", equipped: true } }
+          - id: longsword
+            changes:
+              - { type: addItem, entry: { item: "'weapons.longsword'", equipped: true } }
+          - id: simple
+        recommend: options[0]
+        random: params.random
+      - id: bardSimple
+        kind: choice
+        when: "steps.bardWeapon.picked == 'simple'"
+        options: { content: { type: weapon, where: "item.category == 'simple'" } }
+        random: params.random
+        changes:
+          - { type: addItem, entry: { item: picked.id, equipped: true } }
+      - id: bardPack
+        kind: choice
+        options:
+          - id: diplomats-pack
+            changes: [{ type: addItem, entry: { item: "'gear.diplomats-pack'" } }]
+          - id: entertainers-pack
+            changes: [{ type: addItem, entry: { item: "'gear.entertainers-pack'" } }]
+        recommend: options[0]
+        random: params.random
+      - id: bardInstrument
+        kind: choice
+        options:
+          - id: lute
+            changes: [{ type: addItem, entry: { item: "'tools.lute'" } }]
+          - id: other-instrument
+        recommend: options[0]
+        random: params.random
+      - id: bardOtherInstrument
+        kind: choice
+        when: "steps.bardInstrument.picked == 'other-instrument'"
+        options:
+          content:
+            type: tool
+            where: "item.category == 'musical-instrument' && item.id != @tools.lute"
+        random: params.random
+        changes:
+          - { type: addItem, entry: { item: picked.id } }
+      - id: bardKit
+        kind: changes
+        changes:
+          - { type: addItem, entry: { item: "'armor.leather'", equipped: true } }
+          - { type: addItem, entry: { item: "'weapons.dagger'", equipped: true } }

package/content/classes/cleric.yaml

@@ -2,6 +2,17 @@ id: classes.cleric
 type: class
 fields:
   hitDie: 1d8
+  startingKit: true
+  abilityPriority:
+    [
+      abilities.wis.score,
+      abilities.con.score,
+      abilities.str.score,
+      abilities.dex.score,
+      abilities.cha.score,
+      abilities.int.score,
+    ]
+  multiclassAll: [wis]
 state:
   channelDivinitySpent: { type: integer, default: 0, min: 0 }
   divineIntervention: { type: enum, values: [ready, failed, answered], default: ready }
@@ -40,3 +51,75 @@ choices:
   - id: divine-domain
     from: { type: subclass, where: 'item.class == @classes.cleric' }
     when: self.level >= 1
+actions:
+  - id: kit
+    listed: false
+    params:
+      random: { type: boolean, default: false }
+    steps:
+      - id: clericWeapon
+        kind: choice
+        sheet: proposed
+        options:
+          - id: mace
+            changes:
+              - { type: addItem, entry: { item: "'weapons.mace'", equipped: true } }
+          - id: warhammer
+            when: '@weapons.warhammer in proficiencies.weapons'
+            changes:
+              - { type: addItem, entry: { item: "'weapons.warhammer'", equipped: true } }
+        recommend: options[0]
+        random: params.random
+      - id: clericArmor
+        kind: choice
+        sheet: proposed
+        options:
+          - id: scale-mail
+            changes:
+              - { type: addItem, entry: { item: "'armor.scale-mail'", equipped: true } }
+          - id: leather-armor
+            changes:
+              - { type: addItem, entry: { item: "'armor.leather'", equipped: true } }
+          - id: chain-mail
+            when: "'heavy' in proficiencies.armor"
+            changes:
+              - { type: addItem, entry: { item: "'armor.chain-mail'", equipped: true } }
+        recommend: options[0]
+        random: params.random
+      - id: clericRanged
+        kind: choice
+        options:
+          - id: light-crossbow
+            changes:
+              - type: addItem
+                entry: { item: "'weapons.light-crossbow'", equipped: true }
+              - { type: addItem, entry: { item: "'gear.crossbow-bolts'", quantity: 20 } }
+          - id: simple
+        recommend: options[0]
+        random: params.random
+      - id: clericSimple
+        kind: choice
+        when: "steps.clericRanged.picked == 'simple'"
+        options: { content: { type: weapon, where: "item.category == 'simple'" } }
+        random: params.random
+        changes:
+          - { type: addItem, entry: { item: picked.id, equipped: true } }
+      - id: clericPack
+        kind: choice
+        options:
+          - id: priests-pack
+            changes: [{ type: addItem, entry: { item: "'gear.priests-pack'" } }]
+          - id: explorers-pack
+            changes: [{ type: addItem, entry: { item: "'gear.explorers-pack'" } }]
+        recommend: options[0]
+        random: params.random
+      - id: clericSymbol
+        kind: choice
+        options: { content: { type: gear, where: "item.category == 'holy-symbol'" } }
+        random: params.random
+        changes:
+          - { type: addItem, entry: { item: picked.id } }
+      - id: clericKit
+        kind: changes
+        changes:
+          - { type: addItem, entry: { item: "'armor.shield'", equipped: true } }

package/content/classes/druid.yaml

@@ -2,6 +2,17 @@ id: classes.druid
 type: class
 fields:
   hitDie: 1d8
+  startingKit: true
+  abilityPriority:
+    [
+      abilities.wis.score,
+      abilities.con.score,
+      abilities.dex.score,
+      abilities.int.score,
+      abilities.cha.score,
+      abilities.str.score,
+    ]
+  multiclassAll: [wis]
 state:
   wildShapeSpent: { type: integer, default: 0, min: 0 }
   naturalRecoveryUsed: { type: boolean, default: false }
@@ -113,3 +124,53 @@ choices:
   - id: druid-circle
     from: { type: subclass, where: 'item.class == @classes.druid' }
     when: self.level >= 2
+actions:
+  - id: kit
+    listed: false
+    params:
+      random: { type: boolean, default: false }
+    steps:
+      - id: druidFirst
+        kind: choice
+        options:
+          - id: wooden-shield
+            changes:
+              - { type: addItem, entry: { item: "'armor.shield'", equipped: true } }
+          - id: simple
+        recommend: options[0]
+        random: params.random
+      - id: druidSimple
+        kind: choice
+        when: "steps.druidFirst.picked == 'simple'"
+        options: { content: { type: weapon, where: "item.category == 'simple'" } }
+        random: params.random
+        changes:
+          - { type: addItem, entry: { item: picked.id, equipped: true } }
+      - id: druidWeapon
+        kind: choice
+        options:
+          - id: scimitar
+            changes:
+              - { type: addItem, entry: { item: "'weapons.scimitar'", equipped: true } }
+          - id: simple-melee
+        recommend: options[0]
+        random: params.random
+      - id: druidSimpleMelee
+        kind: choice
+        when: "steps.druidWeapon.picked == 'simple-melee'"
+        options:
+          content: { type: weapon, where: "item.category == 'simple' && item.range == 'melee'" }
+        random: params.random
+        changes:
+          - { type: addItem, entry: { item: picked.id, equipped: true } }
+      - id: druidFocus
+        kind: choice
+        options: { content: { type: gear, where: "item.category == 'druidic-focus'" } }
+        random: params.random
+        changes:
+          - { type: addItem, entry: { item: picked.id } }
+      - id: druidKit
+        kind: changes
+        changes:
+          - { type: addItem, entry: { item: "'armor.leather'", equipped: true } }
+          - { type: addItem, entry: { item: "'gear.explorers-pack'" } }

package/content/classes/fighter.yaml

@@ -2,6 +2,17 @@ id: classes.fighter
 type: class
 fields:
   hitDie: 1d10
+  startingKit: true
+  abilityPriority:
+    [
+      abilities.str.score,
+      abilities.con.score,
+      abilities.dex.score,
+      abilities.wis.score,
+      abilities.cha.score,
+      abilities.int.score,
+    ]
+  multiclassAny: [str, dex]
 state:
   secondWindUsed: { type: boolean, default: false }
   actionSurgeSpent: { type: integer, default: 0, min: 0 }
@@ -57,3 +68,67 @@ choices:
     when: self.startingClass
     effects:
       - { target: proficiencies.skills, op: grant, value: { formula: pick.value } }
+actions:
+  - id: kit
+    listed: false
+    params:
+      random: { type: boolean, default: false }
+    steps:
+      - id: fighterArmor
+        kind: choice
+        options:
+          - id: chain-mail
+            changes:
+              - { type: addItem, entry: { item: "'armor.chain-mail'", equipped: true } }
+          - id: leather-longbow
+            changes:
+              - { type: addItem, entry: { item: "'armor.leather'", equipped: true } }
+              - { type: addItem, entry: { item: "'weapons.longbow'", equipped: true } }
+              - { type: addItem, entry: { item: "'gear.arrows'", quantity: 20 } }
+        recommend: options[0]
+        random: params.random
+      - id: fighterWeapons
+        kind: choice
+        options:
+          - id: martial-and-shield
+            changes:
+              - { type: addItem, entry: { item: "'armor.shield'", equipped: true } }
+          - id: two-martial
+        recommend: options[0]
+        random: params.random
+      - id: fighterMartial
+        kind: choice
+        options: { content: { type: weapon, where: "item.category == 'martial'" } }
+        random: params.random
+        changes:
+          - { type: addItem, entry: { item: picked.id, equipped: true } }
+      - id: fighterMartial2
+        kind: choice
+        when: "steps.fighterWeapons.picked == 'two-martial'"
+        options: { content: { type: weapon, where: "item.category == 'martial'" } }
+        random: params.random
+        changes:
+          - { type: addItem, entry: { item: picked.id, equipped: true } }
+      - id: fighterRanged
+        kind: choice
+        options:
+          - id: light-crossbow
+            changes:
+              - type: addItem
+                entry: { item: "'weapons.light-crossbow'", equipped: true }
+              - { type: addItem, entry: { item: "'gear.crossbow-bolts'", quantity: 20 } }
+          - id: two-handaxes
+            changes:
+              - type: addItem
+                entry: { item: "'weapons.handaxe'", quantity: 2, equipped: true }
+        recommend: options[0]
+        random: params.random
+      - id: fighterPack
+        kind: choice
+        options:
+          - id: dungeoneers-pack
+            changes: [{ type: addItem, entry: { item: "'gear.dungeoneers-pack'" } }]
+          - id: explorers-pack
+            changes: [{ type: addItem, entry: { item: "'gear.explorers-pack'" } }]
+        recommend: options[0]
+        random: params.random

package/content/classes/monk.yaml

@@ -2,6 +2,17 @@ id: classes.monk
 type: class
 fields:
   hitDie: 1d8
+  startingKit: true
+  abilityPriority:
+    [
+      abilities.dex.score,
+      abilities.wis.score,
+      abilities.con.score,
+      abilities.str.score,
+      abilities.int.score,
+      abilities.cha.score,
+    ]
+  multiclassAll: [dex, wis]
 state:
   kiSpent: { type: integer, default: 0, min: 0 }
   wholenessUsed: { type: boolean, default: false }
@@ -66,3 +77,39 @@ choices:
   - id: monastic-tradition
     from: { type: subclass, where: 'item.class == @classes.monk' }
     when: self.level >= 3
+actions:
+  - id: kit
+    listed: false
+    params:
+      random: { type: boolean, default: false }
+    steps:
+      - id: monkWeapon
+        kind: choice
+        options:
+          - id: shortsword
+            changes:
+              - { type: addItem, entry: { item: "'weapons.shortsword'", equipped: true } }
+          - id: simple
+        recommend: options[0]
+        random: params.random
+      - id: monkSimple
+        kind: choice
+        when: "steps.monkWeapon.picked == 'simple'"
+        options: { content: { type: weapon, where: "item.category == 'simple'" } }
+        random: params.random
+        changes:
+          - { type: addItem, entry: { item: picked.id, equipped: true } }
+      - id: monkPack
+        kind: choice
+        options:
+          - id: dungeoneers-pack
+            changes: [{ type: addItem, entry: { item: "'gear.dungeoneers-pack'" } }]
+          - id: explorers-pack
+            changes: [{ type: addItem, entry: { item: "'gear.explorers-pack'" } }]
+        recommend: options[0]
+        random: params.random
+      - id: monkKit
+        kind: changes
+        changes:
+          - type: addItem
+            entry: { item: "'weapons.dart'", quantity: 10, equipped: true }

package/content/classes/paladin.yaml

@@ -2,6 +2,17 @@ id: classes.paladin
 type: class
 fields:
   hitDie: 1d10
+  startingKit: true
+  abilityPriority:
+    [
+      abilities.str.score,
+      abilities.cha.score,
+      abilities.con.score,
+      abilities.wis.score,
+      abilities.dex.score,
+      abilities.int.score,
+    ]
+  multiclassAll: [str, cha]
 state:
   divineSenseSpent: { type: integer, default: 0, min: 0 }
   layOnHandsSpent: { type: integer, default: 0, min: 0 }
@@ -74,3 +85,68 @@ choices:
   - id: sacred-oath
     from: { type: subclass, where: 'item.class == @classes.paladin' }
     when: self.level >= 3
+actions:
+  - id: kit
+    listed: false
+    params:
+      random: { type: boolean, default: false }
+    steps:
+      - id: paladinWeapons
+        kind: choice
+        options:
+          - id: martial-and-shield
+            changes:
+              - { type: addItem, entry: { item: "'armor.shield'", equipped: true } }
+          - id: two-martial
+        recommend: options[0]
+        random: params.random
+      - id: paladinMartial
+        kind: choice
+        options: { content: { type: weapon, where: "item.category == 'martial'" } }
+        random: params.random
+        changes:
+          - { type: addItem, entry: { item: picked.id, equipped: true } }
+      - id: paladinMartial2
+        kind: choice
+        when: "steps.paladinWeapons.picked == 'two-martial'"
+        options: { content: { type: weapon, where: "item.category == 'martial'" } }
+        random: params.random
+        changes:
+          - { type: addItem, entry: { item: picked.id, equipped: true } }
+      - id: paladinSecond
+        kind: choice
+        options:
+          - id: five-javelins
+            changes:
+              - type: addItem
+                entry: { item: "'weapons.javelin'", quantity: 5, equipped: true }
+          - id: simple-melee
+        recommend: options[0]
+        random: params.random
+      - id: paladinSimpleMelee
+        kind: choice
+        when: "steps.paladinSecond.picked == 'simple-melee'"
+        options:
+          content: { type: weapon, where: "item.category == 'simple' && item.range == 'melee'" }
+        random: params.random
+        changes:
+          - { type: addItem, entry: { item: picked.id, equipped: true } }
+      - id: paladinPack
+        kind: choice
+        options:
+          - id: priests-pack
+            changes: [{ type: addItem, entry: { item: "'gear.priests-pack'" } }]
+          - id: explorers-pack
+            changes: [{ type: addItem, entry: { item: "'gear.explorers-pack'" } }]
+        recommend: options[0]
+        random: params.random
+      - id: paladinSymbol
+        kind: choice
+        options: { content: { type: gear, where: "item.category == 'holy-symbol'" } }
+        random: params.random
+        changes:
+          - { type: addItem, entry: { item: picked.id } }
+      - id: paladinKit
+        kind: changes
+        changes:
+          - { type: addItem, entry: { item: "'armor.chain-mail'", equipped: true } }