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: ```bash pip install ai-storyteller-cli
OR for RAG support:
pip install "ai-storyteller-cli[rag]"
2. **Configure**: Create `.env` with API keys.
3. **Init**: `storyteller init`
4. **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
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.3.0.tar.gz.
File metadata
- Download URL: ai_storyteller_cli-0.3.0.tar.gz
- Upload date:
- Size: 32.1 kB
- Tags: Source
- Uploaded using Trusted Publishing? No
- Uploaded via: twine/6.2.0 CPython/3.11.2
File hashes
| Algorithm | Hash digest | |
|---|---|---|
| SHA256 |
841ba91d6f81d088f77c663433912c2cfdd61cdaf52f0a8d9fdd49231023d967
|
|
| MD5 |
50f0ac168846902a66b8aa2eb954833e
|
|
| BLAKE2b-256 |
44a20b47b1b0d7c603586af5d0d3b7517d74c9690a958b4fa33ed5837a591a5f
|
File details
Details for the file ai_storyteller_cli-0.3.0-py3-none-any.whl.
File metadata
- Download URL: ai_storyteller_cli-0.3.0-py3-none-any.whl
- Upload date:
- Size: 19.8 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 |
9b9f2f7afc7d46988c46e0f7dd6ca5838e8f681290490fc2a5f323c4fb84f78d
|
|
| MD5 |
502bc7ab583639fc1d6a71eb39ab4289
|
|
| BLAKE2b-256 |
14bdd0bd1908b902b44aa1772c78a68b6e33bc7cc70edd1ce22423f4f7f67713
|