Ecosyste.ms: Awesome
An open API service indexing awesome lists of open source software.
https://github.com/Tom-A-Roberts/LangQuest
Using LangChain, GPT-3.5, Chain of thought reasoning to create a Dungeons and Dragons type experience. Complete with hitpoints, inventory, storyline, immersive image generation, and more
https://github.com/Tom-A-Roberts/LangQuest
Last synced: 11 days ago
JSON representation
Using LangChain, GPT-3.5, Chain of thought reasoning to create a Dungeons and Dragons type experience. Complete with hitpoints, inventory, storyline, immersive image generation, and more
- Host: GitHub
- URL: https://github.com/Tom-A-Roberts/LangQuest
- Owner: Tom-A-Roberts
- License: mit
- Created: 2023-05-03T17:04:20.000Z (over 1 year ago)
- Default Branch: main
- Last Pushed: 2023-08-06T20:56:13.000Z (over 1 year ago)
- Last Synced: 2024-08-02T14:11:48.096Z (4 months ago)
- Language: Python
- Size: 1.36 MB
- Stars: 5
- Watchers: 2
- Forks: 0
- Open Issues: 1
-
Metadata Files:
- Readme: README.md
- License: LICENSE
Awesome Lists containing this project
README
# LangQuest
Using LangChain, GPT-3.5, and Chain of Thought reasoning to create a Dungeons and Dragons type experience.
## Technology đģ
LangQuest is written in **Python** đ and uses **Streamlit** for the front end. Streamlit is an open-source framework that provides a quick interactive web app.
## Features đ
Some of the features that make LangQuest unique and fun are:
- **Image generation**: LangQuest uses image generation to enhance the visual aspect of the game. You can see pictures of the places, characters, and items you encounter in your adventure.
- **Hitpoints**: You have a health bar that decreases when you take damage and increases when you heal. If your hitpoints reach zero, you lose the game.
- **Location**: Persistent location, kept track of by the Dungeon Master. You can move around the world and explore different places.
- **Inventory**: You have a backpack that stores the items you find or buy along your journey. You can use them for various purposes, such as healing, attacking, or solving puzzles.
- **Storyline**: You can choose from different scenarios that set the background and the goal of your adventure. Each scenario has multiple endings depending on your choices and actions.
- **Customisable scenario**: You can also create your own scenario by changing the setup. LangQuest will generate a new world for you to explore based on your input.
## Quickstart
1. Get an OpenAI [API Key](https://platform.openai.com/account/api-keys)
2. Clone the repo to somewhere locally.
3. Add a new file in the root called `api.txt`
- This file should be next to `main.py`
- Inside the file, paste your API Key, so the contents of the file looks like
```
sk-aBcDeF***************************************XyZ
```
4. (Optional) Create a virtual environment with `python3 -m venv .venv`
- Linux/MacOS, enter the env with: `source .venv/bin/activate`
- Windows Powershell, enter with: `.venv/Scripts/Activate.ps1`
5. install required packages: `pip install -r requirements-dev.txt`
6. Ensure streamlit installed correctly by running the command below. If this fails, see [Here](https://docs.streamlit.io/library/get-started/installation) for more information.
```
streamlit hello
```
## How to play đšī¸
Run the command:
```
streamlit run main.py
```