martyn
/
townsquare
mirror of https://github.com/bra1n/townsquare.git
1
0
Fork 0
Code Issues Packages Projects Releases Wiki Activity

readme update

This commit is contained in:
Steffen 2020-06-30 13:54:45 +02:00
parent 902141c993
commit b0dc8eec86
No known key found for this signature in database
GPG Key ID: 764D74E98267DFC6
1 changed files with 13 additions and 2 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

15
README.md
View File

@ -19,10 +19,11 @@ It is supposed to aid storytellers and allow them to quickly set up and capture
### Custom Characters ### Custom Characters
In order to add custom characters to your local Grimoire, you need to create a JSON definition for them, In order to add custom characters to your local Grimoire, you need to create a JSON definition for them,
similar to what is provided in the `roles.json` for the 3 base editions. Here's an example of how such a character similar to what is provided in the [`roles.json`](https://github.com/bra1n/townsquare/blob/master/src/roles.json) for the 3 base editions. Here's an example of how such a character
might be described: definition file might be written:
```json ```json
[
{ {
"id": "acrobat", "id": "acrobat",
"image": "https://github.com/bra1n/townsquare/blob/master/src/assets/icons/acrobat.png?raw=true", "image": "https://github.com/bra1n/townsquare/blob/master/src/assets/icons/acrobat.png?raw=true",
@ -36,9 +37,19 @@ might be described:
"name": "Acrobat", "name": "Acrobat",
"team": "outsider", "team": "outsider",
"ability": "Each night*, if either good living neighbor is drunk or poisoned, you die." "ability": "Each night*, if either good living neighbor is drunk or poisoned, you die."
},
{
"id": "investigator"
},
{
"id": "imp"
} }
]
``` ```
This definition JSON includes a custom character, the Acrobat, and 2 base game characters, the Investigator and the Imp.
For base game characters, it is sufficient to only provide the ID, similar to what you get from the Script Tool.
**Required properties:** `id`, `name`, `team`, `ability` **Required properties:** `id`, `name`, `team`, `ability`
- **id**: the internal ID for this character, without spaces or special characters - **id**: the internal ID for this character, without spaces or special characters