Ecosyste.ms: Awesome
An open API service indexing awesome lists of open source software.
https://github.com/ironman5366/ai-murder-mystery-hackathon
The game is afoot
https://github.com/ironman5366/ai-murder-mystery-hackathon
Last synced: about 2 hours ago
JSON representation
The game is afoot
- Host: GitHub
- URL: https://github.com/ironman5366/ai-murder-mystery-hackathon
- Owner: ironman5366
- License: mit
- Created: 2024-03-24T16:34:11.000Z (9 months ago)
- Default Branch: main
- Last Pushed: 2024-07-25T16:42:11.000Z (5 months ago)
- Last Synced: 2024-12-18T04:03:56.507Z (7 days ago)
- Language: TypeScript
- Homepage: https://ai-murder-mystery.onrender.com
- Size: 17.8 MB
- Stars: 228
- Watchers: 2
- Forks: 32
- Open Issues: 2
-
Metadata Files:
- Readme: README.md
- License: LICENSE.txt
Awesome Lists containing this project
README
# AI Alibis: Multi-Agent LLM Murder Mystery
**[Play online](https://ai-murder-mystery.onrender.com)**
## Setup
1. Git clone the repo
```
git clone https://github.com/ironman5366/ai-murder-mystery-hackathon.git
cd ai-murder-mystery-hackathon
```
2. Add your Anthropic API to api/.env file (optionally can export conversations to postgres with DB_CONN_URL="postgresql://link_to_db_conn")
```
nano api/.env
export ANTHROPIC_API_KEY="YOUR_API_KEY_HERE"
( to save changes and exit nano)
```
3. Install Node dependencies
```
web/npm i
```
3. Start up the api
```
bash api_start.sh
```
4. In separate terminal, start up the web interface
```
bash web_start.sh
```
5. Play the game!
## Setup (with Docker)
1. Git clone the repo
```
git clone https://github.com/ironman5366/ai-murder-mystery-hackathon.git
cd ai-murder-mystery-hackathon
```
2. Set environment variables:
```
export ANTHROPIC_API_KEY="YOUR_API_KEY_HERE"
```
3. Open a terminal in the folder containing this README, then run:
```
docker compose up
```
This should start three containers (the database, Python API, and React frontend) and create a persistent volume for the database.
4. Play the game at http://localhost:3000/
If you change any files (for example, changing the Anthropic model in `/api/settings.py`), then you will likely need to rebuild the images:
```
docker compose up --build
```
5. To shut everything down, hit `CTRL-C` or click the stop button in the Docker GUI.
To clean up, use the Docker GUI to delete all containers then go to the "Volumes" tab to delete the associated database volume.
## Additional info
You can read the full murder story by checking out [web/src/characters.json](https://github.com/ironman5366/ai-murder-mystery-hackathon/blob/main/web/src/characters.json), which contains the full context provided to each character.
To see how our prompting system works, including our critique and revision approach, check out [api/ai.py](https://github.com/ironman5366/ai-murder-mystery-hackathon/blob/main/api/ai.py).
Twitter thread on the game: https://x.com/humanscotti/status/1810777932568399933
## Contact
AI Alibis was created by [Paul Scotti](https://paulscotti.github.io/) and [Will Beddow](https://www.willbeddow.com/).