cleaning up code
This commit is contained in:
25
README.md
25
README.md
@@ -2,6 +2,8 @@
|
||||
|
||||
This tool uses the Old School Essentials (OSE) ruleset for tabletop RPGs in order to randomly generate a character.
|
||||
|
||||
## Overview
|
||||
|
||||
### What is Dungeons & Dragons?
|
||||
Dungeons & Dragons, also known as D&D, is a pen and paper table top game. One player is the story teller, the "dungeon master" and the others interact with the story using their "adventurers." An adventurer is a playable character, who has a mixture of abilities and powers, the details of which are often kept on piece of paper called a "character sheet."
|
||||
|
||||
@@ -20,3 +22,26 @@ This app accomplishes a few things, but mainly it creates a character for you.
|
||||
- You can generate a whole party of characters
|
||||
- Within that party, you can adjust their level, and the number of characters
|
||||
- You can create a single character to edit
|
||||
|
||||
|
||||
## Instructions
|
||||
|
||||
### Install
|
||||
This is a flask web application, to install:
|
||||
|
||||
1. Clone this repo
|
||||
2. Install requirements, `python3 pip install -r requirements.txt`
|
||||
3. To run the webserver execute `flask run` while in your cloned repository's top folder.
|
||||
|
||||
### To Use
|
||||
There are two main generators, one for a single character and another for a group, or a "party" of characters.
|
||||
1. Character Generator
|
||||
- You may select a class and a level
|
||||
- The re-roll button always starts the character back to level 1
|
||||
2. Party Generator
|
||||
- You may also select the level for this group
|
||||
- You may select the count, between 2 and 5.
|
||||
- If you want to have the party persist across refreshes, level and size changes, keep "cached" on
|
||||
- Otherwise, "not cached" will always generate a new party
|
||||
- If you find a single character interesting, you may "select" them and it will load **this** character in the "charater generator."
|
||||
|
||||
|
||||
Reference in New Issue
Block a user