Skip to content

llamojha/dnd-npc-generator

Repository files navigation

DnD NPC Generator

This is a simple web application that generates randomized NPC (Non-Player Character) names, images and descriptions for Dungeons and Dragons (DnD) games.

Getting Started

These instructions will get you a copy of the project up and running on your local machine for development and testing purposes.

Prerequisites

To run this project, you will need to have Node.js and npm installed on your machine.

Installing

  1. Clone the repository to your local machine using Git: git clone https://github.com/llamojha/dnd-npc-generator.git

  2. Install the dependencies using npm:

cd dnd-npc-generator
npm install
  1. Create a .env file in the root of your project directory and add the following environment variable:

REACT_APP_OPENAI_API_KEY=your_openai_api_key_here

  1. Run the project using the start script:

npm start

The project should now be running on http://localhost:3000/.

Built With

  • React - A JavaScript library for building user interfaces
  • Create React App - A tool for creating React apps with no build configuration
  • OpenAI API - An artificial intelligence platform that provides APIs for natural language processing tasks

License

This project is licensed under the MIT License - see the LICENSE file for details.

Acknowledgments

  • The NPC names and descriptions are generated using the OpenAI API.
  • This project was inspired by NPC Generator, a web application for generating randomized NPCs.

About

No description, website, or topics provided.

Resources

License

Stars

Watchers

Forks

Releases

No releases published

Packages

No packages published