AI Storyteller and DM Assistant
Project description
AI Storyteller
Your AI-Powered Dungeon Master Assistant
Storyteller is a CLI-based application that uses Large Language Models (LLMs) to run tabletop roleplaying games. It manages lore, tracks story state, and acts as an immersive Dungeon Master.
Features
- Multi-Provider AI: Support for OpenAI, Anthropic, and Gemini.
- Lore Management: Local Markdown-based lore system with smart retrieval.
- Persistence: SQLite database for saving stories, characters, and events.
- MCP Support:
- Server: Expose Storyteller tools to Claude Desktop.
- Client: Connect Storyteller to external tools (Web Search, etc.).
Documentation Index
| Topic | Description |
|---|---|
| Setup Guide | Installation, API keys, and initialization. |
| PyPI Installation | Installing and using from PyPI. |
| GitHub & Template Guide | Cloning, setup, and creating custom distributions. |
| Database Guide | Understanding the schema and managing save files. |
| RAG & Vector Search | How the AI remembers lore using vector embeddings. |
| Procedural Tools | Generating dungeons and loot. |
| Export & Sharing | Exporting stories and packing lore. |
| Plugin System | Extending Storyteller with Python scripts. |
| Textual TUI | Using the rich terminal interface. |
| Publishing Guide | Packaging and distributing the library. |
| Quick Start | Basic usage instructions. |
| Chat Interface | Deep dive into how to play and interact. |
| CLI Reference | Complete command list (start, serve, dm-assist). |
| Lore Guide | How to write and organize your world's lore. |
| MCP Integration | Configuring MCP Server and Client modes. |
| Best Practices | Tips for better prompting and game management. |
| Architecture | System design and component overview. |
Quick Start
- Install:
pip install . - Configure: Create
.envwith API keys. - Init:
storyteller init - Play:
storyteller start
License
MIT
Project details
Release history Release notifications | RSS feed
Download files
Download the file for your platform. If you're not sure which to choose, learn more about installing packages.
Source Distribution
ai_storyteller_cli-0.2.0.tar.gz
(32.0 kB
view details)
Built Distribution
Filter files by name, interpreter, ABI, and platform.
If you're not sure about the file name format, learn more about wheel file names.
Copy a direct link to the current filters
File details
Details for the file ai_storyteller_cli-0.2.0.tar.gz.
File metadata
- Download URL: ai_storyteller_cli-0.2.0.tar.gz
- Upload date:
- Size: 32.0 kB
- Tags: Source
- Uploaded using Trusted Publishing? No
- Uploaded via: twine/6.2.0 CPython/3.11.2
File hashes
| Algorithm | Hash digest | |
|---|---|---|
| SHA256 |
71c82573e1f3897722f7f70e78618a1a821c0f102426db601d976c6c961fbc16
|
|
| MD5 |
2829efa25d791038c67a81b633f7b5e2
|
|
| BLAKE2b-256 |
547bf402859f712d0781be61d5b1fb5725c340ac445baba79f0c03fd98edb1dc
|
File details
Details for the file ai_storyteller_cli-0.2.0-py3-none-any.whl.
File metadata
- Download URL: ai_storyteller_cli-0.2.0-py3-none-any.whl
- Upload date:
- Size: 19.7 kB
- Tags: Python 3
- Uploaded using Trusted Publishing? No
- Uploaded via: twine/6.2.0 CPython/3.11.2
File hashes
| Algorithm | Hash digest | |
|---|---|---|
| SHA256 |
22e723bba04ce59112193817c62a29b6a46ca6f5e1d78b464cb9fc563f4fd78f
|
|
| MD5 |
8b36823e7d209507bfa34d29eae11a09
|
|
| BLAKE2b-256 |
8ec2edcf87471303dfdf9aba5a84f55e2a3151cbdf5820b9702d14cf032d2924
|