README.md

GPT-Dungeon-Master

Table of Contents

1. GPT-Dungeon-Master
2. Introduction
3. Planed Features
4. Usage
5. Installation
   • Prerequisites
   • Setup
6. Tests
7. License
8. Roadmap

Introduction

Welcome to the GPT Dungeon Master repository! This project harnesses the power of GPT models to create a dynamic and responsive Dungeon Master (DM) for tabletop role-playing games (RPGs). Whether you're a seasoned player looking for a quick rule reference or a group in need of an AI-driven DM for your next adventure, the GPT Dungeon Master is here to guide you.

Planned Features

Knowledgebase Integration: Access a vast digital library of RPG rulebooks. Get instant answers to rule queries, character abilities, and more.

Dynamic Storytelling: Let the GPT model craft intricate narratives, describe vivid settings, and generate unexpected plot twists.

Character Interaction: Interact with the GPT DM through your character. Ask questions, make requests, and engage in dialogue.

Text-to-Speech: Listen to the GPT DM through a text-to-speech engine. Hear the DM's narration, character voices, and more. The voices will be different based on the character.

Speech-to-Text: Speak to the GPT DM through a speech-to-text engine. Ask questions, make requests, and engage in dialogue.

Generative Art: Experience the GPT DM's imagination through generative art. See the DM's descriptions come to life in real-time.

Rule Enforcement: Ensure your gameplay adheres to the rules. The system checks player actions against the rulebook, ensuring a fair and consistent gaming experience.

Interactive UI: Engage with the GPT DM through a user-friendly interface. Input actions, ask questions, and immerse yourself in the game.

Usage

The GPT Dungeon Master is currently in development. Check back later for updates.

python main.py

Installation

To install the GPT Dungeon Master, one needs to have all the prerequisites installed and set up, and follow the setup guild. The following sections will guide you through the process.

Prerequisites

• Python 3.6 or higher
• OpenAI API key (https://platform.openai.com/account/api-keys)

Setup

1. Clone the repository

git clone https://github.com/SverreNystad/gpt-dungeon-master.git
cd gpt-dungeon-master

2. Create a virtual environment

   On Windows:

   python3 -m venv venv
   source venv/Scripts/activate

   On macOS and Linux:

   python3 -m venv venv
   source venv/bin/activate

3. Install the required packages

pip install -r requirements.txt

4. Create a file called .env in the root directory of the project. Add the following lines to the file:

touch .env
echo "OPENAI_API_KEY=YOUR_API_KEY" > .env # Remember to change YOUR_API_KEY to your actual API key

Tests

To run all the tests, run the following command in the root directory of the project:

pytest --cov
coverage html # To generate a coverage report

If you do not want to run api tests, run the following command instead:

pytest -m "not apitest" --cov

License

The license is not yet decided. Check back later for updates.

Roadmap (work in progress)

Phase 1 Preliminary Setup

Create a repository structure, and set up initial project documentation, survey the best tools for text-to-speech, speech-to-text, the GPT model and generative art.

Phase 2 Create tools

Implement most of the planned features, creating a TTS and creating a generative image module, create a text generation module.

Phase 3 Core Functionality and polishing

Create the core out of combate functionality like Character interaction and dynamic storytelling. Integrate the different modules.

Phase 4 Interactive UI

Creating a user friendly UI to make the project easier to use without deep knolegde of the project. Work on QOL tools like SST engines module or similar tools.

Phase 5 Official Release and Future Work

• Launch the official version of the GPT Dungeon Master.
• Explore the possibility of introducing combat aspects and other advanced features into the system.