Skip to main content

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

  1. 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

Metadata

Release files for ai-storyteller-cli 0.3.0

For a detailed explanation of source distributions (sdists) and built distributions (wheels), please see the package formats documentation.

Source distribution (sdist)

Source distribution for ai-storyteller-cli 0.3.0
File Size Uploaded
ai_storyteller_cli-0.3.0.tar.gz 32.1 kB Details

Built distribution (wheel)

Table of built distributions (wheels) for ai-storyteller-cli 0.3.0
File Interpreter ABI Platform
ai_storyteller_cli-0.3.0-py3-none-any.whl Python 3 none any Details

Total release size: 51.9 kB

Release files / ai_storyteller_cli-0.3.0.tar.gz

Download URL ai_storyteller_cli-0.3.0.tar.gz
Size 32.1 kB
Tags Source
SHA-256 checksum
How to use checksums
841ba91d6f81d088f77c663433912c2cfdd61cdaf52f0a8d9fdd49231023d967
BLAKE2b-256 checksum
How to use checksums
44a20b47b1b0d7c603586af5d0d3b7517d74c9690a958b4fa33ed5837a591a5f
Upload date
Uploaded using Trusted Publishing?
What is trusted publishing?
No
Uploaded via twine/6.2.0 CPython/3.11.2

Release files / ai_storyteller_cli-0.3.0-py3-none-any.whl

Download URL ai_storyteller_cli-0.3.0-py3-none-any.whl
Size 19.8 kB
Tags Python 3
SHA-256 checksum
How to use checksums
9b9f2f7afc7d46988c46e0f7dd6ca5838e8f681290490fc2a5f323c4fb84f78d
BLAKE2b-256 checksum
How to use checksums
14bdd0bd1908b902b44aa1772c78a68b6e33bc7cc70edd1ce22423f4f7f67713
Upload date
Uploaded using Trusted Publishing?
What is trusted publishing?
No
Uploaded via twine/6.2.0 CPython/3.11.2

Release history Release notifications | RSS feed

This release

0.3.0 This release

2 release files

0.2.0

2 release files

0.1.0

2 release files

Anthropic, PBC Visionary sponsor Bloomberg Visionary sponsor Hudson River Trading Visionary sponsor Meta Visionary sponsor NVIDIA Visionary sponsor Microsoft Sustainability sponsor Depot Continuous Integration AWS Cloud computing and Security Sponsor Datadog Monitoring Fastly CDN Google Download Analytics Sentry Error logging StatusPage Status page