Skip to content

Latest commit

 

History

History
37 lines (30 loc) · 2.04 KB

File metadata and controls

37 lines (30 loc) · 2.04 KB

AVATAR — Documentation

Electron desktop companion first; browser localhost for development.

Start here

Section Description
Installation 1. Windows .exe · 2. npm run desktop · 3. npm run dev
First session 2-minute onboarding
Using the app Full user guide — every menu and option
User settings config.yaml, what persists, reset all / per-section
Releases Version notes · v0.7.0 · Changelog

Features in depth

Doc Description
Avatars avatarN.vrm drop-in naming, custom folders, VRoid Hub
Environments Built-in, Custom, color, none, chrome contrast
Camera & lighting Framing, lights, avatar transform, resets
VRMA animations Default greeting + loop, individual clips
Manual animation testing QA checklist for Default sequence
Audio sources Desktop loopback, window, mic, file — full Voice panel reference
Lip sync Amplitude visemes, status-aware live dot, troubleshooting
VRoid Hub connection Opt-in OAuth (Settings), pick characters in Appearance, session-only Hub VRMs
Local agent bus Opt-in loopback API so scripts and agents can play animations and swap avatars

Project

Doc Description
Architecture Rendering, VRMA, Electron, settings
Project layout Folders and scripts
Release checklist Maintainer bump / tag / installer publish
Roadmap Milestones
Assets & credits VRoid / BOOTH / Pixiv terms · manifest