Skip to content

Turn one illustration into an animated 2D mesh avatar with a coding agent and a local editor

Merge remote-tracking branch 'origin/main' into feat/expressions

shinshin868ca45d77de8e
diff --cc README.ja.md
index 84e1bcb,d17c6fb..ed6ab82
--- a/README.ja.md
+++ b/README.ja.md
@@@ -84,8 -84,8 +84,10 @@@ npm run de
![緑の背景にした配信用の画面](docs/images/ja/08-stream.png)
+「表情」のボタンか、キー1〜8で、笑顔、驚き、ウインクなどに切り替えられます。切り替えている間も、まばたきや口の動きはカメラとマイクに合わせて動きます([詳しく](docs/reference.md#expressions)、英語)。
+
+ カメラは使わなくてもかまいません。マイクだけをオンにすると、アバターは待機動作を続けながら、声に合わせて口を動かします。Zoom や Google Meet などの Web 会議にアバターで参加するときは、OBS の仮想カメラを使います([手順](docs/reference.md#video-calls)、英語)。
+
配信用画面の URL で指定できる項目、うまく動かないときの確認点、プライバシーについては[リファレンス](docs/reference.md#live-and-streaming)(英語)にまとめています。
## 詳しい資料
diff --cc README.md
index 9c3e253,9008863..c26bee1
--- a/README.md
+++ b/README.md
@@@ -119,9 -119,10 +119,13 @@@ stopped or slowed while hidden, bring i
![The stream view with a green background](docs/images/en/08-stream.png)
+Switch expressions such as a smile, surprise or a wink with the **Expression** buttons or
+keys **1**–**8** while tracking continues ([details](docs/reference.md#expressions)).
+
+ The camera is optional: with only the microphone on, the avatar keeps its idle motion and
+ your voice moves the mouth. To appear as the avatar in Zoom, Google Meet and similar apps, use
+ OBS's Virtual Camera ([steps](docs/reference.md#video-calls)).
+
Stream view options, troubleshooting and privacy details are in the
[reference](docs/reference.md#live-and-streaming).
diff --cc docs/reference.md
index 02bd8e3,949b2b7..12ced5b
--- a/docs/reference.md
+++ b/docs/reference.md
@@@ -200,19 -200,27 +200,40 @@@ for software without transparency suppo
- With the microphone on, the voice level drives how far the mouth opens and the camera keeps
the mouth shape. Drawn mouth images are used automatically when the project has them.
+### Expressions
+
+The Live page's **Expression** buttons switch the face to Neutral, Smile, Shy, Surprised,
+Half-lidded, Angry, Sad or Wink. Keys **1**–**8** do the same while the Live page is focused;
+press the same key or button again to return to Neutral. Keys typed into a form field are
+ignored. Because browsers receive keys only for the focused page, a key press from another app
+reaches the Live page only when its window is in front.
+
+An expression is layered over tracking: blinking, gaze and the mouth keep following the camera
+or microphone, while the eyes, brows and blush hold the expression. Switching fades smoothly.
+An expression also reaches the stream view without the camera or microphone. Brows hidden
+under bangs show less difference between Half-lidded, Angry and Sad.
+
+ ### Without a camera
+
+ The camera is optional. Turn on only the microphone and the avatar keeps its idle motion
+ (blinking, gaze, breathing, hair sway) while your voice opens and closes the mouth. Without
+ the camera the mouth keeps one shape and changes only how far it opens; drawn mouth images
+ are still used when the project has them.
+
+ ### Video calls
+
+ To use the avatar in Zoom, Google Meet or other video-call apps, show the stream view in OBS
+ and start OBS's **Virtual Camera**:
+
+ 1. Add the stream URL to an OBS scene as a **Browser Source**. A transparent background turns
+ black in the virtual camera, so choose a colour or add an image source behind the avatar.
+ 2. Choose **Start Virtual Camera** in OBS. On macOS, approve the camera extension the first time.
+ 3. In the video-call app, select **OBS Virtual Camera** as the camera. Select your microphone
+ directly for audio.
+
+ Keep the Live page running during the call. Many video-call apps mirror your own preview only;
+ the other participants see the avatar as it appears in OBS.
+
### Privacy
Camera video and microphone audio are processed in the browser and never leave your machine.