1 ed0972e3 2021-09-06 xhr # isscrolls - Simple player toolkit for the Ironsworn tabletop RPG
3 ed0972e3 2021-09-06 xhr 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.
5 ff554e0d 2021-09-16 xhr 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).
7 171645ee 2021-09-16 xhr 
11 5dd749a0 2021-09-11 xhr The following game mechanics are already implemented:
13 ff554e0d 2021-09-16 xhr * All _Adventure moves_
14 5dd749a0 2021-09-11 xhr * Automatic progress tracking for journey
15 ff554e0d 2021-09-16 xhr * All _Combat moves_
16 5dd749a0 2021-09-11 xhr * Automatic progress tracking for fights
17 ff554e0d 2021-09-16 xhr * All _Quest moves_
18 ff554e0d 2021-09-16 xhr * Most of the _Relationship moves_
19 5dd749a0 2021-09-11 xhr * Support for various oracle tables such as names, locations, etc
21 ed0972e3 2021-09-06 xhr ## Installation
23 3de9f297 2021-09-16 xhr isscrolls is written in C and tested on OpenBSD, and Linux. To compile it you need the following things:
25 ed0972e3 2021-09-06 xhr * A C compiler (tested with both clang and GCC)
26 ff554e0d 2021-09-16 xhr * make (tested with both BSD and GNU make)
27 ed0972e3 2021-09-06 xhr * [The GNU Readline library](https://tiswww.case.edu/php/chet/readline/rltop.html)
28 ed0972e3 2021-09-06 xhr * [JSON-C](https://github.com/json-c/json-c)
30 ed0972e3 2021-09-06 xhr ### Dependencies
32 ed0972e3 2021-09-06 xhr On most Unix systems, __readline__ is installed by default. Otherwise, __readline__ and __json-c__ can be installed from the package manager of your distribution or compiled from source. By default, the `Makefile` looks for external includes and libraries in `/usr/local/include` and `/usr/local/lib`. If you use a special path, modify the Makefile accordingly.
34 ed0972e3 2021-09-06 xhr Install the dependencies as follows:
36 d5fd45f0 2021-09-06 xhr | Operating System | Command |
37 d5fd45f0 2021-09-06 xhr | --- | --- |
38 d5fd45f0 2021-09-06 xhr | Ubuntu Linux| `apt install libreadline-dev libjson-c-dev` |
39 d5fd45f0 2021-09-06 xhr | OpenBSD | `pkg_add json-c` |
41 ed0972e3 2021-09-06 xhr ### Compilation and Installation
43 ed0972e3 2021-09-06 xhr Compile and install with the following commands:
47 ed0972e3 2021-09-06 xhr # make install
52 ff554e0d 2021-09-16 xhr 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.
58 ed0972e3 2021-09-06 xhr D6: 3+3=6 D10: 5, 7 -> weak hit
65 ff554e0d 2021-09-16 xhr All usage patterns are described in the man page.
69 c982156d 2021-09-09 xhr 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.
