Skip to content

AVATAR v0.6.0

Latest
Latest

Choose a tag to compare

View all tags
@rosspeili rosspeili released this 07 Aug 11:46
· 5 commits to main since this release
v0.6.0
c8ec7c0

Open-source VRM desktop companion — transparent always-on-top overlay with VRMA motion and real-time lip sync. This release hardens the contributor loop (CI, broader ESLint), ships desktop companion docs GIFs, renames the app package directory to avatar/, and lands several real desktop/runtime fixes.

Download

Drag the glass bar to move; use Gear for Appearance, Voice, Camera, Animations, and Settings.

Install options

  1. Windows installer (easiest) — no Node.js
  2. From source:
cd avatar
npm install
npm run desktop
  1. Web / contributors: npm run dev → http://localhost:5173

What's new

Continuous integration & quality (#4, #34, #35)

  • GitHub Actions on every PR and main: npm ci → lint → test → build in avatar/ (Node 22)
  • Electron binary download skipped in CI (ELECTRON_SKIP_BINARY_DOWNLOAD); unit tests do not launch Electron
  • Windows installer (dist:win) stays local-only (not run in CI)
  • README CI status badge

ESLint (#34)

  • Lint now covers src/, electron/**/*.cjs, and build scripts (scripts/, config files)
  • npm run lint enforces --max-warnings=0
  • Small cleanups found by the wider net: VrmAvatar captures the Three.js group once so cleanup detaches from the same container; unused audioFile prop dropped from VoicePanel

Docs & repo layout (#3, #32)

  • Package directory renamed avatar-demo/ → avatar/ (installer name/path unchanged; contributor paths updated)
  • Desktop companion GIFs (AVATAR_M5_*) in README and guides — overlay, Settings scroll, animations, custom environments, Camera & Lighting
  • Contributing expanded for ripple effects, changelog #issue / #PR style, CI expectations, and human/AI guidance

Desktop / runtime fixes

  • dev:desktop teardown — concurrently -k so closing the Electron window (or killing Vite) stops both processes and frees port 5173 (#37, #38)
  • Custom environment library blobs — revoke previous folder blob: URLs only after the replacement list is in state, so the stage/picker never briefly reference dead URLs during a Directories folder switch; also revoke on error/empty clear paths (#39, #40)

Citation (#41)

  • Heng-Cheng Hsu (許恒誠) added to CITATION.cff authors and preferred citation (GitHub “Cite this repository”)

Notes

  • Installer is unsigned — SmartScreen may warn (More info → Run anyway)
  • Hub characters stay session-only (not written to disk / config.yaml)
  • Sample VRM/VRMA assets retain upstream licenses (VRoid / pixiv) — see Assets & credits
  • Full notes: CHANGELOG · v0.6.0 docs

Contributors

Thanks @AUDOSt0ck1ng for ESLint, CI, dev:desktop teardown, and the environment blob-URL revoke fix — and @rosspeili for docs GIFs, package rename, citation, and release packaging.

Contributors

AUDOSt0ck1ng and rosspeili
Assets 3
Loading