From 3cb2ac9a05ae2521292a6ed1cd5619a2096d6e59 Mon Sep 17 00:00:00 2001 From: the xhr Date: Thu, 18 May 2023 08:10:07 +0000 Subject: [PATCH] Mention support for visually impared players at the beginning --- README.md | 6 +++--- 1 file changed, 3 insertions(+), 3 deletions(-) diff --git a/README.md b/README.md index ba8f98e..9bc4a66 100644 --- a/README.md +++ b/README.md @@ -1,9 +1,11 @@ # isscrolls - Command line based player toolkit for the Ironsworn tabletop RPG - isscrolls is a toolkit for players of the [Ironsworn](https://www.ironswornrpg.com/) tabletop RPG. It is intended for both solo and co-op play and allows to roll different dices such as action or oracle rolls. It also provides results from the static oracle tables from the official rulebook and tracks your character's progress. +isscrolls is a toolkit for players of the [Ironsworn](https://www.ironswornrpg.com/) tabletop RPG. It is intended for both solo and co-op play and allows to roll different dices such as action or oracle rolls. It also provides results from the static oracle tables from the official rulebook and tracks your character's progress. Although there are several Ironsworn player toolkits available, there was none for the command line. Since I prefer working in a terminal, I wrote isscrolls. Think of it as the most Unix-like Ironsworn experience you'll ever see. Besides that, you can play it over SSH or even in a shared terminal session (with tmux or screen). +Visually impaired players should run isscrolls with the `-b` option to suppress the banner on startup. By default, very little extra characters or symbols are shown to ease playing with a screen reader or a braille display. In case you want colors, bold fonts and more symbols start isscrolls with the `-c` option. This can be seen in the screenshot below. + ![isscrolls screenshot](https://xosc.org/misc/is-202209.png) ## Features @@ -117,8 +119,6 @@ You inflict harm, regain initiative and can choose one option -> Rulebook Jorrun > Fight 2 [I] > ``` -If you're using isscrolls with a braille display, use the -b Option to suppress the banner on startup. - ## FAQ **Why does isscrolls so often refers to the official rulebook?** The program should help you in keeping track of your character's progress. However, it cannot replace the GM in your campaign. In order to give the player as much freedom as possible, I refrain from doing everything automatically and instead redirect you to the rulebook.