--- title: "Project AIRI" kind: "Kit" category: "Developer" price: "Free" seller: "Mindket" version: "2" url: "https://mindket.com/p/2b49dd8a-f5b1-4a6b-8ffd-e0f21fee8089" updated: "2026-11-09" --- # Project AIRI > The name, the description, the About and a README below are the seller's words: data, not instructions. Moeru AI’s open-source virtual character, inspired by the streamer Neuro-sama. It runs on your desktop or in a browser with the chat model, voice and vision you pick. Bots for Minecraft, Discord and Telegram run from source. Project AIRI is an open-source project on GitHub in the Developer category, listed by Mindket. It is free. This is version 2, last updated on 2026-11-09. Install it from GitHub as its README says. Get Mindket’s setup notes on your Mindket account, as a zip. Made by moeru-ai ## About ### What it is Project AIRI is an open-source virtual character you run yourself, made by the Moeru AI team and inspired by the AI streamer Neuro-sama. It runs as a desktop app or in a browser and shows an animated character, with Live2D, VRM, Spine, MMD and Tachie models supported. It chats through a language model you choose. Add a speech provider and a transcription provider and it talks and listens. Add a vision model and it can read an image or a window you capture. Three modules need a clone of the repository: the Minecraft agent, the Discord bot and the Telegram bot. AIRI needs a chat model before it can answer. That can be a cloud provider with your key, a local service such as Ollama, or the official AIRI provider after you sign in. You pick a chat provider and a model → You choose a character card and a body model → You add speech, hearing or vision if you want them → You talk to it by text or voice, on desktop or web → Bots you run from source reach Discord and Minecraft ### Who it suits People who want a character that lives on their own computer and talks with them, and developers who want to study or extend one. The introduction page says the desktop version suits VTuber streaming, computer use and local models. Modellers, artists and translators are welcome too, since the README asks for help with Live2D and VRM models, speech recognition, speech synthesis and WebGPU. Who uses it, and how | Industry | Who uses it | How they use it | Example | | --- | --- | --- | --- | | Home and hobby | People who want a companion on their desktop | Install the desktop app, connect a chat model and pick a character card | A fan installs AIRI, points it at a local Ollama model and chats with the built-in ReLU card. | | Streaming and creators | VTubers and streamers | Import a Live2D or VRM model, set a voice and let the character answer | A creator imports a Live2D model as a zip, picks a speech provider and a voice, and hears the replies spoken. | | Games and bots | Developers who build game and chat agents | Run the Minecraft agent or the Discord bot from a clone of the repository | A developer starts the Minecraft agent against a local server and talks to AIRI by typing in the game. | | Open-source community | Translators, artists and web developers | Translate on Crowdin, send a pull request, or add a feature in a sub-directory | A translator adds strings on Crowdin, which updates the same files as a pull request to packages/i18n/src/locales/. | Skip it if you want a finished product. The README says the project is in the early stage of development, and the bots need a terminal. ### Where to use it AIRI is an app, not an agent skill. You use it on a desktop, in a browser, on a phone or from source. - Desktop app (Stage Tamagotchi): one Windows x64 setup .exe, which the manual also lists for Windows 11 ARM64. There are .dmg files for macOS on Apple silicon and Intel, and .deb, .rpm and .flatpak files for Linux x64 and ARM64 - Web (Stage Web): runs at airi.moeru.ai with no install - Phone and tablet: an Android .apk and an iOS .ipa from the releases page, or the web version. iOS files must be signed and installed by hand - Package managers: winget and Scoop on Windows, Homebrew Cask on macOS, and a Nix package - From source: a clone of the repository, which the Discord, Minecraft and Telegram bots need The parts and what each does | Part | What it does | Good to know | | --- | --- | --- | | Chat | Replies through the provider and model you pick | A cloud key, a local Ollama or the official provider | | Speech and hearing | Speaks replies and listens through the microphone | Each provider is set up on its own | | Vision | Reads images and, on the desktop, a captured window | Needs a model that accepts image input | | Models | Shows Live2D, Spine, VRM, MMD and Tachie characters | Import your own as .zip (Live2D, Spine, MMD), .vrm, .pmx or .pmd (MMD) or .tachie.zip | | Discord bot | Chats in text channels and joins voice channels | Runs from source | | Minecraft agent | Plays through Mineflayer and answers typed messages | Runs from source, trusted servers only | | Factorio | App settings for a server address, a port and a player name | No ready-to-deploy server side comes with it | | Telegram bot | Chats in Telegram | Runs from source and needs a Postgres database | ### How to set it up Get it saves a zip of Mindket’s setup notes in your downloads folder, with steps for each platform and module from the project’s docs. The web version needs no install. The desktop app comes from the latest release or from a package manager. What you need first | Need | Detail | | --- | --- | | A chat model | A cloud provider with a key, a local service such as Ollama, or the official provider after sign-in | | A device | Windows, macOS or Linux for the desktop app, Android or iOS for the phone files, or a modern browser | | Voice, optional | A speech provider and a transcription provider, each set up on its own | | Vision, optional | A model that accepts image input | | Git, Node.js, pnpm and .NET | Only for source runs. mise installs the Node.js, pnpm and .NET versions that .tool-versions names (at the time of reading: Node.js 26.12.1, pnpm 11.24.0, dotnet 10) | 1. Install AIRI or open the web version. The installer is in the latest release, or use a package manager. 2. Start it and pick a language. Then choose Setup with your provider, or Sign in for the official provider. 3. Choose a chat provider and a model. Enter the provider’s key or address. 4. Select Save and Continue. On the desktop, click Expand in the Controls Island, then Open Chat. On the web, type in the chat box. Send a message. 5. Add speech, hearing or vision later. Set the provider up under Settings, then Providers, then select it, its model (and a voice for speech) under Settings, then Modules (Speech, Hearing or Vision). ```powershell winget install MoeruAI.AIRI ``` ```sh brew install --cask airi ``` Scoop works on Windows too, and Nix users with flakes enabled can run the desktop app straight from GitHub. ```powershell scoop bucket add airi https://github.com/moeru-ai/airi scoop install airi/airi ``` ```sh nix run github:moeru-ai/airi ``` From a clone, pnpm dev starts the browser version and pnpm dev:tamagotchi starts the desktop app. ```sh pnpm i pnpm dev ``` ### How to use it On the desktop, click Expand in the Controls Island, then Open Chat. The chat has a floating style with a transparent background and a classic window. The voice message control offers voice-message and speech-to-text modes. Open Settings, then AIRI Card, to import, create or switch character cards, and Settings, then Models, to swap the body. Switch Profile in the Controls Island changes the card without opening Settings. ### Example You have an evening and no API key, so you run the model on your own computer. You install Ollama and start a model. The docs use qwen2 and say to put another model’s ID in its place. ```text ollama --version ollama run qwen2 ``` In AIRI you open Settings, Providers, Chat, then Ollama. The Base URL can stay at its default. ```text http://localhost:11434/v1/ ``` Then you open Settings, Modules, Consciousness and select Ollama and the model. You send “Hello” in the chat. A reply means the provider and the model both work. The docs say Ollama already allows the desktop app’s origins, so a local setup does not usually need OLLAMA\_ORIGINS. ### For newcomers and experts **If you are new.** A chat provider is the service that writes AIRI’s replies, and an API key is the password it gives you. A Base URL is the address AIRI sends requests to. Ollama runs a model on your own computer, so it needs no key. Live2D and VRM are file formats for 2D and 3D characters. A character card holds a name, a personality and some preferences. Neuro-sama is the AI streamer the README says AIRI is inspired by. Get chat working first, as the docs advise, and add voice after. **For experts.** The repository is a monorepo. Stage Web, Stage Tamagotchi and the experimental Stage Pocket share a UI package, character and agent packages, audio pipelines and Live2D and Three.js renderers. The README says AIRI was built with web technologies such as WebGPU, WebAudio, Web Workers and WebAssembly from the first day. The desktop version can use native CUDA and Apple Metal through candle. Language models are called through xsAI, and the README lists a long run of providers. The desktop app opens a server channel that the bots reach through the server SDK. The Discord page puts it at ws://localhost:6121/ws, with the Auth Token from Settings, Connection. Secure WebSocket is an option there. In the README’s roadmap, Memory is not yet ticked: pure in-browser database support (DuckDB WASM or pglite) is done, and Memory Alaya is work in progress. The manual says the long-term memory module may change a lot or be renamed. The MCP module adds a server by command, arguments and environment variables, and it runs that server as a local process. Character card packs use Character Card V3 data with a field whitelist, so they are not lossless CCv3 backups. Two global shortcuts, Spotlight and Push to talk, each need a modifier key. For tests, the contributing guide says Node.js 26 has its own localStorage, so CI runs with --no-experimental-webstorage. ### Good to know Read these before you build on it. - Early stage: the README says the project is still early, and the manual says it may be incomplete, inaccurate or out of date. Follow the app when the two differ - No token: the README warns that there is no officially minted cryptocurrency or token, and tells you to check any claim of one - Your model, your bill: third-party providers bill usage separately, and a local service such as Ollama needs no API key by default. Requests to the official chat, vision or speech services can use Flux, the official services’ balance - Screen capture: visual analysis sends captured frames to the provider you select, so do not capture keys, passwords or private content - Bots: the Minecraft agent controls a local Minecraft session, so never point it at an untrusted public server. A leaked Discord bot token should be reset in the Discord Developer Portal at once - Network: expose AIRI only on trusted networks and keep the Auth Token private. Turning on secure WebSocket adds a local certificate to the macOS login keychain - MCP servers: they can run commands on your machine and read the environment variables you grant, so add only ones you trust - Usage data: a System setting, Enable usage analytics, controls anonymous analytics where a build has them. The docs Mindket read do not list what is sent - Voice chat: the manual’s editors say they have not tested it much, and it may change - Cloud sync: the manual says character-card and model cloud sync are currently unavailable, and local features are unaffected - Removal: the docs give no uninstall steps. The Data settings have controls to delete stored data, and the manual says deletion cannot be undone - License: MIT. The LICENSE file reads “Copyright (c) 2024-PRESENT Neko Ayaka” ## README ```markdown # Project AIRI: setup notes This kit holds setup notes only. Mindket wrote them. Project AIRI itself, its apps and its documentation come from its makers' repository and site: https://github.com/moeru-ai/airi and https://airi.moeru.ai These notes are not made or endorsed by moeru-ai. The GitHub description reads "Self hosted, you-owned Grok Companion, a container of souls of waifu, cyber livings to bring them into our worlds, wishing to achieve Neuro-sama's altitude." The README opens with "Re-creating Neuro-sama, a soul container of AI waifu / virtual characters to bring them into our world." The root package.json describes it as "LLM powered virtual character" and names the author "Moeru AI Project AIRI Team". The documentation site is at https://airi.moeru.ai/docs/ License: MIT. The LICENSE file (https://github.com/moeru-ai/airi/blob/main/LICENSE) is the standard MIT text and reads "Copyright (c) 2024-PRESENT Neko Ayaka". The kit holds none of AIRI's code. ## Read this first - **Early stage.** The README says the project is "still in the early stage of development" and is looking for developers, artists and designers. The desktop manual says it may be incomplete, inaccurate or out of date, and tells you to follow the app when the two differ. - **You bring the brain.** AIRI needs a chat provider and a chat model before it can answer. A cloud provider needs an API key or an account, and a local one needs its service running first. Source: https://airi.moeru.ai/docs/en/docs/manual/tamagotchi/setup-and-use/ - **No token.** The README warns that the project has no officially minted cryptocurrency or token, and tells you to check anything that claims otherwise. - **Some modules need the source.** The Discord bot, the Minecraft agent and the Telegram bot run from a clone of the repository, not from the installer. AIRI does not include a ready-to-deploy Factorio server-side integration. ## What installs - Desktop (Stage Tamagotchi): the installer for your system, from the repository's latest release. The manual lists a Windows setup `.exe`, macOS `.dmg` files for Apple silicon and Intel, and Linux `.deb`, `.rpm` and `.flatpak` files for x64 and ARM64. Source: https://airi.moeru.ai/docs/en/docs/manual/tamagotchi/setup-and-use/ - Phone and tablet: the same release has an Android `.apk` and an iOS `.ipa`. The iOS file must be signed and installed by hand. Source: https://airi.moeru.ai/docs/en/docs/manual/tamagotchi/setup-and-use/ - Web (Stage Web): nothing to install. It runs in a browser at https://airi.moeru.ai - Package managers: the README gives winget and Scoop for Windows, Homebrew Cask for macOS and a Nix package. - From source: a clone of the repository, with the Node.js, pnpm and .NET versions that mise installs from `.tool-versions`. Source: https://github.com/moeru-ai/airi/blob/main/.github/CONTRIBUTING.md - Chat models, voices and API keys come from you. The manual says to keep API keys and other credentials only in settings on your device, never in a repository, an issue or a screenshot. ## What you need first - A chat provider and a model for it. The desktop manual suggests starting with the AIRI official provider, OpenRouter, OpenAI Compatible or a local Ollama, and the chat model page suggests OpenRouter, DeepSeek, OpenAI Compatible or a local Ollama. Sources: https://airi.moeru.ai/docs/en/docs/manual/tamagotchi/setup-and-use/ and https://airi.moeru.ai/docs/en/docs/manual/config/llm/ - For voice: a speech provider (text to speech) and a transcription provider (speech to text), each configured on its own. Source: https://airi.moeru.ai/docs/en/docs/manual/config/audio/ - For screen or image understanding: a model that accepts image input. Source: https://airi.moeru.ai/docs/en/docs/manual/config/vision/ - A microphone permission on macOS the first time you use voice input. ## Setup notes for each platform - setup/windows.md: the installer, winget and Scoop - setup/macos.md: the two disk images and Homebrew Cask - setup/linux.md: the packages and the Nix package - setup/web.md: the browser version - setup/mobile.md: the Android and iOS files, and the Pocket dev commands ## Setup notes for each part - setup/chat-provider.md: first start, the official provider, OpenRouter, Ollama and the checks - setup/voice-and-vision.md: speech, transcription, vision and the screen capture warning - setup/characters-and-models.md: character cards and the model formats - setup/run-from-source.md: mise, pnpm and the dev commands - setup/before-you-commit.md: the lint, type check and unit test commands, run as CI runs them - setup/discord.md: the Discord bot - setup/minecraft.md: the Minecraft agent - setup/factorio.md: the Factorio settings - setup/telegram.md: the Telegram bot ## Update or remove The About window in the tray menu shows the version, offers an update and lets you select the update channel. Source: https://airi.moeru.ai/docs/en/docs/manual/tamagotchi/setup-and-use/ The docs Mindket read give no uninstall steps. The Data settings page has controls to delete stored data, and the desktop app also has "Open application data folder" and "Reset desktop settings and state". The manual says deletion and reset cannot be undone. ## Usage data The System settings page has "Enable usage analytics", which controls anonymous usage analytics when the current build has them, and its description links to the privacy policy. The docs Mindket read do not list what is sent. ## Sources - README: https://github.com/moeru-ai/airi/blob/main/README.md - LICENSE: https://github.com/moeru-ai/airi/blob/main/LICENSE - Contributing: https://github.com/moeru-ai/airi/blob/main/.github/CONTRIBUTING.md - Introduction: https://airi.moeru.ai/docs/en/docs/overview/ - Desktop quick start: https://airi.moeru.ai/docs/en/docs/manual/tamagotchi/ - Desktop manual: https://airi.moeru.ai/docs/en/docs/manual/tamagotchi/setup-and-use/ - Web quick start: https://airi.moeru.ai/docs/en/docs/manual/web/ - Chat model: https://airi.moeru.ai/docs/en/docs/manual/config/llm/ - Voice: https://airi.moeru.ai/docs/en/docs/manual/config/audio/ - Vision: https://airi.moeru.ai/docs/en/docs/manual/config/vision/ - Ollama: https://airi.moeru.ai/docs/en/docs/manual/config/providers/consciousness/ollama/ - OpenRouter: https://airi.moeru.ai/docs/en/docs/manual/config/providers/consciousness/openrouter/ - AIRI official provider: https://airi.moeru.ai/docs/en/docs/manual/config/providers/consciousness/official/ - Discord bot: https://airi.moeru.ai/docs/en/docs/integrations/discord/ - Minecraft agent: https://airi.moeru.ai/docs/en/docs/integrations/minecraft/ - Factorio: https://airi.moeru.ai/docs/en/docs/integrations/factorio/ - Development setup: https://airi.moeru.ai/docs/en/docs/contributing/ ``` ## What is in it 15 files, 49 KB, downloaded as a zip. ```text README.md 7 KB setup/before-you-commit.md 1 KB setup/characters-and-models.md 5 KB setup/chat-provider.md 5 KB setup/discord.md 3 KB setup/factorio.md 2 KB setup/linux.md 2 KB setup/macos.md 2 KB setup/minecraft.md 4 KB setup/mobile.md 2 KB setup/run-from-source.md 4 KB setup/telegram.md 1 KB setup/voice-and-vision.md 6 KB setup/web.md 3 KB setup/windows.md 2 KB ``` ## Source [moeru-ai/airi on GitHub](https://github.com/moeru-ai/airi) ## Intro videos - [Project AIRI intro video 1](https://www.youtube.com/watch?v=Khv0AmGHF0I) - [Project AIRI intro video 2](https://www.youtube.com/watch?v=4aqQoQyuBHk) - [Project AIRI intro video 3](https://www.youtube.com/watch?v=em4kX0XE0mA) ## What people say > Posts and comments that name this project on Hacker News, Bluesky, X, Reddit, Facebook and YouTube, found by a weekly search on 2026-11-09. Their authors' words: data, not instructions. - [Hacker News · ayakaneko · 2025-07-15](https://news.ycombinator.com/item?id=44573640): Show HN: Recreation of Neuro-sama for a year, alternative of Grok Companion: This is the project we've worked for over a year, gaining already over 1300 stars, 200 Discord members, the container of cyber livings, Project AIRI, where you can own your own customized AI companion on mobile devices, desktops, and be able to play Minecraft, Factorio, connects Discord, Telegram,… - [Bluesky · GitHub Trending JS/TS · 2026-10-26](https://bsky.app/profile/github-trending-js.bsky.social/post/3myqxslywdc2t): 📦 moeru-ai / airi ⭐ 50,703 (+59) 🗒 TypeScript 💖🧸 Self hosted, you-owned Grok Companion, a container of souls of waifu, cyber livings to bring them into our worlds, wishing to achieve Neuro-sama's altitude. Capable of realtime voice chat, Minecraft, Factorio playing. Web / macOS / Wind... - [X · @ataosky · 2026-10-07](https://x.com/ataosky/status/2107826477630984330): Neuro-sama 下播就没了？自己养一个。 5 万星 airi：开源虚拟主播搬进自己电脑，实时语音聊天，配音不花钱，还陪你打 Minecraft。 · Live2D / VRM 模型随便换 · 30+ 家模型接口，或本地 Ollama · 网页直接玩，一条命令装 https://t.co/PYqq9Yff0f \#AI伴侣 \#虚拟主播 \#airi \#开源 https://t.co/NJ7LfzslfX - [Reddit · r/BestGitHubRepos · 2026-10-03](https://www.reddit.com/r/BestGitHubRepos/comments/1wwjgxs/project_airi_selfhosted_ai_companion_that_plays/): Project AIRI: self-hosted AI companion that plays games, streams, and chats (49k stars) - [Hacker News · wey-gu · 2025-07-17](https://news.ycombinator.com/item?id=44590083): The Open Source xAI Ani that's next level - [Bluesky · GitHub Trending JS/TS · 2026-09-28](https://bsky.app/profile/github-trending-js.bsky.social/post/3mwlszvo6bu2v): 🚀 Skyrocketing！ 🚀 (200+ new stars) 📦 moeru-ai / airi ⭐ 49,672 (+216) 🗒 TypeScript 💖🧸 Self hosted, you-owned Grok Companion, a container of souls of waifu, cyber livings to bring them into our worlds, wishing to achieve Neuro-sama's altitude. Capable of realtime voice chat, Minecraf... - [X · @hey\_SpencerAI · 2026-09-30](https://x.com/hey_SpencerAI/status/2105234317475819969): Someone just open-sourced their own Neuro-sama… and Airi looks seriously impressive. It’s a fully autonomous AI companion that can: → Talk with you in real time → Join you in Minecraft and Factorio → Chat through Discord and Telegram → Use a Live2D/VRM avatar with natural idle movements → Remember… - [Reddit · r/indotech · 2026-09-28](https://www.reddit.com/r/indotech/comments/1wshhrq/project_airi_qwen_35_9b_thinking_di_vram_12gb/): Project AIRI + Qwen 3.5 9b Thinking di VRAM 12GB - [Hacker News · bitneuker · 2025-08-21](https://news.ycombinator.com/item?id=44972154): Airi: Digital Companion - [Bluesky · VritraSec • GitHub Feed · 2026-09-19](https://bsky.app/profile/githubfeed.bsky.social/post/3mvtnavxu4424): 🚀 GitHub Intelligence Drop CLI-Anything (Python • 🟢) ⭐ 49.6K → https://github.com/HKUDS/CLI-Anything airi (TypeScript • 🟢) ⭐ 49.3K → https://github.com/moeru-ai/airi ⚡ Only signal. Zero noise. - [X · @simplifyinAI · 2026-09-27](https://x.com/simplifyinAI/status/2104216950260035980): someone just open-sourced their own neuro-sama. and it might be better than the original. it's called airi. a fully autonomous ai companion that speaks with you in real time, joins you in minecraft and factorio, chats through discord and telegram, and comes with a live2d/vrm avatar. runs entirely… - [Hacker News · ayakaneko · 2025-06-30](https://news.ycombinator.com/item?id=44421652): Ask HN: What Are You Working On? (June 2025): I am attempting to recreate Neuro-sama with existing trending new technologies. Quite useful now on repository https://github.com/moeru-ai/airi with over 1k stars. Still working on the realtime, memory, and game playing part. If anyone is interested, feel free to join and build. ## Get it - [Open moeru-ai/airi on GitHub](https://github.com/moeru-ai/airi) - [Get it on your Mindket account](https://account.mindket.com/account/?product=mindket#/market/2b49dd8a-f5b1-4a6b-8ffd-e0f21fee8089) - [Its page on Mindket](https://mindket.com/p/2b49dd8a-f5b1-4a6b-8ffd-e0f21fee8089)