commit ff554e0dd28eaa9dd501b0ff43ff5a8cad7a5842 from: the xhr date: Thu Sep 16 11:15:16 2021 UTC update readme commit - 219a93cc7645d596490ceda42307f21de3dc15bc commit + ff554e0dd28eaa9dd501b0ff43ff5a8cad7a5842 blob - c2ffaaed25522cca7373baddb9b114ecfd61b1dd blob + e80a96194d5f939abb24429840ab5717151ac58f --- README.md +++ README.md @@ -2,18 +2,18 @@ isscrolls is a simple toolkit for players of the Ironsworn tabletop RPG. It is intended for both solo and co-op player 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. -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 Unixy Ironsworn experience you'll ever see. +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). ## Features The following game mechanics are already implemented: -* All __Adventure moves__ +* All _Adventure moves_ * Automatic progress tracking for journey -* All __Combat moves__ +* All _Combat moves_ * Automatic progress tracking for fights -* Most of the __Quest moves__ -* Most of the __Relationship moves__ +* All _Quest moves_ +* Most of the _Relationship moves_ * Support for various oracle tables such as names, locations, etc ## Installation @@ -21,7 +21,7 @@ The following game mechanics are already implemented: isscrolls is written in C and known to work on OpenBSD, FreeBSD and Linux. To compile it you need the following things: * A C compiler (tested with both clang and GCC) -* make (both BSD and GNU make work) +* make (tested with both BSD and GNU make) * [The GNU Readline library](https://tiswww.case.edu/php/chet/readline/rltop.html) * [JSON-C](https://github.com/json-c/json-c) @@ -48,7 +48,7 @@ $ make ## Usage -isscrolls presents the user with a command prompt and accepts various command. A built-in help can be achieved by entering __help__ at isscrolls' command prompt. All usage patterns are described in the man page. +isscrolls presents the user with a command prompt and accepts various command. A built-in help can be achieved by entering __help__ at isscrolls' command prompt. **Example** @@ -61,6 +61,8 @@ Slith (72) 80 ``` +All usage patterns are described in the man page. + ## License isscrolls was written by Matthias Schmidt and is licensed under the ISC license. The Ironsworn material was written by [Shawn Tomkin](https://www.ironswornrpg.com) and is licensed under the Creative Commons Attribution-NonCommercial-ShareAlike 4.0 International license.