1 # isscrolls - Simple player toolkit for the Ironsworn tabletop RPG
2 
3  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.
4 
5 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).
6 
7 ![isscrolls screenshot](https://xosc.org/misc/is.png)
8 
9 ## Features
10 
11 The following game mechanics are already implemented:
12 
13 * All _Adventure moves_
14 * Automatic progress tracking for journey
15 * All _Combat moves_
16 * Automatic progress tracking for fights
17 * All _Quest moves_
18 * Most of the _Relationship moves_
19 * Support for various oracle tables such as names, locations, etc
20 
21 ## Installation
22 
23 isscrolls is written in C and tested on OpenBSD, and Linux.  To compile it you need the following things:
24 
25 * A C compiler (tested with both clang and GCC)
26 * make (tested with both BSD and GNU make)
27 * [The GNU Readline library](https://tiswww.case.edu/php/chet/readline/rltop.html)
28 * [JSON-C](https://github.com/json-c/json-c)
29 
30 ### Dependencies
31 
32 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.
33 
34 Install the dependencies as follows:
35 
36 | Operating System | Command |
37 | --- | --- |
38 | Ubuntu Linux| `apt install libreadline-dev libjson-c-dev` |
39 | OpenBSD | `pkg_add json-c` |
40 
41 ### Compilation and Installation
42 
43 Compile and install with the following commands:
44 
45 ```
46 $ make
47 # make install
48 ```
49 
50 ## Usage
51 
52 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.
53 
54 **Example**
55 
56 ```
57 > action 3
58 D6: 3+3=6 D10: 5, 7 -> weak hit
59 > trollname
60 Slith (72)
61 > oracle
62 80
63 ```
64 
65 All usage patterns are described in the man page.
66 
67 ## License
68 
69 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.