Add and comment all schemas
This commit is contained in:
parent
2a65adaf6b
commit
d200d48903
1 changed files with 25 additions and 25 deletions
50
README.md
50
README.md
|
@ -133,13 +133,13 @@ spark: <prowess> # Starting spark prowess (default novice)
|
|||
|
||||
```yaml
|
||||
$define: item
|
||||
type: <item type>
|
||||
rarity: <rarity>
|
||||
affinity: <roll type>
|
||||
damage: 0
|
||||
damageType: <damage type>
|
||||
hands: 1 | 2 # Only for wielded items
|
||||
slot: <item slot> # Only for worn items
|
||||
type: <item type> # Defaults to wielded
|
||||
rarity: <rarity> # Defaults to common
|
||||
affinity: <roll type> # Defaults to none
|
||||
damage: 0 # Defaults to 0
|
||||
damageType: <damage type> # Defaults to phy
|
||||
hands: 1 | 2 # Only for wielded items
|
||||
slot: <item slot> # Only for worn items
|
||||
```
|
||||
|
||||
#### `Item Type` Options
|
||||
|
@ -167,8 +167,8 @@ slot: <item slot> # Only for worn items
|
|||
|
||||
```yaml
|
||||
$define: method
|
||||
curator: Someone
|
||||
abilities:
|
||||
curator: Someone # The name of the curator
|
||||
abilities: # A 2-d array of ability IDs
|
||||
- [rank-1-ability-id-one, rank-1-ability-id-two]
|
||||
- [rank-2-ability-id-one]
|
||||
```
|
||||
|
@ -177,9 +177,9 @@ abilities:
|
|||
|
||||
```yaml
|
||||
$define: resource
|
||||
type: <resource type>
|
||||
url: https://example.com/image.jpeg # Only for image resources
|
||||
data: <a 2-d array of strings> # Only for table resources
|
||||
type: <resource type> # Defaults to text
|
||||
url: https://url.com/image.jpeg # Only for image resources
|
||||
data: <a 2-d array of strings> # Only for table resources
|
||||
```
|
||||
|
||||
#### `Resource Type` Options
|
||||
|
@ -193,25 +193,25 @@ data: <a 2-d array of strings> # Only for table resources
|
|||
```yaml
|
||||
$define: rule
|
||||
overrule: another-rule-id # Optional
|
||||
order: 0 # Optional
|
||||
order: 0 # Optional
|
||||
```
|
||||
|
||||
### Species Definition
|
||||
|
||||
```yaml
|
||||
$define: species
|
||||
hands: 2
|
||||
abilities:
|
||||
hands: 2 # Defaults to 2
|
||||
abilities: # A list of innate ability IDs
|
||||
- some-ability-id
|
||||
- another-ability-id
|
||||
ap: 0
|
||||
hp: 0
|
||||
ep: 0
|
||||
xp: 0
|
||||
muscle: <prowess>
|
||||
focus: <prowess>
|
||||
knowledge: <prowess>
|
||||
charm: <prowess>
|
||||
cunning: <prowess>
|
||||
spark: <prowess>
|
||||
ap: 0 # Starting AP modifier
|
||||
hp: 0 # Starting HP modifier
|
||||
ep: 0 # Starting EP modifier
|
||||
xp: 0 # Starting XP modifier
|
||||
muscle: <prowess> # Defaults to novice
|
||||
focus: <prowess> # Defaults to novice
|
||||
knowledge: <prowess> # Defaults to novice
|
||||
charm: <prowess> # Defaults to novice
|
||||
cunning: <prowess> # Defaults to novice
|
||||
spark: <prowess> # Defaults to novice
|
||||
```
|
||||
|
|
Loading…
Add table
Add a link
Reference in a new issue