metaverse-avatar 0.1.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.
Files changed (46) hide show
  1. package/ASSET_LICENSES.md +122 -0
  2. package/Avatar.js +860 -0
  3. package/LICENSE.md +21 -0
  4. package/README.md +407 -0
  5. package/anims/UAL1_Standard.glb +0 -0
  6. package/anims/UAL2_Standard.glb +0 -0
  7. package/anims/pirouette.bvh +867 -0
  8. package/attachments.js +388 -0
  9. package/avatarManager.js +110 -0
  10. package/blink.js +58 -0
  11. package/bvh.js +110 -0
  12. package/gltfAnim.js +271 -0
  13. package/index.js +61 -0
  14. package/licenses/AGPL-3.0.txt +661 -0
  15. package/models/body.glb +0 -0
  16. package/models/eyes.glb +0 -0
  17. package/models/feet.glb +0 -0
  18. package/models/hands.glb +0 -0
  19. package/models/head.glb +0 -0
  20. package/models/textures/android_face.png +0 -0
  21. package/models/textures/android_face_ao.jpg +0 -0
  22. package/models/textures/android_face_metallic.jpg +0 -0
  23. package/models/textures/android_face_normal.jpg +0 -0
  24. package/models/textures/android_face_roughness.jpg +0 -0
  25. package/models/textures/android_lower.png +0 -0
  26. package/models/textures/android_lower_ao.jpg +0 -0
  27. package/models/textures/android_lower_metallic.jpg +0 -0
  28. package/models/textures/android_lower_normal.jpg +0 -0
  29. package/models/textures/android_lower_roughness.jpg +0 -0
  30. package/models/textures/android_upper.png +0 -0
  31. package/models/textures/android_upper_ao.jpg +0 -0
  32. package/models/textures/android_upper_metallic.jpg +0 -0
  33. package/models/textures/android_upper_normal.jpg +0 -0
  34. package/models/textures/android_upper_roughness.jpg +0 -0
  35. package/models/textures/blue_eyes.png +0 -0
  36. package/models/textures/layers/cute_pants.png +0 -0
  37. package/models/textures/layers/cute_shirt.png +0 -0
  38. package/nipple.js +218 -0
  39. package/package.json +48 -0
  40. package/pbr.js +225 -0
  41. package/physics.js +313 -0
  42. package/skeleton.js +70 -0
  43. package/sliders.js +590 -0
  44. package/speech.js +130 -0
  45. package/visemes.js +66 -0
  46. package/voice.js +75 -0
