diff --git a/README.md b/README.md index b42b485..9f47811 100644 --- a/README.md +++ b/README.md @@ -85,10 +85,10 @@ These YAML representations of definitions show the properties available for each Note that every Playbill component definition can define the following properties: ```yaml -id: some-hypenated-id # defaults to a slugified version of the file name -name: The Name of the Component # defaults to the file name -description: A markdown-enabled description # defaults to a placeholder -categories: # defaults to no categories +id: an-id # defaults to a slugified version of the file name +name: Component Name # defaults to the file name +description: Markdown description # defaults to a placeholder +categories: # defaults to no categories - list - of - categories @@ -98,14 +98,14 @@ categories: # defaults to no categories ```yaml $define: ability -type: # Default: action -ap: 0 # AP cost to use this ability (default: 0) -hp: 0 # HP cost to use this ability (default: 0) -ep: 0 # EP cost to use this ability (default: 0) -xp: 0 # XP cost to learn this ability (default: 1) -damage: 0 # Damage dealt by this ability (default: 0) -damageType: # Type of damage dealt by this ability (default: phy) -roll: # Roll type for this ability (default: none) +type: # Defaults to action +ap: 0 # AP cost to use this ability (default 0) +hp: 0 # HP cost to use this ability (default 0) +ep: 0 # EP cost to use this ability (default 0) +xp: 0 # XP cost to learn this ability (default 1) +damage: 0 # Damage dealt by this ability (default 0) +damageType: # Type of damage dealt by this ability (default phy) +roll: # Roll type for this ability (default none) ``` ### Blueprint Definition @@ -113,20 +113,20 @@ roll: # Roll type for this ability (default: none) ```yaml $define: blueprint species: species-id # ID of the species this blueprint is for -items: # List of item IDs (default: empty) +items: # List of item IDs (default empty) - item-id -abilities: # List of ability IDs (default: empty) +abilities: # List of ability IDs (default empty) - ability-id -ap: 0 # Starting AP (default: 4) -hp: 0 # Starting HP (default: 5) -ep: 0 # Starting EP (default: 1) -xp: 0 # Starting XP (default: 0) -muscle: # Starting muscle prowess (default: novice) -focus: # Starting focus prowess (default: novice) -knowledge: # Starting knowledge prowess (default: novice) -charm: # Starting charm prowess (default: novice) -cunning: # Starting cunning prowess (default: novice) -spark: # Starting spark prowess (default: novice) +ap: 0 # Starting AP (default 4) +hp: 0 # Starting HP (default 5) +ep: 0 # Starting EP (default 1) +xp: 0 # Starting XP (default 0) +muscle: # Starting muscle prowess (default novice) +focus: # Starting focus prowess (default novice) +knowledge: # Starting knowledge prowess (default novice) +charm: # Starting charm prowess (default novice) +cunning: # Starting cunning prowess (default novice) +spark: # Starting spark prowess (default novice) ``` ### Item Definition