2 545546b9 2021-09-06 xhr .\" Copyright (c) 2021 Matthias Schmidt
4 545546b9 2021-09-06 xhr .\" Permission to use, copy, modify, and distribute this software for any
5 545546b9 2021-09-06 xhr .\" purpose with or without fee is hereby granted, provided that the above
6 545546b9 2021-09-06 xhr .\" copyright notice and this permission notice appear in all copies.
8 545546b9 2021-09-06 xhr .\" THE SOFTWARE IS PROVIDED "AS IS" AND THE AUTHOR DISCLAIMS ALL WARRANTIES
9 545546b9 2021-09-06 xhr .\" WITH REGARD TO THIS SOFTWARE INCLUDING ALL IMPLIED WARRANTIES OF
10 545546b9 2021-09-06 xhr .\" MERCHANTABILITY AND FITNESS. IN NO EVENT SHALL THE AUTHOR BE LIABLE FOR
11 545546b9 2021-09-06 xhr .\" ANY SPECIAL, DIRECT, INDIRECT, OR CONSEQUENTIAL DAMAGES OR ANY DAMAGES
12 545546b9 2021-09-06 xhr .\" WHATSOEVER RESULTING FROM LOSS OF USE, DATA OR PROFITS, WHETHER IN AN
13 545546b9 2021-09-06 xhr .\" ACTION OF CONTRACT, NEGLIGENCE OR OTHER TORTIOUS ACTION, ARISING OUT OF
14 545546b9 2021-09-06 xhr .\" OR IN CONNECTION WITH THE USE OR PERFORMANCE OF THIS SOFTWARE.
17 a704cbee 2021-09-16 xhr .Dd September 16, 2021
18 545546b9 2021-09-06 xhr .Dt ISSCROLLS 1
21 545546b9 2021-09-06 xhr .Nm isscrolls
22 a9355b63 2021-09-09 xhr .Nd Simple player toolkit for the
23 a9355b63 2021-09-09 xhr .Em Ironsworn
26 545546b9 2021-09-06 xhr .Nm isscrolls
28 545546b9 2021-09-06 xhr .Sh DESCRIPTION
30 545546b9 2021-09-06 xhr is a simple toolkit for players of the Ironsworn tabletop RPG.
31 545546b9 2021-09-06 xhr It is intended for both solo and co-op player and allows to roll different
32 545546b9 2021-09-06 xhr dices such as action or oracle rolls.
33 545546b9 2021-09-06 xhr It also provides results from the static oracle tables from the
34 545546b9 2021-09-06 xhr official rulebook.
35 af92ffb1 2021-09-15 xhr The options are as follows:
36 af92ffb1 2021-09-15 xhr .Bl -tag -width Ds
38 af92ffb1 2021-09-15 xhr Enable colors.
40 a9355b63 2021-09-09 xhr .Sh HOW TO USE
42 43795958 2021-09-09 xhr basically works like a
45 a9355b63 2021-09-09 xhr Commands can be entered and will show their output.
46 a9355b63 2021-09-09 xhr Certain commands need an argument in order to run properly, other commands
47 a9355b63 2021-09-09 xhr might support optional arguments.
48 43795958 2021-09-09 xhr Once a character is loaded, the prompt will change and display the
49 43795958 2021-09-09 xhr character's name.
52 a9355b63 2021-09-09 xhr command will show an overview of all available commands.
55 75dd2c5c 2021-09-13 xhr is linked against
56 75dd2c5c 2021-09-13 xhr .Xr readline 3 ,
57 75dd2c5c 2021-09-13 xhr thus any shortcut or character combination that work with a common
59 75dd2c5c 2021-09-13 xhr shell also work for the built-in shell.
60 a9355b63 2021-09-09 xhr .Ss General Commands
61 a9355b63 2021-09-09 xhr This sub-section shows general commands that are not dice rolls and game moves.
63 43795958 2021-09-09 xhr .It Ic cd Op name
66 43795958 2021-09-09 xhr is invoked with the
68 43795958 2021-09-09 xhr argument and a character with that name exists, it is loaded as the active
70 43795958 2021-09-09 xhr If it is invoked without arguments and a character is loaded, the character
71 43795958 2021-09-09 xhr is saved and unloaded.
73 a9355b63 2021-09-09 xhr Shows an overview of all available commands.
75 a9355b63 2021-09-09 xhr List all available characters.
79 a9355b63 2021-09-09 xhr and saves all characters and the command line history.
81 255c59a0 2021-09-09 xhr .Ss Dice Rolls
82 255c59a0 2021-09-09 xhr The following commands can be used to roll dice according to the game's
84 255c59a0 2021-09-09 xhr The can be used since
86 255c59a0 2021-09-09 xhr does not provide commands for all moves in the game.
88 255c59a0 2021-09-09 xhr .It Ic action Cm stat Op bonus
90 255c59a0 2021-09-09 xhr .Em action die
92 255c59a0 2021-09-09 xhr .Em challenge dice .
93 255c59a0 2021-09-09 xhr Providing one number as
95 255c59a0 2021-09-09 xhr is mandatory.
96 255c59a0 2021-09-09 xhr Provide an optional
98 255c59a0 2021-09-09 xhr that will be added to this roll.
99 255c59a0 2021-09-09 xhr .It Ic challenge
101 255c59a0 2021-09-09 xhr .Em challenge die .
102 255c59a0 2021-09-09 xhr .It Ic oracle
104 255c59a0 2021-09-09 xhr .Em oracle die .
105 255c59a0 2021-09-09 xhr .It Ic yesorno Cm odds
107 255c59a0 2021-09-09 xhr .Em challenge dice
108 255c59a0 2021-09-09 xhr to get an answer to a yes/no question from the oracle.
110 255c59a0 2021-09-09 xhr has to be a number (1-5) of the following list:
111 255c59a0 2021-09-09 xhr .Bl -enum -compact
113 255c59a0 2021-09-09 xhr Almost certain
121 255c59a0 2021-09-09 xhr Small chance
124 a9355b63 2021-09-09 xhr .Ss Character Commands
125 a9355b63 2021-09-09 xhr The following commands can be used to modify your character.
127 a9355b63 2021-09-09 xhr supports multiple characters, however, only one can be loaded at a time.
128 a9355b63 2021-09-09 xhr Most commands do nothing or present a warning if no character is loaded.
130 a9355b63 2021-09-09 xhr .It Ic create Op name
131 a9355b63 2021-09-09 xhr Create a new character.
132 a9355b63 2021-09-09 xhr If the optional argument
134 a9355b63 2021-09-09 xhr is provided, it will be used as the character's name.
135 a9355b63 2021-09-09 xhr Otherwise, the name will be asked interactively.
136 a9355b63 2021-09-09 xhr .It Ic decrease Cm stat
137 a9355b63 2021-09-09 xhr Decrease the character's value named
140 a9355b63 2021-09-09 xhr To give the player a bit more flexibility, this allows to decrease values even
141 a9355b63 2021-09-09 xhr if this is forbidden by the official
142 a9355b63 2021-09-09 xhr .Em Ironsworn
144 a9355b63 2021-09-09 xhr The following values can be decreased:
145 c279fa9b 2021-09-09 xhr .Bl -bullet -compact
167 a9355b63 2021-09-09 xhr .It Ic delete
168 a9355b63 2021-09-09 xhr Delete the current character without warning!
169 a9355b63 2021-09-09 xhr .It Ic increase Cm stat
171 a9355b63 2021-09-09 xhr .Ic decrease ,
172 a9355b63 2021-09-09 xhr only it increases the stat by 1.
173 a9355b63 2021-09-09 xhr .It Ic print
174 a9355b63 2021-09-09 xhr Print the current character's stats.
175 a9355b63 2021-09-09 xhr .It Ic toggle Cm stat
176 a9355b63 2021-09-09 xhr Toggle a character's stat named
178 a9355b63 2021-09-09 xhr If it's set to 0, it will be set to 1 or vice versa.
179 a9355b63 2021-09-09 xhr The following values can be modified.
180 c279fa9b 2021-09-09 xhr .Bl -bullet -compact
191 a9355b63 2021-09-09 xhr Note that this is a permanent bane and cannot be changed once it has been set.
194 a9355b63 2021-09-09 xhr Note that this is a permanent bane and cannot be changed once it has been set.
201 a9355b63 2021-09-09 xhr .Ss Adventure Moves
202 a9355b63 2021-09-09 xhr Adventure Moves are used as your character travels the Ironlands, investigate
203 a9355b63 2021-09-09 xhr situations and deal with threats.
205 a704cbee 2021-09-16 xhr .It Ic facedanger Cm stat Op bonus
207 a9355b63 2021-09-09 xhr .Em Face Danger
208 a9355b63 2021-09-09 xhr move using the character's stat named
210 c5083814 2021-09-09 xhr This move can done using the following stats: edge, heart, iron, shadow, and
212 a704cbee 2021-09-16 xhr An additional
214 a704cbee 2021-09-16 xhr can be provided.
215 a704cbee 2021-09-16 xhr .It Ic secureanadvantage Cm stat Op bonus
217 a9355b63 2021-09-09 xhr .Em Secure An Advantage
218 a9355b63 2021-09-09 xhr move using the character's stat named
220 c5083814 2021-09-09 xhr This move can done using the following stats: edge, heart, iron, shadow, and
222 a704cbee 2021-09-16 xhr An additional
224 a704cbee 2021-09-16 xhr can be provided.
225 a9355b63 2021-09-09 xhr .It Ic gatherinformation Op bonus
227 a9355b63 2021-09-09 xhr .Em Gather Information
229 a9355b63 2021-09-09 xhr Provide an optional
231 a9355b63 2021-09-09 xhr that will be added to this roll.
232 a704cbee 2021-09-16 xhr .It Ic heal Cm who Op bonus
236 a9355b63 2021-09-09 xhr If the character wants to heal themselves, the argument
238 a9355b63 2021-09-09 xhr has to be provided.
240 4c7ccdc2 2021-09-09 xhr automatically selects the character's Iron or Wits, whichever is lower.
241 a9355b63 2021-09-09 xhr If the character wants to heal someone else, the argument
243 a9355b63 2021-09-09 xhr has to be provided.
244 a704cbee 2021-09-16 xhr An additional
246 a704cbee 2021-09-16 xhr can be provided.
247 a704cbee 2021-09-16 xhr .It Ic resupply Op bonus
249 a9355b63 2021-09-09 xhr .Em Resupply
251 a704cbee 2021-09-16 xhr An additional
253 a704cbee 2021-09-16 xhr can be provided.
254 a9355b63 2021-09-09 xhr .It Ic makecamp Op bonus
256 a9355b63 2021-09-09 xhr .Em Make Camp
258 ff4cf5df 2021-09-11 xhr .It Ic undertakeajourney Op bonus
260 a9355b63 2021-09-09 xhr .Em Undertake a Journey
262 a9355b63 2021-09-09 xhr Provide an optional
264 a9355b63 2021-09-09 xhr that will be added to this roll.
266 6b094918 2021-09-11 xhr In case this is the first move of a new journey,
268 ff4cf5df 2021-09-11 xhr will ask for a difficulty and save it for the character.
269 ff4cf5df 2021-09-11 xhr Progress will be tracked automatically according to the difficulty.
270 ff4cf5df 2021-09-11 xhr For lower difficulties (
271 ff4cf5df 2021-09-11 xhr .Em Troublesome
273 ff4cf5df 2021-09-11 xhr .Em Formidable
274 ff4cf5df 2021-09-11 xhr ), progress will be shown as absolute numbers, e.g. 2/10.
275 ff4cf5df 2021-09-11 xhr For higher difficulties (
279 ff4cf5df 2021-09-11 xhr ), progress will be shown as decimal numbers and 0.25 represents one tick,
280 ff4cf5df 2021-09-11 xhr e.g. 0.75/10 means that the character already made 3 ticks progress.
281 a704cbee 2021-09-16 xhr .It Ic reachyourdestination Op bonus
283 ff4cf5df 2021-09-11 xhr .Em Reach Your Destination
285 ff4cf5df 2021-09-11 xhr In case of a
287 ff4cf5df 2021-09-11 xhr , the character can choose to abort the journey or continue with it.
288 a704cbee 2021-09-16 xhr An additional
290 a704cbee 2021-09-16 xhr can be provided.
292 a9355b63 2021-09-09 xhr .Ss Relationship Moves
293 c279fa9b 2021-09-09 xhr The following moves are made as the character interacts with others in the wild,
294 c279fa9b 2021-09-09 xhr fight duels, form bonds, support your allies, and determine the ultimate fate.
296 a704cbee 2021-09-16 xhr .It Ic compel Cm stat Op bonus
299 c279fa9b 2021-09-09 xhr move using the character's stat named
301 c279fa9b 2021-09-09 xhr This move can done using the following stats: heart, iron, and shadow.
302 a704cbee 2021-09-16 xhr An additional
304 a704cbee 2021-09-16 xhr can be provided.
305 c279fa9b 2021-09-09 xhr .It Ic sojourn Op bonus
309 c279fa9b 2021-09-09 xhr Provide an optional
311 c279fa9b 2021-09-09 xhr that will be added to this roll.
312 c279fa9b 2021-09-09 xhr .It Ic drawthecircle Op bonus
314 c279fa9b 2021-09-09 xhr .Em Draw The Circle
316 c279fa9b 2021-09-09 xhr Provide an optional
318 c279fa9b 2021-09-09 xhr that will be added to this roll.
319 a704cbee 2021-09-16 xhr .It Ic forgeabond Op bonus
321 c279fa9b 2021-09-09 xhr .Em Forge a Bond
323 a704cbee 2021-09-16 xhr An additional
325 a704cbee 2021-09-16 xhr can be provided.
326 a704cbee 2021-09-16 xhr .It Ic testyourbond Op bonus
328 c279fa9b 2021-09-09 xhr .Em Test Your Bond
330 a704cbee 2021-09-16 xhr An additional
332 a704cbee 2021-09-16 xhr can be provided.
334 a9355b63 2021-09-09 xhr .Ss Combat Moves
335 4c7ccdc2 2021-09-09 xhr When there are no other options, when the sword flips free of its sheath, when
336 4c7ccdc2 2021-09-09 xhr the arrow is nocked, when the shield is brought to bear, these moves can
339 a704cbee 2021-09-16 xhr .It Ic enterthefray Cm stat Op bonus
341 4c7ccdc2 2021-09-09 xhr .Em Enter the Fray
342 4c7ccdc2 2021-09-09 xhr move using the character's stat named
344 4c7ccdc2 2021-09-09 xhr This move can done using the following stats: heart, wits, and shadow.
346 6b094918 2021-09-11 xhr In case this is the first move in a fight,
348 6b094918 2021-09-11 xhr will ask for a difficulty and save it for the fight.
349 6b094918 2021-09-11 xhr Progress per harm will be tracked automatically according to the difficulty.
350 6b094918 2021-09-11 xhr For lower difficulties (
351 6b094918 2021-09-11 xhr .Em Troublesome
353 6b094918 2021-09-11 xhr .Em Formidable
354 6b094918 2021-09-11 xhr ), progress will be shown as absolute numbers, e.g. 2/10.
355 6b094918 2021-09-11 xhr For higher difficulties (
359 6b094918 2021-09-11 xhr ), progress will be shown as decimal numbers and 0.25 represents one tick,
360 6b094918 2021-09-11 xhr e.g. 0.75/10 means that the character already made 3 ticks progress.
361 a704cbee 2021-09-16 xhr An additional
363 a704cbee 2021-09-16 xhr can be provided.
364 a704cbee 2021-09-16 xhr .It Ic endthefight Op bonus
366 6b094918 2021-09-11 xhr .Em End the Fight
368 a704cbee 2021-09-16 xhr An additional
370 a704cbee 2021-09-16 xhr can be provided.
371 a704cbee 2021-09-16 xhr .It Ic strike Cm stat Op bonus
374 4c7ccdc2 2021-09-09 xhr move using the character's stat named
376 4c7ccdc2 2021-09-09 xhr This move can done using the following stats: iron, and edge.
377 a704cbee 2021-09-16 xhr An additional
379 a704cbee 2021-09-16 xhr can be provided.
380 a704cbee 2021-09-16 xhr .It Ic clash Cm stat Op bonus
383 4c7ccdc2 2021-09-09 xhr move using the character's stat named
385 4c7ccdc2 2021-09-09 xhr This move can done using the following stats: iron, and edge.
386 a704cbee 2021-09-16 xhr An additional
388 a704cbee 2021-09-16 xhr can be provided.
389 a704cbee 2021-09-16 xhr .It Ic battle Cm stat Op bonus
392 4c7ccdc2 2021-09-09 xhr move using the character's stat named
394 c5083814 2021-09-09 xhr This move can done using the following stats: edge, heart, iron, shadow, and
396 a704cbee 2021-09-16 xhr An additional
398 a704cbee 2021-09-16 xhr can be provided.
400 a9355b63 2021-09-09 xhr .Ss Quest Moves
401 23ab4f0c 2021-09-15 xhr The commands represent important moves a characters makes during their quest.
403 4c7ccdc2 2021-09-09 xhr .It Ic swearanironvow Op bonus
405 4c7ccdc2 2021-09-09 xhr .Em Swear an Iron Vow
407 4c7ccdc2 2021-09-09 xhr Provide an optional
409 4c7ccdc2 2021-09-09 xhr that will be added to this roll.
411 c490e04f 2021-09-13 xhr .Ss Suffer Moves
412 770f910d 2021-09-13 xhr These moves are made as a result of a perilous event or bad outcome on other
414 770f910d 2021-09-13 xhr They represent what happens to the character, and how they hold up against
417 95d6a676 2021-09-15 xhr .It Ic endureharm Op value
419 c490e04f 2021-09-13 xhr .Em Endure Harm
421 95d6a676 2021-09-15 xhr In case the character is in a fight, the amount of harm to suffer is
422 95d6a676 2021-09-15 xhr automatically calculated from the foe's difficulty.
423 95d6a676 2021-09-15 xhr If the character is not in a fight, the amount of harm to suffer can be
424 95d6a676 2021-09-15 xhr provided with the optional argument
426 c490e04f 2021-09-13 xhr Since there are multiple options on what can happen on a
428 c490e04f 2021-09-13 xhr the decision is up to the player and not implemented in
430 a704cbee 2021-09-16 xhr .It Ic facedeath Op bonus
432 c490e04f 2021-09-13 xhr .Em Face Death
434 c490e04f 2021-09-13 xhr In case the character dies, it is marked as such and
435 c490e04f 2021-09-13 xhr .Dq Deceased
436 c490e04f 2021-09-13 xhr is printed in the character's statistics.
437 a704cbee 2021-09-16 xhr An additional
439 a704cbee 2021-09-16 xhr can be provided.
440 c490e04f 2021-09-13 xhr .It Ic endurestress Cm value
442 c490e04f 2021-09-13 xhr .Em Endure Stress
446 c490e04f 2021-09-13 xhr that will be removed from your spirit.
447 c490e04f 2021-09-13 xhr Since there are multiple reasons why the character can suffer stress, the
450 c490e04f 2021-09-13 xhr to suffer has to be provided as argument and is not implemented within
453 a9355b63 2021-09-09 xhr .Ss Oracle Moves
454 43795958 2021-09-09 xhr The following commands provide results from the various oracle tables in the
457 4c7ccdc2 2021-09-09 xhr .It Ic actionoracle
458 d7a68fb2 2021-09-09 xhr Show a random action.
459 4c7ccdc2 2021-09-09 xhr .It Ic combataction
460 d7a68fb2 2021-09-09 xhr Show a random combat action.
461 3ea4b207 2021-09-09 xhr .It Ic coastalwaterlocation
462 d7a68fb2 2021-09-09 xhr Show a random coastal waters location.
463 d7a68fb2 2021-09-09 xhr .It Ic elfname
464 d7a68fb2 2021-09-09 xhr Show a random elf name.
465 4c7ccdc2 2021-09-09 xhr .It Ic giantname
466 d7a68fb2 2021-09-09 xhr Show a random giant name.
467 4c7ccdc2 2021-09-09 xhr .It Ic ironlandername
468 d7a68fb2 2021-09-09 xhr Show a random Ironlander name.
469 4c7ccdc2 2021-09-09 xhr .It Ic location
470 d7a68fb2 2021-09-09 xhr Show a random location.
471 4c7ccdc2 2021-09-09 xhr .It Ic locationdescription
472 d7a68fb2 2021-09-09 xhr Show a random description for a location.
473 4c7ccdc2 2021-09-09 xhr .It Ic mysticbackslash
474 d7a68fb2 2021-09-09 xhr Show a random mystic backslash.
475 e38220a2 2021-09-13 xhr .It Ic paytheprice
476 e38220a2 2021-09-13 xhr Show a random
477 e38220a2 2021-09-13 xhr .Dq Pay the price
479 4c7ccdc2 2021-09-09 xhr .It Ic plottwist
480 d7a68fb2 2021-09-09 xhr Show a random plot twist.
482 d7a68fb2 2021-09-09 xhr Show a random rank.
483 4c7ccdc2 2021-09-09 xhr .It Ic region
484 d7a68fb2 2021-09-09 xhr Show a random Ironlands region.
485 4c7ccdc2 2021-09-09 xhr .It Ic theme
486 d7a68fb2 2021-09-09 xhr Show a random theme.
487 4c7ccdc2 2021-09-09 xhr .It Ic varou
488 d7a68fb2 2021-09-09 xhr Show a random Varou name.
490 545546b9 2021-09-06 xhr .Sh ENVIRONMENT
492 545546b9 2021-09-06 xhr makes use of the following environment variables.
493 545546b9 2021-09-06 xhr .Bl -tag -width XDG_CONFIG_HOME
496 cd5caf9f 2021-09-06 xhr .Ev XDG_CONFIG_HOME
497 545546b9 2021-09-06 xhr variable is not set,
499 545546b9 2021-09-06 xhr stores its history and other data in the
500 545546b9 2021-09-06 xhr .Pa .isscrolls
501 545546b9 2021-09-06 xhr subdirectory in the user's home directory.
502 545546b9 2021-09-06 xhr .It Ev XDG_CONFIG_HOME
503 545546b9 2021-09-06 xhr In case this variable is set,
505 545546b9 2021-09-06 xhr stores its history and other data in the
506 545546b9 2021-09-06 xhr .Pa isscrolls
507 545546b9 2021-09-06 xhr subdirectory under the path set by this environment variable.
510 cd5caf9f 2021-09-06 xhr .Bl -tag -width Ds -compact
511 cd5caf9f 2021-09-06 xhr .It Pa /usr/local/share/isscrolls
512 cd5caf9f 2021-09-06 xhr This is the location where shared files such as the JSON files containing the
513 cd5caf9f 2021-09-06 xhr oracle tables are stored.
515 545546b9 2021-09-06 xhr .Sh EXIT STATUS
517 545546b9 2021-09-06 xhr normally exists with 0 or with 1 if an error occurred.
518 75dd2c5c 2021-09-13 xhr .Sh SEE ALSO
519 75dd2c5c 2021-09-13 xhr .Xr readline 3
520 545546b9 2021-09-06 xhr .Sh STANDARDS
522 a95f3884 2021-09-13 xhr .%A Shawn Tomkin
523 cd5caf9f 2021-09-06 xhr .%B Ironsworn. A tabletop RPG of perilous Quests
525 a95f3884 2021-09-13 xhr .%U https://www.ironswornrpg.com/
529 545546b9 2021-09-06 xhr was written by
530 545546b9 2021-09-06 xhr .An Matthias Schmidt Aq Mt xhr@giessen.ccc.de .