Skip to main content

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.
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.
Plugin System Extending Storyteller with custom 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: pip install .
  2. Configure: Create .env with API keys.
  3. Init: storyteller init
  4. Play: storyteller start

License

MIT

Project details


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.1.0.tar.gz (26.8 kB view details)

Uploaded Source

Built Distribution

If you're not sure about the file name format, learn more about wheel file names.

ai_storyteller_cli-0.1.0-py3-none-any.whl (16.7 kB view details)

Uploaded Python 3

File details

Details for the file ai_storyteller_cli-0.1.0.tar.gz.

File metadata

  • Download URL: ai_storyteller_cli-0.1.0.tar.gz
  • Upload date:
  • Size: 26.8 kB
  • Tags: Source
  • Uploaded using Trusted Publishing? No
  • Uploaded via: twine/6.2.0 CPython/3.11.2

File hashes

Hashes for ai_storyteller_cli-0.1.0.tar.gz
Algorithm Hash digest
SHA256 0f55d18357830a162a1f282b3fc25ed5e0f7a59623588c673b50beea3f99fd1a
MD5 62cb42b74ce0c5632b2b37b83e83ef23
BLAKE2b-256 596f0eb528441d3cc4a4520750d0984d0283cd2e5d179005c56fd0f3e6a04b0f

See more details on using hashes here.

File details

Details for the file ai_storyteller_cli-0.1.0-py3-none-any.whl.

File metadata

File hashes

Hashes for ai_storyteller_cli-0.1.0-py3-none-any.whl
Algorithm Hash digest
SHA256 099aa69da7882bef25cb8c011aea9b35666b83c351dcf942b07d0b8bb65d64c2
MD5 3eba20ad9493f77803a0c9da1b618257
BLAKE2b-256 acbd1528ad8349cbcc3a9b60bae9afaaffdbce0b1f29818507a403919c5bc5b6

See more details on using hashes here.

Supported by

AWS Cloud computing and Security Sponsor Datadog Monitoring Depot Continuous Integration Fastly CDN Google Download Analytics Pingdom Monitoring Sentry Error logging StatusPage Status page