Skip to content

kpete2017/DnDungeonMaster

Repository files navigation

D&DungeonMaster

Image of Home

Live-Site

https://dndungeonmaster-ab045.firebaseapp.com/

Table of Contents

About The Project

D&DungeonMaster is a powerful tool that helps Dungeon Master's everywhere keep their game sessions organized and accessable.

It does this by:

  • Keeping all the player and enemy information accessible from the home screen with a simple click.
  • Keeping an advanced compendium of every spell and monster officailly in Dungeons & Dragons 5th Edition.
  • Keeping all the players equipment, spells, and other notes in one easy to access place.

Built With

Getting Started

There is a seperate repositiory for the Ruby on Rails backend

Backend

In order to run the front-end of this project locally you will need Node.js

Prerequisites

In order to install this project you will need the latest version of Node Package Manager

npm install npm@latest -g

Installation

  1. Clone the repo
git clone https://github.com/kpete2017/DnDungeonMaster
  1. Install NPM packages
npm install

Compiles and hot-reloads for development

npm run serve

Compiles and minifies for production

npm run build

Lints and fixes files

npm run lint

Usage

Log-in Screen

Image of Login

From here the user can either login with the appropiate username or password or create a new account. To create a new account the user must provide a valid username, password, and name.

Home Screen

Image of Home

The homescreen is divided into four sections:

  • The calculator/note section (the most left column). Here the dungeon master can pin any of his created notes or make quick calculations.
  • The ally section (The top row of the middle column). From here the dungeon master can add any of their player characters or non player characters into the card layout, once clicked the card will expand out to reveal more information.
  • The enemy section (The bottom row of the middle column). From here the dungeon master can add any monster or non player characters into the card layout, once clicked the card will expand out to reveal more information.
  • The region/rotation/dice section(the most right column). Here the dungeon master can make quick edits to the region's information, change the turn rotation so it is easy to keep track of, and make a quick roll of the dice.

Notes Page

Image of Notes

The second option down on the nav bar is the notes page. From here a dungeon master can create or delete any notes related to the campaign.

Party Page

Image of Party

The third option down on the nav bar is the party page. From here the dungeon master can create, edit, or delete any player character. Once created here a party member can be added to the ally tab of the home page.

NPC Page

Image of NPC

The fourth option down on the nav bar is the NPC page. From here the dungeon master can create, edit, or delete any non player character. Once created here a NPC can be added to either the ally secition of the home page or the enemy secion.

Monster Page

Image of Monster

The fifth option down on the nav bar is the monster page. From here the dungeon master can browse every official monster from dungeons and dragons 5e. There is also a filter function which allows the dungeon master to search by name or challange rating.

Compendium Page

Image of Compendium

The sixth option down on the nav bar is the compendium page. From here the dungeon master can browse every official spell from dungeons and dragons 5e. The First row contains the name of the spell, The second row contains the spells attributes and description, the third row (Footer) contains the classes that can use the spell. There is also a filter function which allows the dungeon master to search by name.

Contributing

If you wish to contribute to the project:

  1. Fork the Project
  2. Create your Feature Branch (git checkout -b feature/AmazingFeature)
  3. Commit your Changes (git commit -m 'Add some AmazingFeature')
  4. Push to the Branch (git push origin feature/AmazingFeature)
  5. Open a Pull Request

Anything will be greatly appreciated!

Contact

Kyle Petersen - Linked-In - [email protected]

Project Link: https://github.com/kpete2017/DnDungeonMaster

Acknowledgements

About

No description, website, or topics provided.

Resources

Stars

Watchers

Forks

Releases

No releases published

Packages

No packages published

Languages