Skip to content

AlexMercedCoder/ai-storyteller

Repository files navigation

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

About

An AI Agent or MCP server that can be used either as a dungeon master or as a dungeon master assistance with any ruleset or setting you provide.

Resources

Stars

Watchers

Forks

Releases

No releases published

Packages

 
 
 

Contributors

Languages