Browse Source

Update readme

master
Noëlle 3 years ago
parent
commit
a3ced7d3e2
1 changed files with 11 additions and 6 deletions
  1. 11
    6
      README.md

+ 11
- 6
README.md View File

@@ -6,15 +6,20 @@ Invoke the script directly to generate a single kobold:

`python3 koboldgen.py`

Type a number after the name of the script to generate that many kobolds:
There are flags you can type after the name of the script to get different effects.

`python3 koboldgen.py 3`
The first three (`-k`, `-n`, and `-c`) can be used on their own, or you can add a number afterward to get the script to print that many kobolds:

generates 3 kobolds.
`python3 koboldgen.py -k` - generate a kobold

Use the `--campaign` or `-c` flags to generate a full campaign with 6 kobolds:
`python3 koboldgen.py -n` - print out a kobold's name and occupation, without a stat block

`python3 koboldgen.py --campaign`
`python3 koboldgen.py -c` - print out a full campaign with 6 kobolds by default

`python3 koboldgen.py -c`
The next three should always be used on their own, without anything else on the command line:

`python3 koboldgen.py -s` - print out a ship name and description

`python3 koboldgen.py -p` - print out the premise of a campaign, including a ship name and description, without generating any kobolds

`python3 koboldgen.py -h` - print a help message

Loading…
Cancel
Save