sheet-parser/sheet-parser.1

.\" Generated by scdoc 1.11.2
.\" Complete documentation for this program is not available as a GNU info page
.ie \n(.g .ds Aq \(aq
.el       .ds Aq '
.nh
.ad l
.\" Begin generated content:
.TH "sheet-parser" "1" "2022-08-29"
.P
.SH NAME
.P
sheet-parser - D&D sheet parser utility written in go
.P
.SH SYNOPSIS
.P
\fBsheet-parser\fR [\fB-f\fR \fI<file>\fR] [\fB--file\fR \fI<file>\fR]
.P
\fBsheet-parser\fR [\fB-t\fR] [\fB--trivia\fR]
.P
\fBsheet-parser\fR [\fB-v\fR] [\fB--verbose\fR]
.P
\fBsheet-parser\fR [\fB--advantage\fR] [\fB--disadvantage\fR]
.P
\fBsheet-parser\fR [\fB--skill-list\fR] [\fB--stat-list\fR]
.P
\fBsheet-parser\fR [\fB--stat\fR \fI<stat>\fR] [\fB--save\fR \fI<stat>\fR] [\fB--skill\fR \fI<skill>\fR]
.P
.SH DESCRIPTION
.P
\fBsheet-parser\fR 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.\&
.P
This thing makes use of some of the functionality of dice-roller, mainly the way it deals with advantage and disadvantage.\&
.P
.SH OPTIONS
.P
\fB-f --file\fR
.RS 4
Specify path to character sheet.\& Example character sheet can be found at
\&'\&/etc/sheet-parser/example.\&json'\&
.P
.RE
\fB-v --verbose\fR
.RS 4
Show more information; to be used in conjunction with \fB--skill-list\fR or
\fB--stat-list\fR
.P
.RE
\fB-t --trivia\fR
.RS 4
Used to print character sheet'\&s name, race, class, level and proficiency
bonus
.P
.RE
\fB--stat\fR \fI<stat>\fR
.RS 4
Roll a stat check, standard stats can be printed using
\fB--stat-list\fR and are also listed in the a dedicated section
.P
.RE
\fB--save\fR \fI<stat>\fR
.RS 4
Roll a saving throw, standard stats can be printed using
\fB--stat-list\fR and are also listed in the a dedicated section
.P
.RE
\fB--skill\fR \fI<skill>\fR
.RS 4
Roll a skill check, standard stats can be printed using
\fB--skill-list\fR and are also listed in the a dedicated section
.P
.RE
\fB--stat-list\fR
.RS 4
Print list of standard stats
.P
.RE
\fB--skill-list\fR
.RS 4
Print list of standard skills
.P
.RE
\fB-v --verbose\fR
.RS 4
Print given character sheet'\&s scores and modifiers; to be used in
conjunction with \fB--stat-list\fR and \fB--skill-list\fR
.P
.RE
\fB--advantage\fR
.RS 4
Roll a check with 2d20 and take the highest number; to be used in
conjunction with \fB--save\fR \fB--skill\fR or \fB--stat\fR
.P
.RE
\fB--disadvantage\fR
.RS 4
Roll a check with 2d20 and take the lowest number; to be used in
conjunction with \fB--save\fR \fB--skill\fR or \fB--stat\fR
.P
.RE
.SH CONFIGURATION
.P
You can change the default character sheet by setting \fB$CHARSHEET\fR to point to a
character sheet JSON file.\& This will still be overruled using \fB--file\fR.\&
.P
.SH STATS & SKILLS
\fBsheet-parser\fR makes use of stats and skills according to the rules of D&D 5e.\&
This means that the modifies of all the skills and stats are based on the scores
of the stats.\&
.P
\fBDefault stats are:\fR
.RS 4
.RS 4
.ie n \{\
\h'-04'\(bu\h'+03'\c
.\}
.el \{\
.IP \(bu 4
.\}
strength
.RE
.RS 4
.ie n \{\
\h'-04'\(bu\h'+03'\c
.\}
.el \{\
.IP \(bu 4
.\}
dexterity
.RE
.RS 4
.ie n \{\
\h'-04'\(bu\h'+03'\c
.\}
.el \{\
.IP \(bu 4
.\}
constitution
.RE
.RS 4
.ie n \{\
\h'-04'\(bu\h'+03'\c
.\}
.el \{\
.IP \(bu 4
.\}
intelligence
.RE
.RS 4
.ie n \{\
\h'-04'\(bu\h'+03'\c
.\}
.el \{\
.IP \(bu 4
.\}
wisdom
.RE
.RS 4
.ie n \{\
\h'-04'\(bu\h'+03'\c
.\}
.el \{\
.IP \(bu 4
.\}
charisma
.RE

.RE
\fBDefault skills are:\fR
.RS 4
.RS 4
.ie n \{\
\h'-04'\(bu\h'+03'\c
.\}
.el \{\
.IP \(bu 4
.\}
athletics
.RE
.RS 4
.ie n \{\
\h'-04'\(bu\h'+03'\c
.\}
.el \{\
.IP \(bu 4
.\}
acrobatics
.RE
.RS 4
.ie n \{\
\h'-04'\(bu\h'+03'\c
.\}
.el \{\
.IP \(bu 4
.\}
sleight_of_hand
.RE
.RS 4
.ie n \{\
\h'-04'\(bu\h'+03'\c
.\}
.el \{\
.IP \(bu 4
.\}
stealth
.RE
.RS 4
.ie n \{\
\h'-04'\(bu\h'+03'\c
.\}
.el \{\
.IP \(bu 4
.\}
arcana
.RE
.RS 4
.ie n \{\
\h'-04'\(bu\h'+03'\c
.\}
.el \{\
.IP \(bu 4
.\}
history
.RE
.RS 4
.ie n \{\
\h'-04'\(bu\h'+03'\c
.\}
.el \{\
.IP \(bu 4
.\}
investigation
.RE
.RS 4
.ie n \{\
\h'-04'\(bu\h'+03'\c
.\}
.el \{\
.IP \(bu 4
.\}
nature
.RE
.RS 4
.ie n \{\
\h'-04'\(bu\h'+03'\c
.\}
.el \{\
.IP \(bu 4
.\}
religion
.RE
.RS 4
.ie n \{\
\h'-04'\(bu\h'+03'\c
.\}
.el \{\
.IP \(bu 4
.\}
animal_handling
.RE
.RS 4
.ie n \{\
\h'-04'\(bu\h'+03'\c
.\}
.el \{\
.IP \(bu 4
.\}
insight
.RE
.RS 4
.ie n \{\
\h'-04'\(bu\h'+03'\c
.\}
.el \{\
.IP \(bu 4
.\}
medicine
.RE
.RS 4
.ie n \{\
\h'-04'\(bu\h'+03'\c
.\}
.el \{\
.IP \(bu 4
.\}
perception
.RE
.RS 4
.ie n \{\
\h'-04'\(bu\h'+03'\c
.\}
.el \{\
.IP \(bu 4
.\}
survival
.RE
.RS 4
.ie n \{\
\h'-04'\(bu\h'+03'\c
.\}
.el \{\
.IP \(bu 4
.\}
deception
.RE
.RS 4
.ie n \{\
\h'-04'\(bu\h'+03'\c
.\}
.el \{\
.IP \(bu 4
.\}
intimidation
.RE
.RS 4
.ie n \{\
\h'-04'\(bu\h'+03'\c
.\}
.el \{\
.IP \(bu 4
.\}
performance
.RE
.RS 4
.ie n \{\
\h'-04'\(bu\h'+03'\c
.\}
.el \{\
.IP \(bu 4
.\}
persuasion

.RE
.P
.RE
.SH CUSTOM CHARACTER SHEETS
To create a custom character sheet, copy the example file to some place where
you can edit it.\&
.P
.nf
.RS 4
cp /etc/sheet-parser/example\&.json foo\&.json
.fi
.RE
.P
From here, the most important fields are the stats scores, the proficiency and
expertise booleans; and the character level as these determine the results of
your rolls.\&
.P
.nf
.RS 4
"misc":{
	"level": 1,
	\&.\&.\&.
},
"stats":[
	{"statName":"strength", "score":20, "proficient":false },
	{"statName":"dexterity", "score":1, "proficient":false },
	\&.\&.\&.
],
"skills":[
	{"skillName":"athletics", "proficient":true, "expertise":false, "baseStat":"strength"},
	{"skillName":"acrobatics", "proficient":false, "expertise":false, "baseStat":"dexterity"}
	\&.\&.\&.
]
.fi
.RE