D&D Buddy is an application that allows dungeon masters to organize campaigns, encounters, and NPCs to bring their game to the next level. Utilizes ChatGPT to aid description generation for created campaign assets and a handy hook-in to the 5e SRD API. Currently in development.
Explore the docs »
Live Deployment
·
Report Bug
·
Request Feature
Table of Contents
D&D Buddy was designed to alleviate the stress of running a campaign for the average DM. Ever spent 6 hours planning an adventure for your party and they just spend all their time in the tavern and immediately kill the nearest guard after taking one step out of the door? D&D Buddy will help alleviate the frustration by letting AI write the descriptions and conversation points for you. Got a player that won't ever stop arguing about the rules? With the 5e SRD API you can quickly find any rule in the SRD with easy to use navigation to shut them up for at least the next five minutes.
Follow these steps to get your deployment working on a local machine!
To install the dependencies, make sure you're running at least version 18 of Node and version 7.0 of .Net with Entity Framework installed as well.
- Clone the repo
git clone https://github.com/sollambert/dnd-buddy.git
- Install NPM packages
npm install
- Install .Net packages
dotnet restore
- Create your database with postresql
- Update the database with the tables created by entity framework
dotnet ef database update
- Create a .env file in the root directory containing your api key for OpenAI's GPT API
OPENAI_API_KEY=<insert key here> - Run the server
dotnet run
- Run the client
npm start
- Connect to the local site with a web browser at localhost
Under construction
Contributions are what make the open source community such an amazing place to learn, inspire, and create. Any contributions you make are greatly appreciated.
If you have a suggestion that would make this better, please fork the repo and create a pull request. You can also simply open an issue with the tag "enhancement". Don't forget to give the project a star! Thanks again!
- Fork the Project
- Create your Feature Branch (
git checkout -b feature/AmazingFeature) - Commit your Changes (
git commit -m 'Add some AmazingFeature') - Push to the Branch (
git push origin feature/AmazingFeature) - Open a Pull Request
Distributed under the MIT License. See LICENSE.txt for more information.
Solomon Lambert - https://github.com/sollambert
Project Link: Deployment