RyokanApp

Immersive, local-first AI Roleplay Engine. Built with Rust, Tauri v2, and Svelte.

Core Features

• Director Mode: Step outside the story at any time to guide the narrative or the AI without breaking immersion. No clunky OOC brackets needed.
• Clean UI: A modern, distraction-free interface, fully migrated to Svelte 5 Runes for top performance.
• Ready-to-Play Content: Includes pre-installed, multi-lingual standard characters bundled with matching World Info. They automatically adapt to your chosen language (EN/DE), allowing you to jump straight into a story without any setup.
• Simplified Settings: Control AI behavior (Creativity, Length, Repetition) via simple presets. A Power User toggle is available for those who still want raw slider controls.
• BYOK & Local Models: Connect seamlessly to LM Studio, llama.cpp, or any OpenAI-compatible endpoint for local models, or enter your OpenRouter API key for cloud generation.
• V3 Character Support: Full character card import/export, including alternate greetings, personality traits, scenarios, and example dialogs.
• Lorebooks & World Info: Full support for world-building entries with keyword triggers and position control, injected automatically into the context.
• Persona System: Define exactly who you are in the story (name, pronouns, background).
• Edit & Retry: Easily edit any previous message and regenerate the response from that specific point.
• Local Privacy First: All chats, characters, and settings are stored locally via SQLite. Nothing leaves your machine.
• Native Bilingual: Full, consistent English and German support from day one.

The Vision

The current landscape of AI roleplay frontends is often cluttered with hundreds of technical sliders, terminal-like interfaces, and overwhelming settings. RyokanApp takes a different approach: Atmosphere and Immersion.

Designed to be a clean, distraction-free chat experience, it strips away the complexity so you can focus entirely on the story and the characters. Driven entirely by your local LLM or any compatible API, Ryokan is built for those who want plug-and-play roleplay without sacrificing powerful features under the hood.

Tech Stack

Getting Started

Prerequisites

• Node.js (v18+)
• Rust (latest stable)
• A local OpenAI-compatible server (for example LM Studio on 1234 or llama.cpp on 8080) or a valid OpenRouter API key.

Installation

1. Clone the repository

   git clone https://github.com/Finn-Hecker/RyokanApp.git
   cd RyokanApp
   

2. Install dependencies

   npm install
   

3. Run in development mode

   npm run tauri dev
   

Contributing

Contributions are welcome! Please open an issue before submitting a Pull Request to discuss major changes.

License

This project is licensed under the GNU General Public License v3.0, see the LICENSE file for details.