A lightweight 2.5D character player for the web, with lip sync and webcam face tracking.
Docs: what dispose() frees, and which browsers have been tested
LivLiv4fe70aa3909d
diff --git a/API.md b/API.mdindex a1f49ba..d45ea4c 100644--- a/API.md+++ b/API.md@@ -138,8 +138,10 @@ only with `idle` off (or use a [driver](#drivers) to add to them). `mouthOpen`,- `play()`, `pause()`, `playing`. The loop also skips drawing while the canvas is scrolled out of view.- `resize()`: draws now at the canvas's current size. Only needed after resizing a paused player.- `snapshot()`: the current frame as a PNG data URL (with the mark).-- `dispose()`: stops, removes drivers, frees GPU memory. A `load()` still running rejects, and a camera or microphone still- starting (`startFaceTracking`, `startLipSync`) is let go as soon as it opens. The canvas can take a new `Player` afterwards.+- `dispose()`: stops, removes drivers, frees the character's GPU memory. A `load()` still running rejects, and a camera or+ microphone still starting (`startFaceTracking`, `startLipSync`) is let go as soon as it opens. The canvas keeps its WebGL+ context and can take a new `Player` afterwards. A browser allows about 16 contexts at once and drops the oldest past that,+ so a page that shows many characters over time should reuse its canvases.- `puppet`: the renderer underneath, for what this API does not cover. Its fields can change between versions.### The mark@@ -349,7 +351,8 @@ play as they are. The rules for what changes the version: [FORMAT.md §9](FORMAT## Browser support-WebGL2 and ES2023: Chrome / Edge 97+, Firefox 104+, Safari 15.4+, on desktop and mobile (including in-app WebViews).+WebGL2 and ES2023: Chrome / Edge 97+, Firefox 104+, Safari 15.4+. Tested on current desktop Chromium, Firefox and WebKit;+not yet on phones or in in-app WebViews.## Buildingdiff --git a/README.ja.md b/README.ja.mdindex 602e436..18be7ca 100644--- a/README.ja.md+++ b/README.ja.md@@ -122,7 +122,7 @@ npm run test:browser # ヘッドレス Chromium で全キャラクターを描## 対応ブラウザ-WebGL2 と ES2023 が必要です:Chrome / Edge 97+、Firefox 104+、Safari 15.4+(デスクトップ、モバイルとも)。+WebGL2 と ES2023 が必要です:Chrome / Edge 97+、Firefox 104+、Safari 15.4+。テスト済みなのはデスクトップの最新版で、スマートフォンはまだテストしていません。## ライセンスdiff --git a/README.md b/README.mdindex 4e35921..1075c96 100644--- a/README.md+++ b/README.md@@ -151,7 +151,7 @@ npm run test:browser # every featured character drawn in headless Chromium; on## Browser support-WebGL2 and ES2023: Chrome / Edge 97+, Firefox 104+, Safari 15.4+, on desktop and mobile.+WebGL2 and ES2023: Chrome / Edge 97+, Firefox 104+, Safari 15.4+. Tested on current desktop browsers, not yet on phones.## Licensediff --git a/README.zh-CN.md b/README.zh-CN.mdindex 1b9a0f5..1ca952f 100644--- a/README.zh-CN.md+++ b/README.zh-CN.md@@ -124,7 +124,7 @@ npm run test:browser # 在无头 Chromium 里画出每个精选角色;先执## 浏览器支持-需要 WebGL2 和 ES2023:Chrome / Edge 97+、Firefox 104+、Safari 15.4+,桌面和手机都可以。+需要 WebGL2 和 ES2023:Chrome / Edge 97+、Firefox 104+、Safari 15.4+。目前在桌面最新版上测过,手机还没有测。## 许可