mirror of
https://gitlab.com/EternalWanderer/sheet-parser.git
synced 2024-11-29 05:23:49 +01:00
Worked on manpage
This commit is contained in:
parent
985a6dc9e5
commit
a047837800
122
sheet-parser.1
122
sheet-parser.1
|
@ -2,20 +2,31 @@
|
||||||
.SH NAME
|
.SH NAME
|
||||||
sheet-parser \- D&D sheet parser utility written in go
|
sheet-parser \- D&D sheet parser utility written in go
|
||||||
.SH SYNOPSIS
|
.SH SYNOPSIS
|
||||||
.B dice-roller
|
.B sheet-parser
|
||||||
.OP -a
|
.OP -f <file>
|
||||||
.OP -s
|
.OP --file <file>
|
||||||
.OP -c
|
|
||||||
.OP -m
|
|
||||||
.PP
|
.PP
|
||||||
.B dice-roller
|
.B sheet-parser
|
||||||
|
.OP -t
|
||||||
|
.OP --trivia
|
||||||
|
.PP
|
||||||
|
.B sheet-parser
|
||||||
|
.OP -v
|
||||||
|
.OP --verbose
|
||||||
|
.PP
|
||||||
|
.B sheet-parser
|
||||||
.OP --advantage
|
.OP --advantage
|
||||||
.PP
|
|
||||||
.B dice-roller
|
|
||||||
.OP --disadvantage
|
.OP --disadvantage
|
||||||
.PP
|
.PP
|
||||||
.B dice-roller
|
.B sheet-parser
|
||||||
.OP --coin
|
.OP --skill-list
|
||||||
|
.OP --stat-list
|
||||||
|
.PP
|
||||||
|
.B sheet-parser
|
||||||
|
.OP --stat <stat>
|
||||||
|
.OP --save <stat>
|
||||||
|
.OP --skill <skill>
|
||||||
|
.PP
|
||||||
.SH DESCRIPTION
|
.SH DESCRIPTION
|
||||||
.B sheet-parser
|
.B sheet-parser
|
||||||
is a little utility written with the purpose of being able to parse 5e D&D sheets.
|
is a little utility written with the purpose of being able to parse 5e D&D sheets.
|
||||||
|
@ -26,23 +37,88 @@ This thing makes use of some of the functionality of
|
||||||
mainly the way it deals with advantage and disadvantage.
|
mainly the way it deals with advantage and disadvantage.
|
||||||
.SH OPTIONS
|
.SH OPTIONS
|
||||||
.TP
|
.TP
|
||||||
.B -a --attacks
|
.B -f --file
|
||||||
Roll a set rules multiple times, does not apply to advantage and disadvantage, defaults to 1.
|
Specify path to character sheet.
|
||||||
|
An example character sheet can be found at '/etc/sheet-parser/example.json'
|
||||||
.TP
|
.TP
|
||||||
.B -s --surfaces
|
.B -v --verbose
|
||||||
Use to specify die surfaces, does not apply to advantage and disadvantage, defaults to 20.
|
Show more stat information; to be used in conjuction with --skill-list or --stat-list
|
||||||
.TP
|
.TP
|
||||||
.B -c --throws
|
.B --skill <skill>
|
||||||
Specify amount of dice to cast
|
Used to roll a skill check, standard skill options are listed in a later section.
|
||||||
.TP
|
.TP
|
||||||
.B -m --modifier
|
.B --stat <stat>
|
||||||
Add modifier to result of rolls
|
Used to roll a skill check, standard stat options are in a later section.
|
||||||
|
.TP
|
||||||
|
.B --save <stat>
|
||||||
|
Used to roll a saving throw, standard stat options are in a later section.
|
||||||
|
.TP
|
||||||
|
.B -t --trivia
|
||||||
|
Used to print sheet's name, race, class, level and proficiency bonus.
|
||||||
.TP
|
.TP
|
||||||
.B --advantage
|
.B --advantage
|
||||||
Roll two 2d20 and take the highest number, accepts modifiers
|
Roll a check with 2d20 and take the highest number, to be used in conjuction with --save --skill or --stat
|
||||||
.TP
|
.TP
|
||||||
.B --disadvantage
|
.B --disadvantage
|
||||||
Roll two 2d20 and take the lowest number, accepts modifiers
|
Roll a check with 2d20 and take the lowest number, to be used in conjuction with --save --skill or --stat
|
||||||
.TP
|
.PP
|
||||||
.B --coin
|
.SH STATS & SKILLS
|
||||||
Toss a coin, same behaviour as throwing with 2 surfaces, only accepts different amount of casts.
|
|
||||||
|
.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
|
||||||
|
|
|
@ -3,8 +3,8 @@
|
||||||
arguments=(
|
arguments=(
|
||||||
'(--advantage --disadvantage --skill --save --stat --skill-list --stat-list -v --verbose --trivia -t)--trivia[Print character trivia]'
|
'(--advantage --disadvantage --skill --save --stat --skill-list --stat-list -v --verbose --trivia -t)--trivia[Print character trivia]'
|
||||||
'(--advantage --disadvantage --skill --save --stat --skill-list --stat-list -v --verbose --trivia -t)-t[Print character trivia]'
|
'(--advantage --disadvantage --skill --save --stat --skill-list --stat-list -v --verbose --trivia -t)-t[Print character trivia]'
|
||||||
'(--file)-f=[Path to charactersheet]:character sheet:_files -g "*.(json)(-.)"'
|
'(--file)-f=[Path to character sheet]:character sheet:_files -g "*.(json)(-.)"'
|
||||||
'(-f)--file=[Path to charactersheet]:character sheet:_files -g "*.(json)(-.)"'
|
'(-f)--file=[Path to character sheet]:character sheet:_files -g "*.(json)(-.)"'
|
||||||
'(--trivia -t --advantage --disadvantage --skill-list --stat-list --skill --save --stat --verbose)-v[To be used in conjuction with list parameters]'
|
'(--trivia -t --advantage --disadvantage --skill-list --stat-list --skill --save --stat --verbose)-v[To be used in conjuction with list parameters]'
|
||||||
'(--trivia -t --advantage --disadvantage --skill-list --stat-list --skill --save --stat -v)--verbose[To be used in conjuction with list parameters]'
|
'(--trivia -t --advantage --disadvantage --skill-list --stat-list --skill --save --stat -v)--verbose[To be used in conjuction with list parameters]'
|
||||||
'(--skill --stat --save --advantage --disadvantage --skill-list --stat-list)--stat-list[List stats found in file]'
|
'(--skill --stat --save --advantage --disadvantage --skill-list --stat-list)--stat-list[List stats found in file]'
|
||||||
|
|
Loading…
Reference in a new issue