Item Note Frontmatter — Song of Heroic Lands

Every item note carries the frontmatter envelope described in The Authoring Workflow — name.full, type, shortcode, id, and the required sohl.archetype. This page covers what each type adds to that: the fields under its sohl: block, and nothing else.

The tables are rendered from the declaration that builds each document, not from a description of it, so a field listed here is a field the compiler reads and a field absent here is one it ignores. An unrecognised sohl: key is silently dropped, so a typo shows up as a missing value rather than an error — check the spelling here first.

13 of the 13 item types this repository compiles declare their frontmatter below. Every field is written under a note’s sohl: block; a dotted name such as impact.die is a nested key. A field a note does not carry takes the default shown, and a required field has none — omitting it fails the build rather than guessing.

affiliation

Field	Shape	Required	Default	Description
`subType`	string	yes	—	Which kind of affiliation this is — the society’s character.
`society`	string	no	`""`	The body a member belongs to.
`office`	string	no	`""`	The post a member holds within it.
`title`	string	no	`""`	The style of address the office carries.
`level`	number	no	`0`	Standing within the society.
`relation`	map of affiliation shortcode → standing	no	`{}`	How this society regards others: aligned, unaligned, rival or nemesis.

---
name:
  full: An Example affiliation
type: affiliation
shortcode: xmpl
id: <16-character id>
sohl:
  archetype: null
  subType: <string>
---

The prose here compiles into the item's documentation.

affliction

Field	Shape	Required	Default	Description
`subType`	string	yes	—	What kind of affliction it is.
`category`	as authored	no	`""`	The grouping it belongs to within its subtype.
`levelBase`	number	no	`0`	Severity, before any modifier.
`healingRateBase`	number	no	`0`	How readily the host throws it off.
`contagionIndex`	number	no	`0`	How readily it passes to someone else.
`transmission`	as authored	no	`none`	The route by which it spreads.
`onsetFormula`	as authored, blank is unset	no	`null`	Days from contracting to onset, rolled by the receiving actor. Unset means no incubation.
`outcome`	as authored, blank is the default	no	`cured`	What running the course to the end does to the host: `death`, or the benign default `cured`.

---
name:
  full: An Example affliction
type: affliction
shortcode: xmpl
id: <16-character id>
sohl:
  archetype: null
  subType: <string>
---

The prose here compiles into the item's documentation.

armorgear

Field	Shape	Required	Default	Description
`weight`	as authored	no	`0`	Weight of one, in pounds.
`value`	as authored	no	`0`	Worth of one, in pence.
`quality`	as authored	no	`0`	Craftsmanship, as a modifier to what the article does.
`durability`	as authored	no	`0`	How much punishment the article takes before it fails.
`material`	as authored	no	`""`	What the article is made of.
`flexloc`	as authored, blank is the default	no	`[]`	Body locations the article covers flexibly, by location shortcode.
`rigidloc`	as authored, blank is the default	no	`[]`	Body locations the article covers rigidly, by location shortcode.
`facing`	list of `{location, side}`	no	`[]`	For a one-sided article, which side of each location it protects. Everything else protects from any direction and leaves this empty.
`protection.blunt`	number	no	`0`	Protection against blunt impact.
`protection.edged`	number	no	`0`	Protection against edged impact.
`protection.piercing`	number	no	`0`	Protection against piercing impact.
`protection.fire`	number	no	`0`	Protection against fire and heat.
`encumbrance`	number	no	`0`	What wearing it costs in encumbrance.
`encumbranceGroup`	as authored, blank is unset	no	`null`	The set an article’s encumbrance is charged to instead of carrying its own — the arm harness.
`perceptionPenaltyBase`	number	no	`0`	What wearing it costs in perception.

---
name:
  full: An Example armorgear
type: armorgear
shortcode: xmpl
id: <16-character id>
sohl:
  archetype: null
---

The prose here compiles into the item's documentation.

attribute

