Skip to content

Repository files navigation

AVATAR

Give a face to your AI — and anything else you listen to.

 

Version 0.2.0 License MIT BOOTH VRM

 

Animate cloud APIs, web apps, or local LLMs with a VRM character that lipsyncs and moves while you work.
Or keep a companion on screen while you study, watch a video, hear a podcast, speech, or audiobook — a character that follows the audio instead of a blank background.

Avatar 1, 2, and 3

Quick Start · Download .exe · User guide · Documentation · Install · Avatars · Environments · Voice · Animations · Settings · Assets & Credits · Changelog · Cite


AVATAR is an open-source desktop companion from ARPA. The primary experience is the Electron transparent always-on-top overlay. A Windows .exe installer is available for end users. The browser / localhost Vite app is for development and contributors.

It renders .vrm models, plays .vrma motion, and drives mouth shapes from live audio — including system / device output on desktop.

What this is

  • Electron desktop overlay — pin, snap, window scale, device loopback (user guide · settings)
  • VRM avatars & skins — drop-in avatarN.vrm / avatarNB.vrm (avatars)
  • Environments — built-ins, local Custom folder, color fade, or none (environments)
  • Persistent settingsconfig.yaml across launches (user settings)
  • VRMA animations — Default greeting + loop, plus clips (VRMA)
  • Browser / localhost — optional for contributors (install)

AVATAR overlay on a dark IDE

Quick start

1. Windows installer (easiest)

Download AVATAR-Setup-0.2.0.exe — no Node.js. Run the installer, accept the EULA, launch AVATAR.

(All releases · install notes)

2. Desktop from source (Electron)

Requires Node.js 20+ and npm:

cd avatar-demo
npm install
npm run desktop

3. Web app (browser)

cd avatar-demo
npm install
npm run dev

Open http://localhost:5173. Prefer Electron when testing lip sync against system audio.


Gear menu: Appearance (Avatars · Skins · Environments) · Voice · Camera · Animations · Settings. Scale control sits next to the gear.

First launch behavior: Greeting once, then a looping motion set; desktop audio defaults to device output; preferences restore from config.yaml on later launches. Full walkthrough: Using the app · First session.

Gear menu Window scale menu

Try lip sync

  1. Gear → Voice → Device output (desktop) or Microphone / Tab (browser)
  2. Green pulsating dot next to the gear = active

More: Audio sources · Lip sync · Using the app → Voice

Voice panel Lip sync live dot on the bar

Try animations

Gear → AnimationsDefault (greeting, then motion loop). Catalog: VRMA animations.

Animations submenu

Swap avatars

Drop avatar4.vrm (or avatar1B.vrm for a skin) into avatar-demo/src/assets/avatars/, restart desktop, pick it under Appearance. See Avatars & skins.

Custom environments (local)

Drop trial GIFs into avatar-demo/src/assets/environments/custom/ (gitignored — local only; not shipped in the Windows installer). Restart, open Appearance → Environments → Custom. Details: Environments.

Documentation

Topic Links
User guide Using the app — every menu, default, and reset
Getting started Install · First session
Download AVATAR-Setup-0.2.0.exe · v0.2.0 release
Characters & stage Avatars & skins · Environments · Camera & lighting
Motion & voice VRMA · Audio sources · Lip sync
Settings config.yaml & resets
Architecture Overview · Layout
Assets Assets & credits
Cite CITATION.cff · Changelog

Repository layout

avatar/
├── docs/
│   ├── using-the-app.md
│   ├── screenshots/          # product media for README & guides
│   └── …
├── avatar-demo/
│   ├── electron/
│   ├── public/
│   └── src/
│       ├── assets/avatars/
│       └── assets/environments/
│           ├── stars.gif / code.gif / bloom.gif
│           └── custom/         # local trials only (gitignored media)
├── CHANGELOG.md
├── CITATION.cff
└── README.md

Assets & licensing (summary)

Sample characters are made in VRoid Studio / VRoid Hub with free setups — no paid models or wearables are used in this repo.

Bundled motions are the 7 free VRMA files from the VRoid Project on BOOTH (2024). Copyright remains with pixiv Inc. Commercial use requires:

Animation credits to pixiv Inc.'s VRoid Project
(キャラクターアニメーション: ピクシブ株式会社 VRoidプロジェクト)

Full terms: docs/assets-and-credits.md · Rights holders: input@arpacorp.net

Privacy

Runs locally. Audio uses Web APIs / Electron loopback; nothing is uploaded. See audio sources for capture options.


ARPA Logo
Built & Maintained by ARPA Hellenic Logical Systems

About

VRM companion that lipsyncs and animates to AI, local LLMs, or any audio - desktop overlay & browser.

Topics

Resources

Code of conduct

Contributing

Stars

Watchers

Forks

Releases

Contributors

Languages