@convai/embody 1.0.0-beta.0 → 1.0.0-beta.2

This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
Files changed (3) hide show
  1. package/CHANGELOG.md +12 -0
  2. package/README.md +10 -0
  3. package/package.json +2 -2
package/CHANGELOG.md CHANGED
@@ -1,5 +1,17 @@
1
1
  # @convai/embody
2
2
 
3
+ ## 1.0.0-beta.2
4
+
5
+ ### Patch Changes
6
+
7
+ - Docs: the quick start and both guides now say that a character with Long-Term Memory needs `session.endUserId`; without it, connecting fails with "Missing end_user_id".
8
+
9
+ ## 1.0.0-beta.1
10
+
11
+ ### Patch Changes
12
+
13
+ - `@convai/web-sdk` peer is now `>=2.0.1 <3`. web-sdk 1.9.x is no longer maintained, so embody 1.0 targets 2.x only.
14
+
3
15
  ## 1.0.0-beta.0
4
16
 
5
17
  ### Major Changes
package/README.md CHANGED
@@ -58,6 +58,16 @@ no camera, no `ConvaiClient`, no resolver, no frame loop. embody resolves the
58
58
  body, opens the `@convai/web-sdk` connection, renders its audio, and drives
59
59
  lipsync, gaze, breathing and blink.
60
60
 
61
+ If the character has **Long-Term Memory** turned on, the connection also needs
62
+ an end-user id, so the character can tell your users apart. Pass a stable id
63
+ for the person using your app:
64
+
65
+ ```tsx
66
+ <ConvaiCharacter apiKey={apiKey} characterId={characterId} session={{ endUserId: user.id }} />
67
+ ```
68
+
69
+ Without it, connecting fails with *"Missing end_user_id"*.
70
+
61
71
  ### Credentials
62
72
 
63
73
  `apiKey` is the fastest way to see something on screen, and it is what the
package/package.json CHANGED
@@ -1,6 +1,6 @@
1
1
  {
2
2
  "name": "@convai/embody",
3
- "version": "1.0.0-beta.0",
3
+ "version": "1.0.0-beta.2",
4
4
  "description": "Give a Convai character a body: resolve 3D characters by characterId and drive them with lipsync and animation. Layered on @convai/web-sdk.",
5
5
  "license": "Apache-2.0",
6
6
  "author": "Convai <support@convai.com>",
@@ -58,7 +58,7 @@
58
58
  "access": "public"
59
59
  },
60
60
  "peerDependencies": {
61
- "@convai/web-sdk": ">=1.9.4 <3",
61
+ "@convai/web-sdk": ">=2.0.1 <3",
62
62
  "@react-three/fiber": ">=8 <10",
63
63
  "react": ">=18 <20",
64
64
  "three": ">=0.160 <1"