Field	Shape	Required	Default	Description
`scoreBase`	number	no	`0`	The attribute’s score before any modifier.
`valueDesc`	list of `Label: max` strings, or `{label, maxValue}` objects	no	`[]`	Descriptive bands for the score, each a label and the highest value it covers.
`initDiceFormula`	as authored	no	`""`	Dice expression rolled to generate the score during character creation.
`impairedByRoles`	as authored	no	`[]`	Body-part roles whose impairment penalises tests against this attribute.

---
name:
  full: An Example attribute
type: attribute
shortcode: xmpl
id: <16-character id>
sohl:
  archetype: null
---

The prose here compiles into the item's documentation.

concoctiongear

Field	Shape	Required	Default	Description
`weight`	as authored	no	`0`	Weight of one, in pounds.
`value`	as authored	no	`0`	Worth of one, in pence.
`quality`	as authored	no	`0`	Craftsmanship, as a modifier to what the article does.
`durability`	as authored	no	`0`	How much punishment the article takes before it fails.
`subType`	string	yes	—	What kind of concoction it is.
`potency`	as authored	no	`notApplicable`	How concentrated the preparation is.
`strength`	number	no	`0`	How strongly it acts when it does.

---
name:
  full: An Example concoctiongear
type: concoctiongear
shortcode: xmpl
id: <16-character id>
sohl:
  archetype: null
  subType: <string>
---

The prose here compiles into the item's documentation.

containergear

Field	Shape	Required	Default	Description
`weight`	as authored	no	`0`	Weight of one, in pounds.
`value`	as authored	no	`0`	Worth of one, in pence.
`quality`	as authored	no	`0`	Craftsmanship, as a modifier to what the article does.
`durability`	as authored	no	`0`	How much punishment the article takes before it fails.
`maxCapacity`	number	no	`0`	How much the container holds, in pounds.

---
name:
  full: An Example containergear
type: containergear
shortcode: xmpl
id: <16-character id>
sohl:
  archetype: null
---

The prose here compiles into the item's documentation.

miscgear

Field	Shape	Required	Default	Description
`weight`	as authored	no	`0`	Weight of one, in pounds.
`value`	as authored	no	`0`	Worth of one, in pence.
`quality`	as authored	no	`0`	Craftsmanship, as a modifier to what the article does.
`durability`	as authored	no	`0`	How much punishment the article takes before it fails.

---
name:
  full: An Example miscgear
type: miscgear
shortcode: xmpl
id: <16-character id>
sohl:
  archetype: null
---

The prose here compiles into the item's documentation.

mystery

Field	Shape	Required	Default	Description
`subType`	string	yes	—	Which tradition the mystery belongs to.
`assocSkillCode`	as authored, blank is unset	no	`null`	Shortcode of the skill the mystery is tested against.
`assocAffiliationCode`	as authored, blank is unset	no	`null`	Shortcode of the affiliation whose standing confers the mystery — a religion, school, or ancestor/totem/spirit.
`levelBase`	number	no	`0`	The mystery’s level before any modifier.
`skillAptitudes`	map of skill selector → whole number	no	`{}`	Aptitude the mystery grants, per skill selector.
`charges`	`{value, max}`, both whole numbers or unset	no	`{"value":null,"max":null}`	Uses available and the pool’s size. A blank maximum means the mystery does not use charges.

---
name:
  full: An Example mystery
type: mystery
shortcode: xmpl
id: <16-character id>
sohl:
  archetype: null
  subType: <string>
---

The prose here compiles into the item's documentation.

mysticalability

Field	Shape	Required	Default	Description
`subType`	string	yes	—	Which tradition the ability belongs to.
`assocSkillCode`	as authored	no	`""`	Shortcode of the skill the ability is tested against.
`assocAffiliationCode`	as authored, blank is unset	no	`null`	Shortcode of the affiliation whose standing confers the ability — a religion, school, or ancestor/totem/spirit.
`masteryLevelBase`	number	no	`0`	Mastery in the ability before any modifier.
`improveFlag`	boolean	no	`false`	Whether it is flagged for improvement.
`levelBase`	number	no	`0`	The ability’s level before any modifier.
`charges`	`{value, max}`, both whole numbers or unset	no	`{"value":null,"max":null}`	Uses available and the pool’s size. A blank maximum means the ability does not use charges.

