SillyTavern-MemoryBooks  by aikohanasaki

AI-powered memory and lorebook management for chat applications

Created 1 year ago
262 stars

Top 96.9% on SourcePulse

GitHubView on GitHub
Project Summary

This extension addresses the need for structured, automated memory management within SillyTavern, enabling users to preserve and recall chat history effectively. It targets SillyTavern users seeking enhanced narrative continuity and organized character/world state tracking, offering benefits like reduced token usage through AI-driven summarization and compaction.

How It Works

The core mechanism involves users marking chat message ranges as "scenes." An AI then processes these scenes to generate structured JSON memories, which can be saved as lorebook entries. It supports distinct memory types: "Clips" for single facts, "Side Prompts" for dynamic trackers (e.g., inventory, relationships), and multi-tier "Consolidation" (Arc, Chapter, Book) to create high-level narrative recaps. Additionally, "Compaction" allows for shortening existing entries to improve token efficiency.

Quick Start & Requirements

  • Primary Install: Load SillyTavern and install the extension via its interface.
  • Prerequisites: SillyTavern 1.14.0+ (latest recommended). Requires a chat completion API (OpenAI, Claude, Anthropic, OpenRouter, etc.). Text completion APIs require an OpenAI-compatible endpoint. Optional integration with Chat Top Bar / Chat Top Info Bar for a job queue.
  • Links: Quickstart Video, User Guide, FAQ, Troubleshooting.

Highlighted Details

  • Memory Types: Scene Memories, Summary Consolidation (Arc, Chapter, Book, etc.), Clips (single facts), Side Prompts (ongoing trackers).
  • Lorebook Integration: Automatic entry creation with configurable numbering and ordering. Supports manual, automatic, and auto-create lorebook modes.
  • Advanced Features: Compaction for token efficiency, Topical Clip for focused summaries, Regex integration for text processing, and customizable title formatting.
  • Group Chat Support: Fully compatible with group chats without special setup.

Maintenance & Community

No specific details on maintainers, sponsorships, or community channels (like Discord/Slack) were found in the provided README text.

Licensing & Compatibility

The provided README text does not explicitly state a software license. Compatibility for commercial use or closed-source linking is undetermined without a license.

Limitations & Caveats

Text completion API usage necessitates a chat completion preset. If Memory Books is the sole lorebook, the 'Delay until recursion' setting must be disabled to ensure proper activation. Existing lorebook entries require conversion using the provided tool. AI generation relies on models capable of producing valid JSON output. The absence of a stated license may pose adoption risks.

Health Check
Last Commit

1 week ago

Responsiveness

Inactive

Pull Requests (30d)
0
Issues (30d)
0
Star History
0 stars in the last 30 days

Explore Similar Projects

Feedback? Help us improve.