Quick Start Checklist
Goal: In five minutes you will greet your AI companion on the desktop and invite it to a Discord server.
| Step | What You Do | Why It Matters |
|---|---|---|
| 1 | Install the Desktop App • Download the latest release for macOS/Windows/Linux • Drag it into Applications (macOS) or run the installer (Windows) | The app bundles everything—no separate servers or terminals needed. |
| 2 | Launch & Grant Mic Access The first launch asks for microphone permission—click Allow. | AIRI listens only when you speak; local voice detection keeps audio private. |
| 3 | Onboarding Wizard • Choose an AI provider (OpenAI, Ollama, or local GGUF model) • Paste your API key or select the local model file | The AI brain needs a language model. You can switch later in Settings → Providers. |
| 4 | Pick an Avatar Select a built-in Live2D model or drop a .vrm/.zip file. | Visual identity makes the character feel alive. |
| 5 | Say “Hello” Speak or type into the chat window. AIRI responds with voice and expression. | Confirms your mic, LLM, and TTS are working. |
| 6 | Invite to Discord 1. Go to Integrations → Discord. 2. Click Generate Bot Token (or paste an existing one). 3. Follow the OAuth link to add the bot to your server. 4. In a voice channel, type /summon. | AIRI now joins your community conversations—hands-free. |
Done! You now have a personalized AI friend on your desktop and Discord. Continue exploring Settings to tweak personality, colours, or global shortcuts.
Need More Detail?
- Troubleshooting Mic Access: If voice chat is silent, open System Settings → Privacy → Microphone and ensure AIRI is checked.
- Switching AI Providers: Visit Settings → Providers. Each provider entry shows real-time validation so you know credentials work.
- Changing Avatars Later: Go to Settings → Appearance. Drag-and-drop new Live2D
.zipor VRM models; previews generate automatically. - Platform Integrations: Telegram and Minecraft guides live under the Platform Integrations section.
- Developer Mode: Clone the repo and run
pnpm i && turbo run devfor live coding—see the For Developers pages.
Related Technical Files
| Functional Role | Code File | Description |
|---|---|---|
| Onboarding Wizard UI | apps/stage-tamagotchi/src/pages/onboarding.vue | Guides first-time setup for providers and avatar |
| Provider Validation Logic | packages/stage-ui/src/composables/useProviderValidation.ts | Checks API keys or local endpoints in real time |
| Avatar Model Store | packages/stage-ui/src/stores/display-models.ts | Saves and previews Live2D/VRM models |
| Discord Bot Service | services/discord-bot/src/index.ts | Handles /summon and voice interaction in Discord |