sheet-parser/sheet-parser.1

125 lines
2.4 KiB
Groff
Raw Normal View History

2022-08-21 01:12:22 +02:00
.TH SHEET-PARSER 1
.SH NAME
sheet-parser \- D&D sheet parser utility written in go
.SH SYNOPSIS
2022-08-23 18:13:02 +02:00
.B sheet-parser
.OP -f <file>
.OP --file <file>
2022-08-21 01:12:22 +02:00
.PP
2022-08-23 18:13:02 +02:00
.B sheet-parser
.OP -t
.OP --trivia
.PP
.B sheet-parser
.OP -v
.OP --verbose
2022-08-21 01:12:22 +02:00
.PP
2022-08-23 18:13:02 +02:00
.B sheet-parser
.OP --advantage
2022-08-21 01:12:22 +02:00
.OP --disadvantage
.PP
2022-08-23 18:13:02 +02:00
.B sheet-parser
.OP --skill-list
.OP --stat-list
.PP
.B sheet-parser
.OP --stat <stat>
.OP --save <stat>
.OP --skill <skill>
.PP
2022-08-21 01:12:22 +02:00
.SH DESCRIPTION
.B sheet-parser
is a little utility written with the purpose of being able to parse 5e D&D sheets.
Digging through all the different stats and skills and keeping track of their modifiers got a rather tiresome after a while.
This thing makes use of some of the functionality of
.B dice-roller,
mainly the way it deals with advantage and disadvantage.
.SH OPTIONS
.TP
2022-08-23 18:13:02 +02:00
.B -f --file
Specify path to character sheet.
An example character sheet can be found at '/etc/sheet-parser/example.json'
.TP
.B -v --verbose
Show more stat information; to be used in conjuction with --skill-list or --stat-list
.TP
.B --skill <skill>
Used to roll a skill check, standard skill options are listed in a later section.
2022-08-21 01:12:22 +02:00
.TP
2022-08-23 18:13:02 +02:00
.B --stat <stat>
Used to roll a skill check, standard stat options are in a later section.
2022-08-21 01:12:22 +02:00
.TP
2022-08-23 18:13:02 +02:00
.B --save <stat>
Used to roll a saving throw, standard stat options are in a later section.
2022-08-21 01:12:22 +02:00
.TP
2022-08-23 18:13:02 +02:00
.B -t --trivia
Used to print sheet's name, race, class, level and proficiency bonus.
2022-08-21 01:12:22 +02:00
.TP
.B --advantage
2022-08-23 18:13:02 +02:00
Roll a check with 2d20 and take the highest number, to be used in conjuction with --save --skill or --stat
2022-08-21 01:12:22 +02:00
.TP
.B --disadvantage
2022-08-23 18:13:02 +02:00
Roll a check with 2d20 and take the lowest number, to be used in conjuction with --save --skill or --stat
.PP
.SH STATS & SKILLS
.B sheet-parser
makes use of stats and skills according to the rules of D&D 5e. This means that the modifiers of all skills and stats are based on the scores of the stats.
.B Default stats are:
.RS
.IP \[bu] 2
strength
.IP \[bu] 2
dexterity
.IP \[bu] 2
constitution
.IP \[bu] 2
intelligence
.IP \[bu] 2
wisdom
.IP \[bu] 2
charisma
.RE
.B Default skills are:
.RS
.IP \[bu] 2
athletics
.IP \[bu] 2
acrobatics
.IP \[bu] 2
sleight_of_hand
.IP \[bu] 2
stealth
.IP \[bu] 2
arcana
.IP \[bu] 2
history
.IP \[bu] 2
investigation
.IP \[bu] 2
nature
.IP \[bu] 2
religion
.IP \[bu] 2
animal_handling
.IP \[bu] 2
insight
.IP \[bu] 2
medicine
.IP \[bu] 2
perception
.IP \[bu] 2
survival
.IP \[bu] 2
deception
.IP \[bu] 2
intimidation
.IP \[bu] 2
performance
.IP \[bu] 2
persuasion
.RE