MuseAI is a local AI companion and interactive story application designed for immersive character interactions. It enables users to create AI characters and story worlds, engage in persistent chat, embark on text adventures, and experience "book-jumping" narratives, all while ensuring data remains locally stored. This application targets users seeking persistent AI companionship, role-playing experiences, and creative writing assistance, offering a unique blend of interactive storytelling and local data control.

How It Works

MuseAI operates as a local application, allowing users to define "World Books" (world settings) and "Character Cards" (character profiles). These are then utilized by AI models to generate contextually relevant and persistent interactions. The core approach emphasizes local data storage for all user-generated content and conversation history, ensuring privacy and control. Key functionalities include AI companion chat with long-term memory and "bond archives" to track evolving relationships, AI-driven text adventures where the AI acts as a Game Master, and a "book-jumping" mode for users to interact within custom-defined novel worlds. Interactions are routed through user-provided API keys for various AI models, offering flexibility in cost and performance.

Quick Start & Requirements

• Installation: Download the latest installer (.dmg for macOS, .exe for Windows) from the project's Releases page. Windows users may need to temporarily disable certain anti-virus software during installation. macOS users might require running xattr -dr com.apple.quarantine /Applications/MuseAI.app in the terminal post-installation.
• AI Model Configuration: Upon first launch, navigate to the "Settings" page to configure AI models. This involves providing API Keys (supporting OpenAI, Anthropic, and OpenAI-compatible third-party services), API Endpoints (for custom or domestic relay services), and selecting model names. Different models can be assigned to various modules (chat, adventure, etc.) for optimized performance and cost.
• Prerequisites: Requires user-provided API keys for AI services. Standard desktop hardware is sufficient.
• Links: Downloads available via the Releases page.

Highlighted Details

• Local Data Storage: All user data, including articles, references, outlines, character cards, world books, and session data, is stored locally in the ~/Documents/MuseAI/ directory.
• LAN Mobile Access: The desktop application supports access via a mobile browser on the same WiFi network, allowing users to interact with AI companions and story features without installing a separate mobile app.
• Auxiliary Creative Tools: Includes a suite of tools for writers, such as a work management system with a Markdown editor, a reference library, AI-powered outlining (evaluation, generation, reverse outlining), and a "De-AI-ing" module to refine AI-generated text.
• Persistent Character Evolution: Supports detailed character customization and world-building, with memory archiving features that allow AI to automatically update character profiles and relationship dynamics based on interactions.

Maintenance & Community

The provided documentation does not detail specific maintenance schedules, notable contributors, sponsorships, or community channels (e.g., Discord, Slack). It lists several "Friendship Links" to other open-source projects related to AI development.

Licensing & Compatibility

The provided README content does not specify the project's license type or any compatibility notes for commercial use or integration with closed-source projects.

Limitations & Caveats

Functionality is dependent on user-provided API keys for external AI services, which incur costs and are subject to the availability and policies of those providers. Certain Windows anti-virus software may interfere with installation. AI responses can occasionally deviate from character settings due to context limitations or model behavior, potentially requiring configuration adjustments or new session starts. Users are advised to manually back up the local ~/Documents/MuseAI/ directory as there is no automatic cloud synchronization.