Skip to content

Project AIRI

Project AIRI is an open-source project designed to replicate the functionality of Neuro-sama, providing a self-hosted AI VTuber and digital companion^[001-TODO__Project_AIRI_-开源_AI_VTuber_赛博伴侣.md]. It allows users to create and interact with AI virtual characters capable of real-time voice chat, gaming (such as Minecraft or Factorio), and running across multiple platforms including Web, desktop, and mobile^[001-TODO__Project_AIRI-_开源_AI_VTuber_赛博伴侣.md].

The project addresses limitations in existing AI character tools, which are often restricted to text-based chats, by enabling complex interactions like gameplay and giving users full control through self-hosting^[001-TODO__Project_AIRI_-_开源_AI_VTuber_赛博伴侣.md].

Key Features

Project AIRI provides a comprehensive suite of features for creating an interactive AI agent^[001-TODO__Project_AIRI_-_开源_AI_VTuber_赛博伴侣.md]:

  • Real-time Interaction: Supports voice chat and LLM-based conversation with support for over 30 LLM API providers^[001-TODO__Project_AIRI_-_开源_AI_VTuber_赛博伴侣.md].
  • Gaming Capabilities: Can play games like Minecraft (via Mineflayer), Factorio (Proof of Concept), and Kerbal Space Program^[001-TODO__Project_AIRI_-_开源_AI_VTuber_赛博伴侣.md].
  • Model Support: Renders both Live2D and VRM (3D) models with features like auto-blinking, gaze tracking, and animation^[001-TODO__Project_AIRI_-_开源_AI_VTuber_赛博伴侣.md].
  • Multi-Platform: Runs on the Web (PWA), Desktop (Electron), and Mobile (Capacitor for iOS/Android)^[001-TODO__Project_AIRI_-_开源_AI_VTuber_赛博伴侣.md].
  • Integrations: Includes services for Discord and Telegram bots, as well as a plugin system for tools like Home Assistant or Bilibili^[001-TODO__Project_AIRI_-_开源_AI_VTuber_赛博伴侣.md].
  • Memory System: Currently in development (WIP), utilizing DuckDB WASM or pglite for browser-side storage^[001-TODO__Project_AIRI_-_开源_AI_VTuber_赛博伴侣.md].

Technical Architecture

The project is developed as a monorepo using pnpm workspaces, primarily utilizing TypeScript, Vue.js, and Rust^[001-TODO__Project_AIRI_-_开源_AI_VTuber_赛博伴侣.md]. Key architectural components include:

  • Frontend: Built with Vue.js and Vite; 3D rendering is handled by Three.js (via TresJS)^[001-TODO__Project_AIRI_-_开源_AI_VTuber_赛博伴侣.md].
  • Desktop: Packaged with Electron for the "Stage Tamagotchi" desktop client^[001-TODO__Project_AIRI_-_开源_AI_VTuber_赛博伴侣.md].
  • Audio Processing: Uses the WebAudio API along with services like ElevenLabs for TTS^[001-TODO__Project_AIRI_-_开源_AI_VTuber_赛博伴侣.md].
  • LLM Interaction: Uses a custom library, xsai, similar to Vercel AI SDK^[001-TODO__Project_AIRI_-_开源_AI_VTuber_赛博伴侣.md].

The repository is structured into apps (web, desktop, mobile, server), packages (core logic, UI, audio, memory), plugins, and external services^[001-TODO__Project_AIRI_-_开源_AI_VTuber_赛博伴侣.md].

Installation

Users can engage with Project AIRI through several methods^[001-TODO__Project_AIRI_-_开源_AI_VTuber_赛博伴侣.md]:

  • Pre-built Binaries: Installers are available for macOS (.dmg), Windows (.exe), and Linux from the GitHub Releases page^[001-TODO__Project_AIRI_-_开源_AI_VTuber_赛博伴侣.md].
  • Web App: Accessible directly at https://airi.moeru.ai as a PWA^[001-TODO__Project_AIRI_-_开源_AI_VTuber_赛博伴侣.md].
  • Package Managers: Supports Scoop on Windows and Nix (flakes) on Linux/macOS^[001-TODO__Project_AIRI_-_开源_AI_VTuber_赛博伴侣.md].
  • Source: Developers can build from source using pnpm (requiring Node.js 23+ and Rust for the desktop version)^[001-TODO__Project_AIRI_-_开源_AI_VTuber_赛博伴侣.md].

Privacy and Security

The project emphasizes user privacy and data ownership^[001-TODO__Project_AIRI_-开源_AI_VTuber_赛博伴侣.md]. * Data is stored locally (browser-side) or on self-hosted servers^[001-TODO__Project_AIRI-开源_AI_VTuber_赛博伴侣.md]. * Users configure their own LLM API keys, ensuring requests do not pass through third-party intermediaries^[001-TODO__Project_AIRI-开源_AI_VTuber_赛博伴侣.md]. * The project maintains a stance of having no official cryptocurrency or tokens^[001-TODO__Project_AIRI-_开源_AI_VTuber_赛博伴侣.md].

  • [[AI VTuber]]
  • [[Large Language Model (LLM)]]
  • [[Mineflayer]]
  • [[Live2D]]
  • [[VRM]]
  • [[Self-Hosting]]

Sources

  • 001-TODO__Project_AIRI_-_开源_AI_VTuber_赛博伴侣.md