Skip to content

Commit 65a54fd

Browse files
committed
Update docs
Small docs typo fixes. Almost ready for broader release.
1 parent 5c40ad6 commit 65a54fd

File tree

3 files changed

+6
-6
lines changed

3 files changed

+6
-6
lines changed

README.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -1,6 +1,6 @@
11
# MakeRPG
22

3-
MakeRPG is intended to be a system that allows anyone who can edit YAML files to make automatic characters and game systems.
3+
MakeRPG is intended to be a system that allows anyone who can edit YAML files to make automatic characters from game systems.
44

55
# Dependencies
66

docs/history.md

Lines changed: 4 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -2,7 +2,7 @@
22

33
To build a valid character history system specifically for this software, use the following rules.
44

5-
For a fully documented YAML file example, see the `system_history.yaml` in the repository's `Examples` folder.
5+
For a fully documented YAML file example, see the `system_history.yaml` in the code repository's `Examples` folder.
66

77
# Reference Examples
88

@@ -82,19 +82,19 @@ Siblings:
8282

8383
`START`
8484

85-
The `START` key's value MUST match a `[History event name]`.
85+
The `START` key's value MUST match a `[History event name]`. This is the history event that all player characters begin rolling from.
8686

8787
`NPC`
8888

89-
The `NPC` key's hyphenated list MUST match a `[History event name]` for each bulleted point. This list is the order which will be used to create every NPC history. This list order should also not trigger more NPC creations and ignores the `next` keyword in each `[History event name]` in the list.
89+
The `NPC` key's hyphenated list MUST match a `[History event name]` for each bulleted point. This list is the order which will be used to create every NPC history. This list order should not trigger more NPC creations and ignores the `next` keyword in each `[History event name]` in the list.
9090

9191
`[History event name]`
9292

9393
Replace `[History event name]` here with your history event's name. It is a single event which you would roll to choose in character creation during your system's regular character creation. The order that history events appear does not matter as long as every named event has a matching definition. History events MUST have at least a `dice` and a `roll` key.
9494

9595
`dice`
9696

97-
Any dice definition of the form `<QUANTITY>d<SIDES> <OPTIONAL + or -> <OPTIONAL OFFSET>`, where `<QUANTITY>` MUST be an integer/whole number value of dice to throw, `<SIDES>` MUST be an integer/whole number greater than 1 representing the number of sides or possibilities of the dice, `<OPTIONAL + or ->` is an optional addition or subtraction to be used with `<OPTIONAL OFFSET>` which MUST be an integer/whole number. Examples:
97+
Any dice definition of the form `[QUANTITY]d[SIDES] [OPTIONAL + or -] [OPTIONAL OFFSET]`, where `[QUANTITY]` MUST be an integer/whole number value of dice to throw, `[SIDES]` MUST be an integer/whole number greater than 1 representing the number of sides or possibilities of the dice, `[OPTIONAL + or -]` is an optional addition or subtraction to be used with `[OPTIONAL OFFSET]` which MUST be an integer/whole number. Examples:
9898

9999
- `1d2`
100100
- `5d17`

docs/roles_skills_stats.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -2,7 +2,7 @@
22

33
To build a valid stats and skills system specifically for this software, use the following rules.
44

5-
For a fully documented YAML file example, see the `system_stats_skills.yaml` in the repository's `Examples` folder.
5+
For a fully documented YAML file example, see the `system_stats_skills.yaml` in the code repository's `Examples` folder.
66

77
# Reference Examples
88

0 commit comments

Comments
 (0)