D&D Companion App

Welcome to the D&D Companion App! This application is designed to assist Dungeons & Dragons (D&D) players in their tabletop adventures by providing a variety of features and functionalities. Whether you're a Dungeon Master (DM) or a player, this app aims to enhance your gaming experience.

Features

• Character Sheet: Create and manage your D&D characters with an interactive character sheet. Track attributes, skills, equipment, and more.
• Dice Roller: Roll dice for various actions in the game, including attacks, saving throws, skill checks, and damage rolls.
• Spellbook: Access a comprehensive spell database, search for spells, and keep track of your character's known spells.
• Monster Database: Look up details about monsters, including their stats, abilities, and lore, to aid in encounters and world-building.
• Encounter Manager: Create and manage encounters, track initiative order, and keep notes during combat.
• Campaign Tracker: Keep track of your ongoing campaigns, including session summaries, NPC details, and plot points.
• ChatGPT Integration: Utilize the power of ChatGPT API to generate interactive and engaging conversations with AI-powered NPCs or to seek assistance with rules and game mechanics.

Technologies Used

The D&D Companion App is built using the following technologies:

• React: A popular JavaScript library for building user interfaces.
• ChatGPT API: An API that provides natural language processing capabilities, allowing for interactive conversations with AI.
• dnd5eapi An open auth API that allows get requests to aggregated data.
• Other libraries and tools: Various other libraries and tools are used to enhance the app's functionality and user experience, such as Redux for state management, React Router for navigation, and Axios for API communication.

Getting Started

To set up the D&D Companion App locally on your machine, follow these steps:

1. Clone the repository: git clone https://github.com/your-username/dnd-companion-app.git
2. Navigate to the project directory: cd dnd-companion-app
3. Install the dependencies: npm install
4. Create a .env file in the root directory and add your ChatGPT API key: REACT_APP_CHATGPT_API_KEY=your-api-key
5. Start the development server: npm start
6. Open your browser and visit http://localhost:3000 to access the app.

Usage

Once you have the D&D Companion App running, you can explore the different features and functionalities to enhance your D&D gaming experience. Here are a few usage guidelines:

• Character Sheet: Click on the "Character Sheet" option in the navigation bar to create and manage your D&D characters. Fill in the necessary details, such as ability scores, skills, equipment, and more.
• Dice Roller: Use the "Dice Roller" feature to roll dice for various actions during the game. Specify the type and number of dice to roll and see the results instantly.
• Spellbook: Access the "Spellbook" to search for spells and keep track of your character's known spells. Browse through the spell database to find detailed information about each spell.
• Monster Database: Look up details about monsters by accessing the "Monster Database." Search for specific monsters, view their stats and abilities, and utilize the information during encounters.
• Encounter Manager: Create and manage encounters with the "Encounter Manager" feature. Keep track of initiative order, add notes, and manage combat-related information during gameplay.
• Campaign Tracker: Use the "Campaign Tracker" to keep track of ongoing campaigns. Add session summaries, track NPC details, and document plot points to assist with campaign management.
• ChatGPT Integration: Make use of the integrated ChatGPT API to have interactive conversations with AI-powered NPCs or to seek assistance with rules and game mechanics. Engage in dynamic dialogues within the app.

Contributing

Contributions to the D&D Companion App are welcome! If you have any suggestions, bug reports, or feature requests, please open an issue on the GitHub repository. If you would like to contribute code, feel free to open a pull request following the project's contribution guidelines.

License

This project is licensed under the MIT License.

Acknowledgements

• The D&D Companion App utilizes the ChatGPT API for generating interactive conversations with AI.
• The spell data and monster information used in the app are sourced from official D&D publications and community-driven open resources including dnd5eAPI

Contact

If you have any questions, suggestions, or feedback related to the D&D Companion App, you can reach out to the project maintainer at tyjamesramblings@gmail.com.

Happy adventuring!