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 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).
The following game mechanics are already implemented:
- All Adventure moves
- Automatic progress tracking for journey
- All Combat moves
- Automatic progress tracking for fights
- All Quest moves
- Most of the Relationship moves
- Most of the Delve moves
- Support for various oracle tables such as names, locations, etc
isscrolls is written in C and known to work on the operating systems listed in the table below. To compile it you need the following things:
- A C compiler (tested with both clang and GCC)
- make (tested with both BSD and GNU make)
- The GNU Readline library
- The JSON-C library
Install the dependencies as follows:
| Operating System | Commands and Notes |
|---|---|
| Arch Linux | Both depenencies should already be installed by default. Otherwise, pacman -Syu gcc make json-c readline will install them |
| Debian Linux | apt install libreadline-dev libjson-c-dev |
| Fedora Linux | dnf install readline-devel json-c-devel |
| FreeBSD | pkg install readline json-c |
| NetBSD | pkgin install readline json-c You also need to add -I/usr/pkg/include to CFLAGS and -L/usr/pkg/lib to LDADD in the Makefile |
| OpenBSD | pkg_add json-c |
| Ubuntu Linux | apt install libreadline-dev libjson-c-dev |
| Void Linux | xbps-install gcc make readline-devel json-c-devel |
By default, the Makefile looks for external includes and libraries in /usr/local/include and /usr/local/lib. If your distribution uses special path, you have to modify the Makefile accordingly.
Compile and install with the following commands:
$ make
# make install
isscrolls presents the user with a command prompt and accepts various commands. A built-in help can be seen by entering help at isscrolls' command prompt.
Example
> action 3
D6: 3+3=6 D10: 5, 7 -> weak hit
> trollname
Slith (72)
> oracle
80
All commands including their usage patterns are described in the man page.
If you're using isscrolls with a braille display, use the -b Option to suppress the banner on startup.
isscrolls doesn't support all possible Ironsworn moves yet. Yes, I know and sometimes this is intentional. I usually implement moves as soon as I miss one during my own solo-player campaign.
I really need move X to continue my journey. Then please open an issue here and I'll take care of it.
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.
isscrolls was written by Matthias Schmidt and is licensed under the ISC license. The Ironsworn material was written by Shawn Tomkin and is licensed under the Creative Commons Attribution-NonCommercial-ShareAlike 4.0 International license.