2 .\" Copyright (c) 2021 Matthias Schmidt
4 .\" Permission to use, copy, modify, and distribute this software for any
5 .\" purpose with or without fee is hereby granted, provided that the above
6 .\" copyright notice and this permission notice appear in all copies.
8 .\" THE SOFTWARE IS PROVIDED "AS IS" AND THE AUTHOR DISCLAIMS ALL WARRANTIES
9 .\" WITH REGARD TO THIS SOFTWARE INCLUDING ALL IMPLIED WARRANTIES OF
10 .\" MERCHANTABILITY AND FITNESS. IN NO EVENT SHALL THE AUTHOR BE LIABLE FOR
11 .\" ANY SPECIAL, DIRECT, INDIRECT, OR CONSEQUENTIAL DAMAGES OR ANY DAMAGES
12 .\" WHATSOEVER RESULTING FROM LOSS OF USE, DATA OR PROFITS, WHETHER IN AN
13 .\" ACTION OF CONTRACT, NEGLIGENCE OR OTHER TORTIOUS ACTION, ARISING OUT OF
14 .\" OR IN CONNECTION WITH THE USE OR PERFORMANCE OF THIS SOFTWARE.
17 .Dd September 16, 2021
22 .Nd Simple player toolkit for the
30 is a simple toolkit for players of the Ironsworn tabletop RPG.
31 It is intended for both solo and co-op player and allows to roll different
32 dices such as action or oracle rolls.
33 It also provides results from the static oracle tables from the
35 The options are as follows:
42 basically works like a
45 Commands can be entered and will show their output.
46 Certain commands need an argument in order to run properly, other commands
47 might support optional arguments.
48 Once a character is loaded, the prompt will change and display the
52 command will show an overview of all available commands.
57 thus any shortcut or character combination that work with a common
59 shell also work for the built-in shell.
61 This sub-section shows general commands that are not dice rolls and game moves.
68 argument and a character with that name exists, it is loaded as the active
70 If it is invoked without arguments and a character is loaded, the character
71 is saved and unloaded.
73 Shows an overview of all available commands.
75 List all available characters.
79 and saves all characters and the command line history.
82 The following commands can be used to roll dice according to the game's
86 does not provide commands for all moves in the game.
88 .It Ic action Cm stat Op bonus
93 Providing one number as
98 that will be added to this roll.
105 .It Ic yesorno Cm odds
108 to get an answer to a yes/no question from the oracle.
110 has to be a number (1-5) of the following list:
124 .Ss Character Commands
125 The following commands can be used to modify your character.
127 supports multiple characters, however, only one can be loaded at a time.
128 Most commands do nothing or present a warning if no character is loaded.
130 .It Ic create Op name
131 Create a new character.
132 If the optional argument
134 is provided, it will be used as the character's name.
135 Otherwise, the name will be asked interactively.
136 .It Ic decrease Cm stat
137 Decrease the character's value named
140 To give the player a bit more flexibility, this allows to decrease values even
141 if this is forbidden by the official
144 The following values can be decreased:
168 Delete the current character without warning!
169 .It Ic increase Cm stat
172 only it increases the stat by 1.
174 Print the current character's stats.
175 .It Ic toggle Cm stat
176 Toggle a character's stat named
178 If it's set to 0, it will be set to 1 or vice versa.
179 The following values can be modified.
191 Note that this is a permanent bane and cannot be changed once it has been set.
194 Note that this is a permanent bane and cannot be changed once it has been set.
202 Adventure Moves are used as your character travels the Ironlands, investigate
203 situations and deal with threats.
205 .It Ic facedanger Cm stat Op bonus
208 move using the character's stat named
210 This move can done using the following stats: edge, heart, iron, shadow, and
215 .It Ic secureanadvantage Cm stat Op bonus
217 .Em Secure An Advantage
218 move using the character's stat named
220 This move can done using the following stats: edge, heart, iron, shadow, and
225 .It Ic gatherinformation Op bonus
227 .Em Gather Information
231 that will be added to this roll.
232 .It Ic heal Cm who Op bonus
236 If the character wants to heal themselves, the argument
240 automatically selects the character's Iron or Wits, whichever is lower.
241 If the character wants to heal someone else, the argument
247 .It Ic resupply Op bonus
254 .It Ic makecamp Op bonus
258 .It Ic undertakeajourney Op bonus
260 .Em Undertake a Journey
264 that will be added to this roll.
266 In case this is the first move of a new journey,
268 will ask for a difficulty and save it for the character.
269 Progress will be tracked automatically according to the difficulty.
270 For lower difficulties (
274 ), progress will be shown as absolute numbers, e.g. 2/10.
275 For higher difficulties (
279 ), progress will be shown as decimal numbers and 0.25 represents one tick,
280 e.g. 0.75/10 means that the character already made 3 ticks progress.
281 .It Ic reachyourdestination Op bonus
283 .Em Reach Your Destination
287 , the character can choose to abort the journey or continue with it.
292 .Ss Relationship Moves
293 The following moves are made as the character interacts with others in the wild,
294 fight duels, form bonds, support your allies, and determine the ultimate fate.
296 .It Ic compel Cm stat Op bonus
299 move using the character's stat named
301 This move can done using the following stats: heart, iron, and shadow.
305 .It Ic sojourn Op bonus
311 that will be added to this roll.
312 .It Ic drawthecircle Op bonus
318 that will be added to this roll.
319 .It Ic forgeabond Op bonus
326 .It Ic testyourbond Op bonus
335 When there are no other options, when the sword flips free of its sheath, when
336 the arrow is nocked, when the shield is brought to bear, these moves can
339 .It Ic enterthefray Cm stat Op bonus
342 move using the character's stat named
344 This move can done using the following stats: heart, wits, and shadow.
346 In case this is the first move in a fight,
348 will ask for a difficulty and save it for the fight.
349 Progress per harm will be tracked automatically according to the difficulty.
350 For lower difficulties (
354 ), progress will be shown as absolute numbers, e.g. 2/10.
355 For higher difficulties (
359 ), progress will be shown as decimal numbers and 0.25 represents one tick,
360 e.g. 0.75/10 means that the character already made 3 ticks progress.
364 .It Ic endthefight Op bonus
371 .It Ic strike Cm stat Op bonus
374 move using the character's stat named
376 This move can done using the following stats: iron, and edge.
380 .It Ic clash Cm stat Op bonus
383 move using the character's stat named
385 This move can done using the following stats: iron, and edge.
389 .It Ic battle Cm stat Op bonus
392 move using the character's stat named
394 This move can done using the following stats: edge, heart, iron, shadow, and
401 The commands represent important moves a characters makes during their quest.
403 .It Ic swearanironvow Op bonus
405 .Em Swear an Iron Vow
409 that will be added to this roll.
412 These moves are made as a result of a perilous event or bad outcome on other
414 They represent what happens to the character, and how they hold up against
417 .It Ic endureharm Op value
421 In case the character is in a fight, the amount of harm to suffer is
422 automatically calculated from the foe's difficulty.
423 If the character is not in a fight, the amount of harm to suffer can be
424 provided with the optional argument
426 Since there are multiple options on what can happen on a
428 the decision is up to the player and not implemented in
430 .It Ic facedeath Op bonus
434 In case the character dies, it is marked as such and
436 is printed in the character's statistics.
440 .It Ic endurestress Cm value
446 that will be removed from your spirit.
447 Since there are multiple reasons why the character can suffer stress, the
450 to suffer has to be provided as argument and is not implemented within
454 The following commands provide results from the various oracle tables in the
458 Show a random action.
460 Show a random combat action.
461 .It Ic coastalwaterlocation
462 Show a random coastal waters location.
464 Show a random elf name.
466 Show a random giant name.
467 .It Ic ironlandername
468 Show a random Ironlander name.
470 Show a random location.
471 .It Ic locationdescription
472 Show a random description for a location.
473 .It Ic mysticbackslash
474 Show a random mystic backslash.
480 Show a random plot twist.
484 Show a random Ironlands region.
488 Show a random Varou name.
492 makes use of the following environment variables.
493 .Bl -tag -width XDG_CONFIG_HOME
499 stores its history and other data in the
501 subdirectory in the user's home directory.
502 .It Ev XDG_CONFIG_HOME
503 In case this variable is set,
505 stores its history and other data in the
507 subdirectory under the path set by this environment variable.
510 .Bl -tag -width Ds -compact
511 .It Pa /usr/local/share/isscrolls
512 This is the location where shared files such as the JSON files containing the
513 oracle tables are stored.
517 normally exists with 0 or with 1 if an error occurred.
523 .%B Ironsworn. A tabletop RPG of perilous Quests
525 .%U https://www.ironswornrpg.com/
530 .An Matthias Schmidt Aq Mt xhr@giessen.ccc.de .
