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.

πŸ€– AI Provider

Configure your AI model in Settings β†’ AI 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 β†’ Character 🎭. 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.

πŸ–Ό Image Generation

Ask the character to draw something in plain words β€” β€œdraw a cozy cafe at sunset” β€” and the picture appears right in the chat 🎨. The character picks the composition; you can also use the exact command: /image your prompt and optionally end it with portrait, landscape or square for the aspect ratio. Click any image to open it full size. Keep requests SFW β€” anything more gets a polite refusal.

πŸ–ΌοΈ Backgrounds

Generate custom backgrounds 🎨 from prompts or the current chat context in Settings β†’ Background πŸ–ΌοΈ. 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 β†’ Radio πŸ“». 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!

🧩 AI Context & Interface

In AI Context 🧩, 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 🧠. Chatbox and bubble opacities 🎨 are under Interface πŸ–₯️.

🐞 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
πŸ’‘ Ask for a drawing in plain words, or use /image with an optional portrait / landscape / square flag
β€’ Check the Links πŸ”— section for more from Waifu AI!

πŸ€–πŸš€ LLM & OpenRouter Settings

Configure your AI model in Settings β†’ AI 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.

πŸ–ΌοΈ Image Generation

Beyond text and voice, the character can draw. Just ask naturally β€” β€œcan you draw a rainy neon city?” β€” and the image appears in the chat, captioned in character. The character chooses the composition (portrait, landscape or square) from your request. Power users can use the exact command instead: /image your prompt here, optionally ending with portrait, landscape or square. Prompts must stay safe-for-work; refused prompts get a friendly in-character answer. Click any picture to view it full size β€” images you generated stay saved in your chat history.

πŸ”ŒπŸ”‹ Context

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 the connection drops, a brief error message is shown and replies resume once you are back online.

🐞🧰 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.