Help & Tutorial

A guided walkthrough of the main features, settings, and troubleshooting tools in Waifu Companion.

๐Ÿ‘‹ Welcome

This app pairs a Live2D character ๐ŸŽญ with a chat ๐Ÿ—จ๏ธ powered by an AI model ๐Ÿค–. You can move ๐Ÿ–ฑ๏ธ and zoom ๐Ÿ” the character, chat ๐Ÿ’ฌ, and even listen to radio ๐ŸŽถ while using TTS ๐Ÿ”Š.

๐Ÿ’ฌ Chat & AI

Type your message โŒจ๏ธ and press Enter โ†ฉ๏ธ. The AI processes your input and responds with text, emotion, and gestures ๐ŸŽญ. Your conversation history is saved locally ๐Ÿ’พ. Use Reset Chat ๐Ÿ—‘๏ธ to clear it and start fresh.

๐Ÿค– LLM Provider

Configure your AI model in Settings โ†’ LLM Provider. You can use OpenRouter or Groq - both support free models. Provide your API key ๐Ÿ”‘ and a model name. They support Streaming โšก for real-time replies!

๐Ÿง  Persona & Memory

Customize your AI's identity ๐Ÿ†” and personality ๐ŸŽญ in Persona Settings. The AI has Long-Term Memory ๐Ÿงต: it remembers the last few dozen messages and automatically creates a Conversation Summary ๐Ÿ“ to retain important facts even after they leave immediate memory.

๐Ÿงฉ Live2D Models

Switch characters in Settings โ†’ Model Settings ๐Ÿงฉ. You can pick from built-in models or add your own via a .model3.json URL ๐Ÿ”—. The AI can trigger Emotions (Happy, Sad, Surprised, etc.) and Gestures (Nod, Shake Head) automatically during chat โœจ.

๐Ÿ”Š Voice (TTS)

Enable Voice ๐Ÿ”ˆ to hear the AI. You can choose a different voice ๐ŸŽ™๏ธ for each response language. TikTok TTS offers high-quality voices for many languages ๐ŸŒŽ. Adjust volume ๐Ÿ”‰ and chunk limits in Voice Settings.

๐Ÿ–ผ๏ธ Backgrounds

Generate custom backgrounds ๐ŸŽจ from prompts or the current chat context in Settings โ†’ Background Image ๐Ÿ–ผ๏ธ. Manage your collection in the Background Library ๐Ÿ“š, use the fullscreen viewer ๐Ÿ–ฅ๏ธ, and choose how the image fits your screen (Contain, Cover, etc.).

๐Ÿ“ป Audio & Radio

Listen to an anime radio stream ๐ŸŽถ while you chat. Controls are in Settings โ†’ Audio Settings ๐ŸŽง. Volume is saved automatically ๐Ÿ’พ. Click the play button โ–ถ๏ธ to start the music!

๐ŸŽ™๏ธ Voice Input (STT)

Click the Microphone ๐ŸŽค icon in the chatbox to talk instead of typing. It uses your browser's speech recognition โœ๏ธ. Make sure to allow microphone permissions in your browser ๐Ÿ”.

๐ŸŒ Languages & UI

Set the AI's response language ๐Ÿ—ฃ๏ธ and optionally show Transliteration ๐Ÿ”ค (Romaji/Romanization) for Japanese or Korean. You can also enable UI Translation ๐Ÿˆฏ to have the AI translate the entire app interface for you!

โš™๏ธ Preferences & Context

In Preferences โš™๏ธ, you can choose to include the current Time โฑ๏ธ and Battery ๐Ÿ”‹ level in the AI's context so it can make comments about your day or device status ๐Ÿง . You can also adjust chatbox and bubble opacities ๐ŸŽจ.

๐Ÿ”Œ Offline Mode

If the AI connection fails or you're offline, the app switches to a Local Fallback Engine ๐Ÿ”Œ. It uses basic heuristics to keep the conversation going until you're back online ๐ŸŒ. You can also force Offline Mode in Debug Settings.

๐Ÿž Debug Panel

Troubleshoot issues with the Debug Panel ๐Ÿงฐ. See real-time logs ๐Ÿ“‹ for AI calls, model loading, and system events. You can even see the full context ๐Ÿ“„ being sent to the AI to understand how it thinks.

๐Ÿ–ฑ๏ธ Drag & Resize

The Chat window is fully flexible! Drag it by the header ๐ŸชŸ and resize from the edges โ†”๏ธโ†•๏ธ. Your layout is saved ๐Ÿ’พ so it stays consistent between visits.

๐Ÿ’ก Pro Tips

โ€ข Click/Tap the character to interact ๐Ÿ–ฑ๏ธ
โ€ข Use mouse wheel to zoom ๐ŸŒ€
โ€ข Drag the character to reposition ๐Ÿ“
โ€ข Enable 'Always show Settings' ๐Ÿช„ if you tweak often
โ€ข Check the Links ๐Ÿ”— section for more from Waifu AI!

๐Ÿค–๐Ÿš€ LLM & OpenRouter Settings

Configure your AI model in Settings โ†’ LLM Provider. You can use OpenRouter or Groq - both support free models. You'll need an API key from openrouter.ai or console.groq.com. Both support Streaming โšก for real-time character-by-character responses.

๐Ÿง ๐Ÿงต Persona, Memory & Summarization

Your AI isn't just a generic bot; you can define its Core Identity and Custom Personality in Persona Settings. Whether you want a helpful assistant or a specific character archetype, the AI will adapt its tone and behavior. To handle long conversations, the app uses a Memory System. As older messages are pushed out of immediate memory to save performance, the AI automatically generates a Conversation Summary ๐Ÿ“. This summary is fed back into the AI's context, ensuring it never truly "forgets" important events or your name.

๐ŸŽญโœจ Live2D Animations & Expressions

The Live2D models aren't just static images. They feature Automatic Gaze ๐Ÿ‘๏ธ (following your interactions), breathing animations, and physics-based hair/clothing movement. When chatting, the AI can trigger specific Emotions (Happy, Sad, Surprised, Thoughtful, Excited) and Gestures (like nodding or tilting its head) based on the sentiment of its reply. You can also add your own models by providing a URL to a .model3.json file.

๐Ÿ”Š๐ŸŽค TTS & Voice Interaction

Text-to-Speech (TTS) is powered by TikTok's free TTS API, offering a variety of natural-sounding voices across many languages. You can select a unique voice for each language you use. For input, use the Microphone ๐ŸŽค icon to speak directly to your character. This uses your browser's native Speech-To-Text capabilities. Note: For the best experience, use a Chromium-based browser and ensure you've granted microphone permissions.

๐Ÿ”Œ๐Ÿ”‹ Context & Offline Fallback

The AI can be made "aware" of your environment. By enabling Time and Battery context, the AI will know if it's late at night or if your device is running low on power, leading to more natural observations. If you lose your internet connection, the Local Fallback Engine ๐Ÿ”Œ takes over, using smart heuristics to provide relevant (though less "intelligent") replies until the connection is restored.

๐Ÿž๐Ÿงฐ Debug Panel & Troubleshooting

If something isn't working as expected, the Debug Panel is your best friend. It logs everything from network requests to model loading errors. You can even enable Show Chat Context to see exactly what "thoughts" and instructions are being sent to the AI behind the scenes. If audio doesn't play, remember that most browsers require at least one manual click ๐Ÿ–ฑ๏ธ on the page before they allow automatic sound playback.