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