---
name:
  full: An Example mysticalability
type: mysticalability
shortcode: xmpl
id: <16-character id>
sohl:
  archetype: null
  subType: <string>
---

The prose here compiles into the item's documentation.

projectilegear

Field	Shape	Required	Default	Description
`weight`	as authored	no	`0`	Weight of one, in pounds.
`value`	as authored	no	`0`	Worth of one, in pence.
`quality`	as authored	no	`0`	Craftsmanship, as a modifier to what the article does.
`durability`	as authored	no	`0`	How much punishment the article takes before it fails.
`subType`	string	yes	—	What kind of projectile it is.
`impact.overrideDice`	boolean	no	—	Whether the projectile’s dice replace the launching weapon’s. Defaults to true when the projectile declares a die.
`impact.overrideModifier`	boolean	no	—	Whether the projectile’s modifier replaces the launching weapon’s.
`impact.die`	number	no	`0`	The impact die’s size.
`impact.modifier`	number	no	`0`	Flat addition to the impact roll.
`impact.aspect`	as authored, blank is the default	no	`piercing`	How the projectile wounds.

---
name:
  full: An Example projectilegear
type: projectilegear
shortcode: xmpl
id: <16-character id>
sohl:
  archetype: null
  subType: <string>
---

The prose here compiles into the item's documentation.

skill

Field	Shape	Required	Default	Description
`subType`	string	yes	—	Which family of skill it is.
`skillBaseFormula`	as authored	no	`""`	Expression deriving the skill’s base from the actor’s attributes, e.g. `sb(attr.str, attr.agl)`.
`masteryLevelBase`	number or unset	no	`null`	Opened mastery level. Unset means not yet opened — an embedded copy opens on its actor at Skill Base × `initSkillMult`.
`improveFlag`	boolean	no	`false`	Whether it is flagged for improvement.
`combatCategory`	as authored	no	`none`	Which combat role the skill fills, if any.
`parentSkillCode`	as authored	no	`""`	Shortcode of the skill this one specialises, for a specialisation.
`initSkillMult`	number	no	`0`	Multiplier applied to Skill Base when the skill opens on an actor.
`impairedByRoles`	as authored	no	`[]`	Body-part roles whose impairment penalises tests against this skill.

---
name:
  full: An Example skill
type: skill
shortcode: xmpl
id: <16-character id>
sohl:
  archetype: null
  subType: <string>
---

The prose here compiles into the item's documentation.

trauma

Field	Shape	Required	Default	Description
`subType`	string	yes	—	What kind of trauma it is.
`category`	as authored	no	`null`	The grouping it belongs to within its subtype.
`levelBase`	number or unset	no	`null`	Injury level. Unset on a descriptive condition, which has no level.
`healingRateBase`	number	no	`0`	How readily it heals.
`aspect`	as authored	no	`null`	How the injury was inflicted. Unset on a descriptive condition.
`isTreated`	boolean	no	`false`	Whether it has been treated.
`isBleeding`	boolean	no	`false`	Whether it is bleeding.
`bodyLocationCode`	as authored	no	`null`	Shortcode of the body location injured. Unset on a descriptive condition.

---
name:
  full: An Example trauma
type: trauma
shortcode: xmpl
id: <16-character id>
sohl:
  archetype: null
  subType: <string>
---

The prose here compiles into the item's documentation.

weapongear

Field	Shape	Required	Default	Description
`weight`	as authored	no	`0`	Weight of one, in pounds.
`value`	as authored	no	`0`	Worth of one, in pence.
`quality`	as authored	no	`0`	Craftsmanship, as a modifier to what the article does.
`durability`	as authored	no	`0`	How much punishment the article takes before it fails.
`encumbrance`	number	no	`0`	What carrying it costs in encumbrance.
`heft`	number	no	`0`	How unwieldy it is in the hand.
`strikeModes`	list of strike modes, each with a unique `shortcode`	no	`[]`	The ways the weapon can be used to strike.

---
name:
  full: An Example weapongear
type: weapongear
shortcode: xmpl
id: <16-character id>
sohl:
  archetype: null
---

The prose here compiles into the item's documentation.