From b301dc3148ecf8a00a66fc82cd82be9df6af2c59 Mon Sep 17 00:00:00 2001 From: Steffen Date: Fri, 26 Feb 2021 09:58:20 +0100 Subject: [PATCH] Update README.md --- README.md | 12 +++++------- 1 file changed, 5 insertions(+), 7 deletions(-) diff --git a/README.md b/README.md index ba33720..5c1a7e0 100644 --- a/README.md +++ b/README.md @@ -20,8 +20,9 @@ If you want to learn more about how to use the website as a player, [JayBotC](ht - Public Town Square and Storyteller Grimoire (toggle with **shortcut \[G\]**) - Supports custom script JSON generated by the [Script Tool](https://bloodontheclocktower.com/script) - Live Session for Storyteller / Players including live voting and character distribution! -- Includes all 3 base editions, Travelers and Fabled +- Includes all 3 base editions, Travelers and Fabled plus all officially spoiled characters so far! - Night sheet and reminder text for each character ability to help storytellers +- Full homebrew support for hosting and playing games with your own sets of characters - Many other customization options! ### Custom Script Support @@ -44,8 +45,7 @@ character: This will provide your local Grimoire (and those of your live session players) with more information to show about your custom script - instead of "Custom Script" it would show "Deadly Penance Day" on the character reference sheet, -for example. The logo is shown only locally, if you want your players to see it as well, they will have to upload the -same JSON file that you used. +for example. The logo will be shown to your players after they have enabled custom images in the Grimoire menu. ### Custom Character Support @@ -86,7 +86,8 @@ For base game characters, it is sufficient to only provide the ID, similar to wh - **id**: the internal ID for this character, without spaces or special characters
_Note_: this ID needs to be unique and can't be the same as any ID already used by an existing character, otherwise the custom character will be overwritten with the existing role! -- **image**: a URL to a PNG of the character token icon (should have a transparent background!) +- **image**: a URL to a PNG of the character token icon (should have a transparent background!)
+ _Note_: custom images will only be visible after enabling them in the Grimoire menu! - **edition**: the ID of the edition for this character. can be left blank or "custom" - **firstNight** / **otherNight**: the position that this character acts on the first / other nights, compared to all other characters @@ -98,9 +99,6 @@ For base game characters, it is sufficient to only provide the ID, similar to wh - **team**: the team of the character, has to be one of `townsfolk`, `outsider`, `minion`, `demon` or `traveler` - **ability**: the displayed ability text of the character -_Note:_ in order to use custom characters in live sessions, your players have to load the same JSON file that the storyteller -has loaded before joining the live session. - ## [Code of Conduct](CODE_OF_CONDUCT.md) ## [Contributing](CONTRIBUTING.md)