@@ -0,0 +1,122 @@
1
+ # Model licenses
2
+
3
+ This project bundles the Ruth2 avatar meshes from the
4
+ [RuthAndRoth](https://github.com/RuthAndRoth) open-source avatar project. The
5
+ bundled `models/*.glb` files are **format conversions** of Ruth's original
6
+ Collada (`.dae`) meshes — converting the file format does **not** change the
7
+ license: they remain **AGPL-3.0**, the same license as the original Ruth
8
+ project, and are derivative works of it. Upstream license texts are in
9
+ [`licenses/`](licenses/).
10
+
11
+ The library code (`*.js`) and all bundled textures in `models/textures/` are
12
+ licensed under [LICENSE.md](LICENSE.md) (MIT). The AGPL mesh obligations apply
13
+ to the bundled `.glb` mesh files (and anything you derive from them) when you
14
+ distribute them.
15
+
16
+ The Textures tab still accepts user-supplied maps via drop zones; anything
17
+ you add at runtime is your own responsibility.
18
+
19
+ ## Bundled textures
20
+
21
+ All files under `models/textures/` are original to this project (not from the
22
+ Ruth `.dae` exports) and are covered by the project's [MIT license](LICENSE.md).
23
+
24
+ | Region / use | Files |
25
+ |---|---|
26
+ | Face (albedo + PBR) | `android_face.png`, `android_face_normal.jpg`, `android_face_roughness.jpg`, `android_face_metallic.jpg`, `android_face_ao.jpg` |
27
+ | Upper body (albedo + PBR) | `android_upper.png`, `android_upper_normal.jpg`, `android_upper_roughness.jpg`, `android_upper_metallic.jpg`, `android_upper_ao.jpg` |
28
+ | Lower body (albedo + PBR) | `android_lower.png`, `android_lower_normal.jpg`, `android_lower_roughness.jpg`, `android_lower_metallic.jpg`, `android_lower_ao.jpg` |
29
+ | Eyes (albedo) | `blue_eyes.png` |
30
+ | Optional clothing layers | `layers/cute_shirt.png`, `layers/cute_pants.png` |
31
+
32
+ ## Bundled meshes
33
+
34
+ Each `.glb` below is a format conversion (via Blender) of the corresponding
35
+ original Ruth Collada `.dae`. They are derivative works of the AGPL-3.0 Ruth
36
+ meshes and stay under **AGPL-3.0** — converting the format changes nothing about
37
+ the license.
38
+
39
+ | File in this repo | Upstream source | License |
40
+ |---|---|---|
41
+ | `models/body.glb` | Ruth RC3 `Release3_BothLowerUpper_15.dae` (converted) | AGPL-3.0 |
42
+ | `models/hands.glb` | Ruth RC3 `Release3_Hands_15.dae` (converted) | AGPL-3.0 |
43
+ | `models/feet.glb` | Ruth RC3 `Release3_FlatFeet_15.dae` (converted) | AGPL-3.0 |
44
+ | `models/head.glb` | [Ruth2](https://github.com/RuthAndRoth/Ruth2) `Mesh/Ruth2_v4/DAE/Ruth2v4Head.dae` (converted) | AGPL-3.0 |
45
+ | `models/eyes.glb` | Ruth2 `Mesh/Ruth2_v4/DAE/Ruth2v4Eyeballs.dae` (converted) | AGPL-3.0 |
46
+
47
+ RC3 meshes are from the Ruth 2.0 RC#3 release
48
+ (`archive-ruth-rc3` branch of [RuthAndRoth/Ruth](https://github.com/RuthAndRoth/Ruth),
49
+ also packaged in Ruth2 `Mesh/Ruth2_v3/`). The v4 head and eyeballs are from
50
+ Ada Radius's Ruth2 v4 work in the Ruth2 repo; RC3 did not ship a head.
51
+
52
+ ## Bundled animations
53
+
54
+ | File in this repo | Source | License |
55
+ |---|---|---|
56
+ | `anims/pirouette.bvh` | [three.js examples](https://github.com/mrdoob/three.js/blob/master/examples/models/bvh/pirouette.bvh) (CMU mocap conversion) | MIT (three.js) + [CMU mocap terms](https://mocap.cs.cmu.edu/) |
57
+ | `anims/UAL1_Standard.glb` | [Quaternius Ultimate Animated Character](https://quaternius.com/packs/ultimateanimatedcharacter.html) | [CC0 1.0 Universal](https://creativecommons.org/publicdomain/zero/1.0/) |
58
+ | `anims/UAL2_Standard.glb` | [Quaternius Universal Animation Library 2](https://quaternius.com/packs/universalanimationlibrary2.html) | [CC0 1.0 Universal](https://creativecommons.org/publicdomain/zero/1.0/) |
59
+
60
+ `pirouette.bvh` is copied from the three.js example assets (MIT-licensed
61
+ distribution of a BVH converted from the CMU Graphics Lab Motion Capture
62
+ Database). Play-mode locomotion and most bundled clips are retargeted from the
63
+ Quaternius UAL1 and UAL2 GLB libraries (CC0).
64
+
65
+ ### pirouette.bvh
66
+
67
+ Bundled copy:
68
+ [`examples/models/bvh/pirouette.bvh`](https://github.com/mrdoob/three.js/blob/master/examples/models/bvh/pirouette.bvh)
69
+ in the [three.js](https://github.com/mrdoob/three.js) repo (MIT). The underlying
70
+ motion data is from the
71
+ [CMU Graphics Lab Motion Capture Database](https://mocap.cs.cmu.edu/) (research /
72
+ commercial use permitted; cite the database when publishing results).
73
+
74
+ ### UAL1 animation bundle
75
+
76
+ The [Quaternius Ultimate Animated Character](https://quaternius.com/animviewer.html)
77
+ (UAC, file `UAL1_Standard.glb`) contains 45 glTF skeleton animations — idle,
78
+ walk, crouch, combat, swimming, sitting, and more — created by [@Quaternius](https://twitter.com/quaternius).
79
+ It is dedicated to the public domain under [CC0 1.0](https://creativecommons.org/publicdomain/zero/1.0/).
80
+
81
+ ### UAL2 animation bundle
82
+
83
+ The [Quaternius Universal Animation Library 2](https://quaternius.com/packs/universalanimationlibrary2.html)
84
+ (UAL2, file `UAL2_Standard.glb`) contains 130+ glTF skeleton animations —
85
+ melee combos, parkour, farming, zombie locomotion, and more — created by
86
+ [@Quaternius](https://twitter.com/quaternius). Also [CC0 1.0](https://creativecommons.org/publicdomain/zero/1.0/).
87
+
88
+ Consider supporting Quaternius on [Patreon](https://www.patreon.com/quaternius) or
89
+ joining the [Discord](https://discord.gg/vJqnRUYRfT).
90
+
91
+ ## Mesh — AGPL-3.0
92
+
93
+ Ruth2 mesh body parts are licensed under the
94
+ [GNU Affero General Public License v3](licenses/AGPL-3.0.txt).
95
+
96
+ - **Ruth 2.0** — copyright 2018, Shin Ingen
97
+ - **Ruth2** — copyright 2018 Shin Ingen and 2020 Ada Radius
98
+
99
+ AGPL-covered parts in this project: upper/lower body, bento hands, flat feet,
100
+ v4 bento head, and v4 eyeball meshes — bundled here as `.glb` conversions of the
101
+ original Ruth `.dae`, still AGPL-3.0 as derivative works.
102
+
103
+ **AGPL summary:** you may use and modify these meshes freely. If you distribute
104
+ modified mesh data, or run a network service that exposes them, you must make
105
+ the corresponding source available under the same license.
106
+
107
+ Contributors to the upstream mesh work include (alphabetically): Ada Radius,
108
+ Ai Austin, Chimera Firecaster, Duck Girl, Elenia Boucher, Fred Beckhusen,
109
+ Fritigern Gothly, Joe Builder, Kayaker Magic, Lelani Carver, Leona Morro,
110
+ Linden Lab, Mike Dickson, Noxluna Nightfire, Sean Heavy, Serie Sumei,
111
+ Shin Ingen, Sundance Haiku, Taarna Welles, and other OpenSimulator community
112
+ members. See upstream `LICENSE.md` for the canonical list.
113
+
114
+ ## Upstream references
115
+
116
+ - Ruth (archived RC3): https://github.com/RuthAndRoth/Ruth/tree/archive-ruth-rc3
117
+ - Ruth2: https://github.com/RuthAndRoth/Ruth2
118
+ - Ruth2 LICENSE: https://github.com/RuthAndRoth/Ruth2/blob/master/LICENSE.md
119
+ - three.js pirouette BVH: https://github.com/mrdoob/three.js/blob/master/examples/models/bvh/pirouette.bvh
120
+ - CMU Motion Capture Database: https://mocap.cs.cmu.edu/
121
+ - Quaternius UAL1: https://quaternius.com/packs/ultimateanimatedcharacter.html
122
+ - Quaternius UAL2: https://quaternius.com/packs/universalanimationlibrary2.html