Documentation
Everything you need to run your vessel.
Guides, setup walkthroughs, and a look under the hood. Search the docs or jump straight to a section below.
Ctrl K
Get started
Web
No installation required. Runs entirely in your browser, on desktop and mobile.
Desktop
Desktop app with transparent overlay mode for macOS, Windows, and Linux.
Browse the docs
Guides
- Web Guide A tour of Utsuwa in the browser, from first setup to the main screen, voice, photos, photo mode, AR, reminders, memory, and backups.
- Desktop Guide Install the Utsuwa desktop app on macOS, Windows, or Linux, keep it updated, and use the transparent overlay and global hotkeys.
- Settings Reference Every settings page in Utsuwa, section by section, with what each control does and its default.
- Voice Providers Set up her voice with ElevenLabs, OpenAI TTS, Fish Audio, or a local engine, and set up voice input with a local server, Groq, OpenAI, or the browser.
- Animations Upload your own VRMA motions, describe them so she can use them in chat, and choose her idle and thinking motions.
- Expressions and Moments How her face follows her mood, how she reacts with a brief expression, how event moments are written for you, and what your VRM model needs for them.
- Scene and Photo Mode Frame the camera, change or upload a background, tune hair and clothing physics, take photos in photo mode, and use touch and AR.
- Memory What she remembers and how, the Memory settings page, semantic search, correcting and deleting memories, backups, and exactly what Clear All Data removes.
- Local LLM Setup How to set up and connect local LLMs to Utsuwa using Ollama or LM Studio.
- Local TTS Setup Give your companion a voice that runs entirely on your machine using Kokoro-FastAPI or openedai-speech.
- OmniVoice Setup Run the OmniVoice text-to-speech model locally for a fully offline, multi-language voice.
- Local STT Setup Run speech-to-text entirely on your machine with an OpenAI-compatible Whisper server (Speaches, faster-whisper-server, whisper.cpp).
- MCP Servers Give your companion external tools through the Model Context Protocol: Home Assistant, Brave Search, GitHub, and more.
- Troubleshooting Fixes for common problems with setup, API keys, avatars, voice, animations, expressions, the desktop app, and memory.