@voqalize/avatar 0.3.0 → 0.4.0
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.
- package/LICENSE-CC-BY-4.0 +396 -0
- package/README.md +65 -17
- package/assets/README.md +48 -0
- package/assets/tanya.glb +0 -0
- package/assets/tara.glb +0 -0
- package/assets/tushar.glb +0 -0
- package/client/AvatarClient.ts +337 -42
- package/client/arjun.ts +2 -0
- package/client/createAvatar.ts +38 -0
- package/client/index.ts +6 -1
- package/client/internal.ts +31 -3
- package/client/ishita.ts +2 -0
- package/client/kabir.ts +2 -0
- package/client/meera.ts +2 -0
- package/client/naina.ts +2 -0
- package/client/playout.ts +95 -0
- package/client/supports.ts +28 -0
- package/client/three/assets.ts +24 -0
- package/client/three/budgets.ts +27 -0
- package/client/three/holds.ts +64 -0
- package/client/three/internal.ts +54 -0
- package/client/three/motion-limits.json +116 -0
- package/client/three/sequences.ts +281 -0
- package/client/three/tanya.ts +69 -0
- package/client/three/tara-rig.ts +1562 -0
- package/client/three/tara.ts +76 -0
- package/client/three/tushar.ts +65 -0
- package/client/types.ts +109 -20
- package/client/vikram.ts +2 -0
- package/dist/AvatarClient.d.ts +89 -11
- package/dist/AvatarClient.d.ts.map +1 -1
- package/dist/AvatarClient.js +297 -35
- package/dist/AvatarClient.js.map +1 -1
- package/dist/arjun.d.ts +1 -0
- package/dist/arjun.d.ts.map +1 -1
- package/dist/arjun.js +2 -0
- package/dist/arjun.js.map +1 -1
- package/dist/createAvatar.d.ts +36 -0
- package/dist/createAvatar.d.ts.map +1 -1
- package/dist/createAvatar.js.map +1 -1
- package/dist/index.d.ts +6 -2
- package/dist/index.d.ts.map +1 -1
- package/dist/index.js +5 -1
- package/dist/index.js.map +1 -1
- package/dist/internal.d.ts +9 -5
- package/dist/internal.d.ts.map +1 -1
- package/dist/internal.js +13 -5
- package/dist/internal.js.map +1 -1
- package/dist/ishita.d.ts +1 -0
- package/dist/ishita.d.ts.map +1 -1
- package/dist/ishita.js +2 -0
- package/dist/ishita.js.map +1 -1
- package/dist/kabir.d.ts +1 -0
- package/dist/kabir.d.ts.map +1 -1
- package/dist/kabir.js +2 -0
- package/dist/kabir.js.map +1 -1
- package/dist/meera.d.ts +1 -0
- package/dist/meera.d.ts.map +1 -1
- package/dist/meera.js +2 -0
- package/dist/meera.js.map +1 -1
- package/dist/naina.d.ts +1 -0
- package/dist/naina.d.ts.map +1 -1
- package/dist/naina.js +2 -0
- package/dist/naina.js.map +1 -1
- package/dist/playout.d.ts +42 -0
- package/dist/playout.d.ts.map +1 -0
- package/dist/playout.js +85 -0
- package/dist/playout.js.map +1 -0
- package/dist/supports.d.ts +20 -0
- package/dist/supports.d.ts.map +1 -0
- package/dist/supports.js +26 -0
- package/dist/supports.js.map +1 -0
- package/dist/three/assets.d.ts +24 -0
- package/dist/three/assets.d.ts.map +1 -0
- package/dist/three/assets.js +22 -0
- package/dist/three/assets.js.map +1 -0
- package/dist/three/budgets.d.ts +17 -0
- package/dist/three/budgets.d.ts.map +1 -0
- package/dist/three/budgets.js +21 -0
- package/dist/three/budgets.js.map +1 -0
- package/dist/three/holds.d.ts +33 -0
- package/dist/three/holds.d.ts.map +1 -0
- package/dist/three/holds.js +56 -0
- package/dist/three/holds.js.map +1 -0
- package/dist/three/internal.d.ts +52 -0
- package/dist/three/internal.d.ts.map +1 -0
- package/dist/three/internal.js +49 -0
- package/dist/three/internal.js.map +1 -0
- package/dist/three/motion-limits.json +116 -0
- package/dist/three/sequences.d.ts +71 -0
- package/dist/three/sequences.d.ts.map +1 -0
- package/dist/three/sequences.js +262 -0
- package/dist/three/sequences.js.map +1 -0
- package/dist/three/tanya.d.ts +35 -0
- package/dist/three/tanya.d.ts.map +1 -0
- package/dist/three/tanya.js +51 -0
- package/dist/three/tanya.js.map +1 -0
- package/dist/three/tara-rig.d.ts +403 -0
- package/dist/three/tara-rig.d.ts.map +1 -0
- package/dist/three/tara-rig.js +1500 -0
- package/dist/three/tara-rig.js.map +1 -0
- package/dist/three/tara.d.ts +35 -0
- package/dist/three/tara.d.ts.map +1 -0
- package/dist/three/tara.js +58 -0
- package/dist/three/tara.js.map +1 -0
- package/dist/three/tushar.d.ts +31 -0
- package/dist/three/tushar.d.ts.map +1 -0
- package/dist/three/tushar.js +47 -0
- package/dist/three/tushar.js.map +1 -0
- package/dist/types.d.ts +65 -10
- package/dist/types.d.ts.map +1 -1
- package/dist/types.js +58 -11
- package/dist/types.js.map +1 -1
- package/dist/vikram.d.ts +1 -0
- package/dist/vikram.d.ts.map +1 -1
- package/dist/vikram.js +2 -0
- package/dist/vikram.js.map +1 -1
- package/package.json +34 -6
- package/src/avatar.d.ts +59 -2
- package/src/avatar.js +743 -94
- package/src/behavior.d.ts +28 -12
- package/src/behavior.js +54 -42
- package/src/canvas/create-rig.js +1 -1
- package/src/canvas/src/live.js +2 -2
- package/src/conformance.js +1 -1
- package/src/emotions.js +4 -2
- package/src/gaze.js +334 -73
- package/src/head.js +134 -0
- package/src/idle.js +210 -19
- package/src/interjections.js +70 -26
- package/src/prosody.js +647 -0
- package/src/visemes.js +85 -15
|
@@ -0,0 +1,396 @@
|
|
|
1
|
+
Attribution 4.0 International
|
|
2
|
+
|
|
3
|
+
=======================================================================
|
|
4
|
+
|
|
5
|
+
Creative Commons Corporation ("Creative Commons") is not a law firm and
|
|
6
|
+
does not provide legal services or legal advice. Distribution of
|
|
7
|
+
Creative Commons public licenses does not create a lawyer-client or
|
|
8
|
+
other relationship. Creative Commons makes its licenses and related
|
|
9
|
+
information available on an "as-is" basis. Creative Commons gives no
|
|
10
|
+
warranties regarding its licenses, any material licensed under their
|
|
11
|
+
terms and conditions, or any related information. Creative Commons
|
|
12
|
+
disclaims all liability for damages resulting from their use to the
|
|
13
|
+
fullest extent possible.
|
|
14
|
+
|
|
15
|
+
Using Creative Commons Public Licenses
|
|
16
|
+
|
|
17
|
+
Creative Commons public licenses provide a standard set of terms and
|
|
18
|
+
conditions that creators and other rights holders may use to share
|
|
19
|
+
original works of authorship and other material subject to copyright
|
|
20
|
+
and certain other rights specified in the public license below. The
|
|
21
|
+
following considerations are for informational purposes only, are not
|
|
22
|
+
exhaustive, and do not form part of our licenses.
|
|
23
|
+
|
|
24
|
+
Considerations for licensors: Our public licenses are
|
|
25
|
+
intended for use by those authorized to give the public
|
|
26
|
+
permission to use material in ways otherwise restricted by
|
|
27
|
+
copyright and certain other rights. Our licenses are
|
|
28
|
+
irrevocable. Licensors should read and understand the terms
|
|
29
|
+
and conditions of the license they choose before applying it.
|
|
30
|
+
Licensors should also secure all rights necessary before
|
|
31
|
+
applying our licenses so that the public can reuse the
|
|
32
|
+
material as expected. Licensors should clearly mark any
|
|
33
|
+
material not subject to the license. This includes other CC-
|
|
34
|
+
licensed material, or material used under an exception or
|
|
35
|
+
limitation to copyright. More considerations for licensors:
|
|
36
|
+
wiki.creativecommons.org/Considerations_for_licensors
|
|
37
|
+
|
|
38
|
+
Considerations for the public: By using one of our public
|
|
39
|
+
licenses, a licensor grants the public permission to use the
|
|
40
|
+
licensed material under specified terms and conditions. If
|
|
41
|
+
the licensor's permission is not necessary for any reason--for
|
|
42
|
+
example, because of any applicable exception or limitation to
|
|
43
|
+
copyright--then that use is not regulated by the license. Our
|
|
44
|
+
licenses grant only permissions under copyright and certain
|
|
45
|
+
other rights that a licensor has authority to grant. Use of
|
|
46
|
+
the licensed material may still be restricted for other
|
|
47
|
+
reasons, including because others have copyright or other
|
|
48
|
+
rights in the material. A licensor may make special requests,
|
|
49
|
+
such as asking that all changes be marked or described.
|
|
50
|
+
Although not required by our licenses, you are encouraged to
|
|
51
|
+
respect those requests where reasonable. More considerations
|
|
52
|
+
for the public:
|
|
53
|
+
wiki.creativecommons.org/Considerations_for_licensees
|
|
54
|
+
|
|
55
|
+
=======================================================================
|
|
56
|
+
|
|
57
|
+
Creative Commons Attribution 4.0 International Public License
|
|
58
|
+
|
|
59
|
+
By exercising the Licensed Rights (defined below), You accept and agree
|
|
60
|
+
to be bound by the terms and conditions of this Creative Commons
|
|
61
|
+
Attribution 4.0 International Public License ("Public License"). To the
|
|
62
|
+
extent this Public License may be interpreted as a contract, You are
|
|
63
|
+
granted the Licensed Rights in consideration of Your acceptance of
|
|
64
|
+
these terms and conditions, and the Licensor grants You such rights in
|
|
65
|
+
consideration of benefits the Licensor receives from making the
|
|
66
|
+
Licensed Material available under these terms and conditions.
|
|
67
|
+
|
|
68
|
+
|
|
69
|
+
Section 1 -- Definitions.
|
|
70
|
+
|
|
71
|
+
a. Adapted Material means material subject to Copyright and Similar
|
|
72
|
+
Rights that is derived from or based upon the Licensed Material
|
|
73
|
+
and in which the Licensed Material is translated, altered,
|
|
74
|
+
arranged, transformed, or otherwise modified in a manner requiring
|
|
75
|
+
permission under the Copyright and Similar Rights held by the
|
|
76
|
+
Licensor. For purposes of this Public License, where the Licensed
|
|
77
|
+
Material is a musical work, performance, or sound recording,
|
|
78
|
+
Adapted Material is always produced where the Licensed Material is
|
|
79
|
+
synched in timed relation with a moving image.
|
|
80
|
+
|
|
81
|
+
b. Adapter's License means the license You apply to Your Copyright
|
|
82
|
+
and Similar Rights in Your contributions to Adapted Material in
|
|
83
|
+
accordance with the terms and conditions of this Public License.
|
|
84
|
+
|
|
85
|
+
c. Copyright and Similar Rights means copyright and/or similar rights
|
|
86
|
+
closely related to copyright including, without limitation,
|
|
87
|
+
performance, broadcast, sound recording, and Sui Generis Database
|
|
88
|
+
Rights, without regard to how the rights are labeled or
|
|
89
|
+
categorized. For purposes of this Public License, the rights
|
|
90
|
+
specified in Section 2(b)(1)-(2) are not Copyright and Similar
|
|
91
|
+
Rights.
|
|
92
|
+
|
|
93
|
+
d. Effective Technological Measures means those measures that, in the
|
|
94
|
+
absence of proper authority, may not be circumvented under laws
|
|
95
|
+
fulfilling obligations under Article 11 of the WIPO Copyright
|
|
96
|
+
Treaty adopted on December 20, 1996, and/or similar international
|
|
97
|
+
agreements.
|
|
98
|
+
|
|
99
|
+
e. Exceptions and Limitations means fair use, fair dealing, and/or
|
|
100
|
+
any other exception or limitation to Copyright and Similar Rights
|
|
101
|
+
that applies to Your use of the Licensed Material.
|
|
102
|
+
|
|
103
|
+
f. Licensed Material means the artistic or literary work, database,
|
|
104
|
+
or other material to which the Licensor applied this Public
|
|
105
|
+
License.
|
|
106
|
+
|
|
107
|
+
g. Licensed Rights means the rights granted to You subject to the
|
|
108
|
+
terms and conditions of this Public License, which are limited to
|
|
109
|
+
all Copyright and Similar Rights that apply to Your use of the
|
|
110
|
+
Licensed Material and that the Licensor has authority to license.
|
|
111
|
+
|
|
112
|
+
h. Licensor means the individual(s) or entity(ies) granting rights
|
|
113
|
+
under this Public License.
|
|
114
|
+
|
|
115
|
+
i. Share means to provide material to the public by any means or
|
|
116
|
+
process that requires permission under the Licensed Rights, such
|
|
117
|
+
as reproduction, public display, public performance, distribution,
|
|
118
|
+
dissemination, communication, or importation, and to make material
|
|
119
|
+
available to the public including in ways that members of the
|
|
120
|
+
public may access the material from a place and at a time
|
|
121
|
+
individually chosen by them.
|
|
122
|
+
|
|
123
|
+
j. Sui Generis Database Rights means rights other than copyright
|
|
124
|
+
resulting from Directive 96/9/EC of the European Parliament and of
|
|
125
|
+
the Council of 11 March 1996 on the legal protection of databases,
|
|
126
|
+
as amended and/or succeeded, as well as other essentially
|
|
127
|
+
equivalent rights anywhere in the world.
|
|
128
|
+
|
|
129
|
+
k. You means the individual or entity exercising the Licensed Rights
|
|
130
|
+
under this Public License. Your has a corresponding meaning.
|
|
131
|
+
|
|
132
|
+
|
|
133
|
+
Section 2 -- Scope.
|
|
134
|
+
|
|
135
|
+
a. License grant.
|
|
136
|
+
|
|
137
|
+
1. Subject to the terms and conditions of this Public License,
|
|
138
|
+
the Licensor hereby grants You a worldwide, royalty-free,
|
|
139
|
+
non-sublicensable, non-exclusive, irrevocable license to
|
|
140
|
+
exercise the Licensed Rights in the Licensed Material to:
|
|
141
|
+
|
|
142
|
+
a. reproduce and Share the Licensed Material, in whole or
|
|
143
|
+
in part; and
|
|
144
|
+
|
|
145
|
+
b. produce, reproduce, and Share Adapted Material.
|
|
146
|
+
|
|
147
|
+
2. Exceptions and Limitations. For the avoidance of doubt, where
|
|
148
|
+
Exceptions and Limitations apply to Your use, this Public
|
|
149
|
+
License does not apply, and You do not need to comply with
|
|
150
|
+
its terms and conditions.
|
|
151
|
+
|
|
152
|
+
3. Term. The term of this Public License is specified in Section
|
|
153
|
+
6(a).
|
|
154
|
+
|
|
155
|
+
4. Media and formats; technical modifications allowed. The
|
|
156
|
+
Licensor authorizes You to exercise the Licensed Rights in
|
|
157
|
+
all media and formats whether now known or hereafter created,
|
|
158
|
+
and to make technical modifications necessary to do so. The
|
|
159
|
+
Licensor waives and/or agrees not to assert any right or
|
|
160
|
+
authority to forbid You from making technical modifications
|
|
161
|
+
necessary to exercise the Licensed Rights, including
|
|
162
|
+
technical modifications necessary to circumvent Effective
|
|
163
|
+
Technological Measures. For purposes of this Public License,
|
|
164
|
+
simply making modifications authorized by this Section 2(a)
|
|
165
|
+
(4) never produces Adapted Material.
|
|
166
|
+
|
|
167
|
+
5. Downstream recipients.
|
|
168
|
+
|
|
169
|
+
a. Offer from the Licensor -- Licensed Material. Every
|
|
170
|
+
recipient of the Licensed Material automatically
|
|
171
|
+
receives an offer from the Licensor to exercise the
|
|
172
|
+
Licensed Rights under the terms and conditions of this
|
|
173
|
+
Public License.
|
|
174
|
+
|
|
175
|
+
b. No downstream restrictions. You may not offer or impose
|
|
176
|
+
any additional or different terms or conditions on, or
|
|
177
|
+
apply any Effective Technological Measures to, the
|
|
178
|
+
Licensed Material if doing so restricts exercise of the
|
|
179
|
+
Licensed Rights by any recipient of the Licensed
|
|
180
|
+
Material.
|
|
181
|
+
|
|
182
|
+
6. No endorsement. Nothing in this Public License constitutes or
|
|
183
|
+
may be construed as permission to assert or imply that You
|
|
184
|
+
are, or that Your use of the Licensed Material is, connected
|
|
185
|
+
with, or sponsored, endorsed, or granted official status by,
|
|
186
|
+
the Licensor or others designated to receive attribution as
|
|
187
|
+
provided in Section 3(a)(1)(A)(i).
|
|
188
|
+
|
|
189
|
+
b. Other rights.
|
|
190
|
+
|
|
191
|
+
1. Moral rights, such as the right of integrity, are not
|
|
192
|
+
licensed under this Public License, nor are publicity,
|
|
193
|
+
privacy, and/or other similar personality rights; however, to
|
|
194
|
+
the extent possible, the Licensor waives and/or agrees not to
|
|
195
|
+
assert any such rights held by the Licensor to the limited
|
|
196
|
+
extent necessary to allow You to exercise the Licensed
|
|
197
|
+
Rights, but not otherwise.
|
|
198
|
+
|
|
199
|
+
2. Patent and trademark rights are not licensed under this
|
|
200
|
+
Public License.
|
|
201
|
+
|
|
202
|
+
3. To the extent possible, the Licensor waives any right to
|
|
203
|
+
collect royalties from You for the exercise of the Licensed
|
|
204
|
+
Rights, whether directly or through a collecting society
|
|
205
|
+
under any voluntary or waivable statutory or compulsory
|
|
206
|
+
licensing scheme. In all other cases the Licensor expressly
|
|
207
|
+
reserves any right to collect such royalties.
|
|
208
|
+
|
|
209
|
+
|
|
210
|
+
Section 3 -- License Conditions.
|
|
211
|
+
|
|
212
|
+
Your exercise of the Licensed Rights is expressly made subject to the
|
|
213
|
+
following conditions.
|
|
214
|
+
|
|
215
|
+
a. Attribution.
|
|
216
|
+
|
|
217
|
+
1. If You Share the Licensed Material (including in modified
|
|
218
|
+
form), You must:
|
|
219
|
+
|
|
220
|
+
a. retain the following if it is supplied by the Licensor
|
|
221
|
+
with the Licensed Material:
|
|
222
|
+
|
|
223
|
+
i. identification of the creator(s) of the Licensed
|
|
224
|
+
Material and any others designated to receive
|
|
225
|
+
attribution, in any reasonable manner requested by
|
|
226
|
+
the Licensor (including by pseudonym if
|
|
227
|
+
designated);
|
|
228
|
+
|
|
229
|
+
ii. a copyright notice;
|
|
230
|
+
|
|
231
|
+
iii. a notice that refers to this Public License;
|
|
232
|
+
|
|
233
|
+
iv. a notice that refers to the disclaimer of
|
|
234
|
+
warranties;
|
|
235
|
+
|
|
236
|
+
v. a URI or hyperlink to the Licensed Material to the
|
|
237
|
+
extent reasonably practicable;
|
|
238
|
+
|
|
239
|
+
b. indicate if You modified the Licensed Material and
|
|
240
|
+
retain an indication of any previous modifications; and
|
|
241
|
+
|
|
242
|
+
c. indicate the Licensed Material is licensed under this
|
|
243
|
+
Public License, and include the text of, or the URI or
|
|
244
|
+
hyperlink to, this Public License.
|
|
245
|
+
|
|
246
|
+
2. You may satisfy the conditions in Section 3(a)(1) in any
|
|
247
|
+
reasonable manner based on the medium, means, and context in
|
|
248
|
+
which You Share the Licensed Material. For example, it may be
|
|
249
|
+
reasonable to satisfy the conditions by providing a URI or
|
|
250
|
+
hyperlink to a resource that includes the required
|
|
251
|
+
information.
|
|
252
|
+
|
|
253
|
+
3. If requested by the Licensor, You must remove any of the
|
|
254
|
+
information required by Section 3(a)(1)(A) to the extent
|
|
255
|
+
reasonably practicable.
|
|
256
|
+
|
|
257
|
+
4. If You Share Adapted Material You produce, the Adapter's
|
|
258
|
+
License You apply must not prevent recipients of the Adapted
|
|
259
|
+
Material from complying with this Public License.
|
|
260
|
+
|
|
261
|
+
|
|
262
|
+
Section 4 -- Sui Generis Database Rights.
|
|
263
|
+
|
|
264
|
+
Where the Licensed Rights include Sui Generis Database Rights that
|
|
265
|
+
apply to Your use of the Licensed Material:
|
|
266
|
+
|
|
267
|
+
a. for the avoidance of doubt, Section 2(a)(1) grants You the right
|
|
268
|
+
to extract, reuse, reproduce, and Share all or a substantial
|
|
269
|
+
portion of the contents of the database;
|
|
270
|
+
|
|
271
|
+
b. if You include all or a substantial portion of the database
|
|
272
|
+
contents in a database in which You have Sui Generis Database
|
|
273
|
+
Rights, then the database in which You have Sui Generis Database
|
|
274
|
+
Rights (but not its individual contents) is Adapted Material; and
|
|
275
|
+
|
|
276
|
+
c. You must comply with the conditions in Section 3(a) if You Share
|
|
277
|
+
all or a substantial portion of the contents of the database.
|
|
278
|
+
|
|
279
|
+
For the avoidance of doubt, this Section 4 supplements and does not
|
|
280
|
+
replace Your obligations under this Public License where the Licensed
|
|
281
|
+
Rights include other Copyright and Similar Rights.
|
|
282
|
+
|
|
283
|
+
|
|
284
|
+
Section 5 -- Disclaimer of Warranties and Limitation of Liability.
|
|
285
|
+
|
|
286
|
+
a. UNLESS OTHERWISE SEPARATELY UNDERTAKEN BY THE LICENSOR, TO THE
|
|
287
|
+
EXTENT POSSIBLE, THE LICENSOR OFFERS THE LICENSED MATERIAL AS-IS
|
|
288
|
+
AND AS-AVAILABLE, AND MAKES NO REPRESENTATIONS OR WARRANTIES OF
|
|
289
|
+
ANY KIND CONCERNING THE LICENSED MATERIAL, WHETHER EXPRESS,
|
|
290
|
+
IMPLIED, STATUTORY, OR OTHER. THIS INCLUDES, WITHOUT LIMITATION,
|
|
291
|
+
WARRANTIES OF TITLE, MERCHANTABILITY, FITNESS FOR A PARTICULAR
|
|
292
|
+
PURPOSE, NON-INFRINGEMENT, ABSENCE OF LATENT OR OTHER DEFECTS,
|
|
293
|
+
ACCURACY, OR THE PRESENCE OR ABSENCE OF ERRORS, WHETHER OR NOT
|
|
294
|
+
KNOWN OR DISCOVERABLE. WHERE DISCLAIMERS OF WARRANTIES ARE NOT
|
|
295
|
+
ALLOWED IN FULL OR IN PART, THIS DISCLAIMER MAY NOT APPLY TO YOU.
|
|
296
|
+
|
|
297
|
+
b. TO THE EXTENT POSSIBLE, IN NO EVENT WILL THE LICENSOR BE LIABLE
|
|
298
|
+
TO YOU ON ANY LEGAL THEORY (INCLUDING, WITHOUT LIMITATION,
|
|
299
|
+
NEGLIGENCE) OR OTHERWISE FOR ANY DIRECT, SPECIAL, INDIRECT,
|
|
300
|
+
INCIDENTAL, CONSEQUENTIAL, PUNITIVE, EXEMPLARY, OR OTHER LOSSES,
|
|
301
|
+
COSTS, EXPENSES, OR DAMAGES ARISING OUT OF THIS PUBLIC LICENSE OR
|
|
302
|
+
USE OF THE LICENSED MATERIAL, EVEN IF THE LICENSOR HAS BEEN
|
|
303
|
+
ADVISED OF THE POSSIBILITY OF SUCH LOSSES, COSTS, EXPENSES, OR
|
|
304
|
+
DAMAGES. WHERE A LIMITATION OF LIABILITY IS NOT ALLOWED IN FULL OR
|
|
305
|
+
IN PART, THIS LIMITATION MAY NOT APPLY TO YOU.
|
|
306
|
+
|
|
307
|
+
c. The disclaimer of warranties and limitation of liability provided
|
|
308
|
+
above shall be interpreted in a manner that, to the extent
|
|
309
|
+
possible, most closely approximates an absolute disclaimer and
|
|
310
|
+
waiver of all liability.
|
|
311
|
+
|
|
312
|
+
|
|
313
|
+
Section 6 -- Term and Termination.
|
|
314
|
+
|
|
315
|
+
a. This Public License applies for the term of the Copyright and
|
|
316
|
+
Similar Rights licensed here. However, if You fail to comply with
|
|
317
|
+
this Public License, then Your rights under this Public License
|
|
318
|
+
terminate automatically.
|
|
319
|
+
|
|
320
|
+
b. Where Your right to use the Licensed Material has terminated under
|
|
321
|
+
Section 6(a), it reinstates:
|
|
322
|
+
|
|
323
|
+
1. automatically as of the date the violation is cured, provided
|
|
324
|
+
it is cured within 30 days of Your discovery of the
|
|
325
|
+
violation; or
|
|
326
|
+
|
|
327
|
+
2. upon express reinstatement by the Licensor.
|
|
328
|
+
|
|
329
|
+
For the avoidance of doubt, this Section 6(b) does not affect any
|
|
330
|
+
right the Licensor may have to seek remedies for Your violations
|
|
331
|
+
of this Public License.
|
|
332
|
+
|
|
333
|
+
c. For the avoidance of doubt, the Licensor may also offer the
|
|
334
|
+
Licensed Material under separate terms or conditions or stop
|
|
335
|
+
distributing the Licensed Material at any time; however, doing so
|
|
336
|
+
will not terminate this Public License.
|
|
337
|
+
|
|
338
|
+
d. Sections 1, 5, 6, 7, and 8 survive termination of this Public
|
|
339
|
+
License.
|
|
340
|
+
|
|
341
|
+
|
|
342
|
+
Section 7 -- Other Terms and Conditions.
|
|
343
|
+
|
|
344
|
+
a. The Licensor shall not be bound by any additional or different
|
|
345
|
+
terms or conditions communicated by You unless expressly agreed.
|
|
346
|
+
|
|
347
|
+
b. Any arrangements, understandings, or agreements regarding the
|
|
348
|
+
Licensed Material not stated herein are separate from and
|
|
349
|
+
independent of the terms and conditions of this Public License.
|
|
350
|
+
|
|
351
|
+
|
|
352
|
+
Section 8 -- Interpretation.
|
|
353
|
+
|
|
354
|
+
a. For the avoidance of doubt, this Public License does not, and
|
|
355
|
+
shall not be interpreted to, reduce, limit, restrict, or impose
|
|
356
|
+
conditions on any use of the Licensed Material that could lawfully
|
|
357
|
+
be made without permission under this Public License.
|
|
358
|
+
|
|
359
|
+
b. To the extent possible, if any provision of this Public License is
|
|
360
|
+
deemed unenforceable, it shall be automatically reformed to the
|
|
361
|
+
minimum extent necessary to make it enforceable. If the provision
|
|
362
|
+
cannot be reformed, it shall be severed from this Public License
|
|
363
|
+
without affecting the enforceability of the remaining terms and
|
|
364
|
+
conditions.
|
|
365
|
+
|
|
366
|
+
c. No term or condition of this Public License will be waived and no
|
|
367
|
+
failure to comply consented to unless expressly agreed to by the
|
|
368
|
+
Licensor.
|
|
369
|
+
|
|
370
|
+
d. Nothing in this Public License constitutes or may be interpreted
|
|
371
|
+
as a limitation upon, or waiver of, any privileges and immunities
|
|
372
|
+
that apply to the Licensor or You, including from the legal
|
|
373
|
+
processes of any jurisdiction or authority.
|
|
374
|
+
|
|
375
|
+
|
|
376
|
+
=======================================================================
|
|
377
|
+
|
|
378
|
+
Creative Commons is not a party to its public
|
|
379
|
+
licenses. Notwithstanding, Creative Commons may elect to apply one of
|
|
380
|
+
its public licenses to material it publishes and in those instances
|
|
381
|
+
will be considered the “Licensor.” The text of the Creative Commons
|
|
382
|
+
public licenses is dedicated to the public domain under the CC0 Public
|
|
383
|
+
Domain Dedication. Except for the limited purpose of indicating that
|
|
384
|
+
material is shared under a Creative Commons public license or as
|
|
385
|
+
otherwise permitted by the Creative Commons policies published at
|
|
386
|
+
creativecommons.org/policies, Creative Commons does not authorize the
|
|
387
|
+
use of the trademark "Creative Commons" or any other trademark or logo
|
|
388
|
+
of Creative Commons without its prior written consent including,
|
|
389
|
+
without limitation, in connection with any unauthorized modifications
|
|
390
|
+
to any of its public licenses or any other arrangements,
|
|
391
|
+
understandings, or agreements concerning use of licensed material. For
|
|
392
|
+
the avoidance of doubt, this paragraph does not form part of the
|
|
393
|
+
public licenses.
|
|
394
|
+
|
|
395
|
+
Creative Commons may be contacted at creativecommons.org.
|
|
396
|
+
|
package/README.md
CHANGED
|
@@ -5,17 +5,22 @@ avatars are lip-synced to the audio and they are state aware: they know when
|
|
|
5
5
|
they have been interrupted, when the user is talking versus idle, when a tool
|
|
6
6
|
call has started and stopped.
|
|
7
7
|
|
|
8
|
-
No video track, no per-minute avatar vendor, no second media path.
|
|
9
|
-
|
|
10
|
-
entry point, so you pay for the one you import
|
|
8
|
+
No video track, no per-minute avatar vendor, no second media path. Twelve
|
|
9
|
+
avatars ship with it — three SVG faces, six professional Canvas2D identities and
|
|
10
|
+
three 2.5-D characters — one per entry point, so you pay for the one you import,
|
|
11
|
+
and you can author your own.
|
|
11
12
|
|
|
12
13
|
This is the browser half. The pipeline half is
|
|
13
14
|
[`voqalize-avatar`](https://pypi.org/project/voqalize-avatar/) on PyPI; they are
|
|
14
|
-
two ends of one wire format and
|
|
15
|
-
|
|
16
|
-
|
|
15
|
+
two ends of one wire format and release independently, kept compatible by the
|
|
16
|
+
wire contract rather than a shared version number
|
|
17
|
+
([RELEASING.md § Compatibility](https://github.com/voqalize/avatar/blob/main/RELEASING.md#compatibility)).
|
|
17
18
|
|
|
18
|
-
**Licence: MIT
|
|
19
|
+
**Licence: MIT for the code, CC-BY 4.0 for the three 2.5-D character binaries**
|
|
20
|
+
(`assets/*.glb`, the artwork — see `assets/README.md` for the credit line). The
|
|
21
|
+
code is usable anywhere, including in closed-source products; the characters ask
|
|
22
|
+
for attribution and nothing else. The manifest declares the pair as
|
|
23
|
+
`MIT AND CC-BY-4.0`.
|
|
19
24
|
|
|
20
25
|
## Install
|
|
21
26
|
|
|
@@ -72,7 +77,7 @@ Most of the avatar works on any pipecat application without customization — no
|
|
|
72
77
|
because integrations were enumerated, but because the behaviour is derived from
|
|
73
78
|
frames and events a pipecat pipeline already emits. `SPEAKING`, `LISTENING`,
|
|
74
79
|
`MUTED`, `OFFLINE` and `DEGRADED` come from your `PipecatClient` with no backend
|
|
75
|
-
involvement at all; `THINKING`, `WORKING` and `
|
|
80
|
+
involvement at all; `THINKING`, `WORKING` and `CANT_HEAR` come from
|
|
76
81
|
`AvatarProcessor` watching turn boundaries, LLM response boundaries and
|
|
77
82
|
function-call frames; lipsync comes from the same karaoke frames pipecat already
|
|
78
83
|
pushes for word-level captions; blink, breath, gaze aversion and idle motion are
|
|
@@ -91,17 +96,18 @@ Three commands, one envelope
|
|
|
91
96
|
([contract-wire.md](https://github.com/voqalize/avatar/blob/main/docs/contract-wire.md)):
|
|
92
97
|
|
|
93
98
|
```json
|
|
94
|
-
{ "type": "avatar", "cmd": "
|
|
95
|
-
{ "type": "avatar", "cmd": "action", "id": "
|
|
99
|
+
{ "type": "avatar", "cmd": "state", "state": "WORKING" }
|
|
100
|
+
{ "type": "avatar", "cmd": "action", "id": "ACKNOWLEDGE" }
|
|
96
101
|
{ "type": "avatar", "cmd": "cues", "ctx": "tts-context", "from_ms": 0, "cues": [] }
|
|
97
102
|
```
|
|
98
103
|
|
|
99
104
|
**States are durable and they are prioritised.** A state holds until the facts
|
|
100
105
|
change; it does not complete on a timer. **The state pipecat reports always
|
|
101
106
|
wins** — bot-output lifecycle and user speech are observed Pipecat facts, and a
|
|
102
|
-
server
|
|
103
|
-
|
|
104
|
-
are finite, they complete on their own, and they never establish
|
|
107
|
+
state the server sends is a *candidate* underneath them. **Actions are
|
|
108
|
+
point-in-time animations** that land on top of whatever state is effective at
|
|
109
|
+
the time; they are finite, they complete on their own, and they never establish
|
|
110
|
+
state.
|
|
105
111
|
|
|
106
112
|
Emission is overwrite, never merge: a `cues` message says "discard everything
|
|
107
113
|
queued at or after `from_ms`, then append these". The server decides; the client
|
|
@@ -167,6 +173,34 @@ as the SVG avatars. Their private renderer is Canvas2D; its rig data and bitmap
|
|
|
167
173
|
wardrobe assets are implementation details and no Canvas or pose API is added
|
|
168
174
|
to the package surface.
|
|
169
175
|
|
|
176
|
+
## The 2.5-D characters
|
|
177
|
+
|
|
178
|
+
Three characters ship as compiled binaries, each its own `createAvatar` module:
|
|
179
|
+
|
|
180
|
+
```js
|
|
181
|
+
import { createAvatar } from '@voqalize/avatar/avatars/tara';
|
|
182
|
+
// or: @voqalize/avatar/avatars/tushar
|
|
183
|
+
// @voqalize/avatar/avatars/tanya
|
|
184
|
+
|
|
185
|
+
const avatar = createAvatar({ mount, client: pipecatClient });
|
|
186
|
+
```
|
|
187
|
+
|
|
188
|
+
A photograph of a face projected onto shallow geometry, with the parts that have
|
|
189
|
+
to move — eyes, teeth, the lip line — built as geometry rather than painted.
|
|
190
|
+
Three.js is an *optional* peer (`three`, `>=0.180 <0.187`) behind these three
|
|
191
|
+
entry points only, so an SVG or Canvas consumer never downloads it, and the `.glb`
|
|
192
|
+
is fetched when the avatar mounts.
|
|
193
|
+
|
|
194
|
+
Nothing above the renderer changes: the same wire, the same states, the same
|
|
195
|
+
cue-synced mouth, and a server that has never heard of these characters drives one
|
|
196
|
+
correctly. The head turns 15° of yaw and 24° of pitch, which is a measured limit
|
|
197
|
+
rather than an option.
|
|
198
|
+
|
|
199
|
+
**The three binaries are artwork under CC-BY 4.0**, separately from the MIT code
|
|
200
|
+
around them; the credit line is in `assets/README.md`. Mounting, sizing, the asset
|
|
201
|
+
budget and what the characters can be asked to do:
|
|
202
|
+
[characters.md](https://github.com/voqalize/avatar/blob/main/docs/characters.md).
|
|
203
|
+
|
|
170
204
|
## Shipping your own avatar
|
|
171
205
|
|
|
172
206
|
A whole different rendering technology is not a face; it is a different
|
|
@@ -182,6 +216,13 @@ actions and cues are all an avatar is ever told. `VisemeTrack` in
|
|
|
182
216
|
`@voqalize/avatar/internal` turns a cue array plus a clock into the mouth shape
|
|
183
217
|
for the current frame; every renderer needs that and none should write it twice.
|
|
184
218
|
|
|
219
|
+
An implementation may also export `supports` — one object naming the action ids
|
|
220
|
+
it answers to. Nothing in the library reads it; it is there because the wire's
|
|
221
|
+
action id is open and an unknown one is ignored in silence, so a page that
|
|
222
|
+
drives an avatar otherwise cannot tell a face that has no such motion from one
|
|
223
|
+
that did nothing ([design-avatar-interface.md](https://github.com/voqalize/avatar/blob/main/docs/design-avatar-interface.md)).
|
|
224
|
+
Omitting it is conforming.
|
|
225
|
+
|
|
185
226
|
**There is deliberately no renderer interface.** The pose channels our SVG mixer
|
|
186
227
|
uses to talk to our faces are internal, and a second public contract stays
|
|
187
228
|
premature until a second renderer says what it needs.
|
|
@@ -193,7 +234,8 @@ React binding. `src/` is the widget itself: the mixer, the SVG rig and drawings,
|
|
|
193
234
|
plus the private Canvas2D interviewer rigs and their assets, as dependency-free
|
|
194
235
|
ES modules with no build step, imported by `dist/` through ordinary relative
|
|
195
236
|
paths. `client/` is the TypeScript those `dist/` files were compiled from, so
|
|
196
|
-
the source maps resolve.
|
|
237
|
+
the source maps resolve. `assets/` is the three compiled characters and their
|
|
238
|
+
licence note — the only non-JavaScript thing here, fetched at runtime by URL.
|
|
197
239
|
|
|
198
240
|
The contract documents do not ship here. They live in the repository, which is
|
|
199
241
|
where they are kept current:
|
|
@@ -201,8 +243,14 @@ where they are kept current:
|
|
|
201
243
|
|
|
202
244
|
## License
|
|
203
245
|
|
|
204
|
-
**MIT
|
|
205
|
-
|
|
206
|
-
|
|
246
|
+
**MIT for the code, CC-BY 4.0 for the artwork**, and Voqalize holds the
|
|
247
|
+
copyright on all of it. The manifest declares the pair as `MIT AND CC-BY-4.0`;
|
|
248
|
+
the artwork is `assets/*.glb`, the three 2.5-D characters, and `assets/README.md`
|
|
249
|
+
carries the credit line. Everything else in the tarball is MIT, usable anywhere
|
|
250
|
+
including in closed-source products.
|
|
251
|
+
|
|
252
|
+
The drawing idiom `peep` is authored in is
|
|
253
|
+
[Open Peeps](https://www.openpeeps.com/) (CC0) — no artwork is copied. The
|
|
254
|
+
`avatarsync` aligner that produces the mouth shapes is a fork of
|
|
207
255
|
[Rhubarb Lip Sync](https://github.com/DanielSWolf/rhubarb-lip-sync) (MIT) and
|
|
208
256
|
ships in the Python package, not this one.
|
package/assets/README.md
ADDED
|
@@ -0,0 +1,48 @@
|
|
|
1
|
+
# The character binaries
|
|
2
|
+
|
|
3
|
+
Three 2.5-D characters, one compiled file each:
|
|
4
|
+
|
|
5
|
+
| file | character | what it is |
|
|
6
|
+
|---|---|---|
|
|
7
|
+
| `tara.glb` | tara | the first; shallow geometry under a projected portrait |
|
|
8
|
+
| `tushar.glb` | tushar | the second, her scripts with his landmarks |
|
|
9
|
+
| `tanya.glb` | tanya | the third, built from supplied reference images |
|
|
10
|
+
|
|
11
|
+
They are loaded for you. `@voqalize/avatar/avatars/tara` resolves the file beside
|
|
12
|
+
itself and hands it to a loader; you never name a path, and the only reason to
|
|
13
|
+
know these are here is the licence below. `three` is an *optional* peer of this
|
|
14
|
+
package, so importing a drawing instead of a character downloads none of this.
|
|
15
|
+
|
|
16
|
+
Each file carries geometry, one morph target per pose channel, and its texture
|
|
17
|
+
atlases as WebP — which is most of the bytes, because the atlases are
|
|
18
|
+
photographs. **They are build outputs. Do not hand-edit one**; there is nothing
|
|
19
|
+
in this directory to regenerate it from, and the next release overwrites it.
|
|
20
|
+
|
|
21
|
+
## Licence: CC-BY 4.0
|
|
22
|
+
|
|
23
|
+
The rest of this package is MIT. These three files are artwork, not code, so they
|
|
24
|
+
carry an artwork licence: **Creative Commons Attribution 4.0 International**, the
|
|
25
|
+
full text in `LICENSE-CC-BY-4.0` at the package root. Use them in a product,
|
|
26
|
+
commercially, modified or retextured, and credit us:
|
|
27
|
+
|
|
28
|
+
> Character art © 2026 Voqalize, CC-BY 4.0.
|
|
29
|
+
|
|
30
|
+
That is the whole obligation. There is no non-commercial clause, no
|
|
31
|
+
no-derivatives clause — the renderer's entire job is deforming these meshes, so a
|
|
32
|
+
no-derivatives licence would forbid the only use there is — and no share-alike, so
|
|
33
|
+
retexturing a character does not oblige you to publish the result.
|
|
34
|
+
|
|
35
|
+
The licence is also written inside each file, in the glTF copyright field. A
|
|
36
|
+
binary gets copied out of a dependency tree and passed around; a string in the
|
|
37
|
+
file is the only way terms travel with it.
|
|
38
|
+
|
|
39
|
+
## The faces are synthetic
|
|
40
|
+
|
|
41
|
+
Every character began as an image from a generative model — OpenAI's and
|
|
42
|
+
Google's — and **none of them depicts a real person**. Any resemblance to one is
|
|
43
|
+
coincidence, not a likeness, and there are no personality rights attached to any
|
|
44
|
+
of these three. What we did with that image is ours: the geometry, the measured
|
|
45
|
+
landmarks, the projection, the relighting and the authored morph targets are all
|
|
46
|
+
human work, and they are the substance of what is licensed here.
|
|
47
|
+
|
|
48
|
+
The tooling that turns a portrait into one of these files is not published.
|
package/assets/tanya.glb
ADDED
|
Binary file
|
package/assets/tara.glb
ADDED
|
Binary file
|
|
Binary file
|