ara3d 0.1.0 → 0.2.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 (120) hide show
  1. package/README.md +29 -8
  2. package/dist/cli.js +5 -5
  3. package/dist/index.js +1806 -0
  4. package/dist/types/packages/cli/src/index.d.ts +89 -0
  5. package/dist/types/packages/cli/src/library/colors.d.ts +9 -0
  6. package/dist/types/packages/cli/src/library/generate.d.ts +40 -0
  7. package/dist/types/packages/cli/src/library/worker.d.ts +22 -0
  8. package/dist/types/src/app/character-assist.d.ts +73 -0
  9. package/dist/types/src/app/share.d.ts +19 -0
  10. package/dist/types/src/core/anim/boarding.d.ts +4 -0
  11. package/dist/types/src/core/anim/clips/actions.d.ts +9 -0
  12. package/dist/types/src/core/anim/clips/aerial.d.ts +7 -0
  13. package/dist/types/src/core/anim/clips/basic.d.ts +4 -0
  14. package/dist/types/src/core/anim/clips/climbing.d.ts +37 -0
  15. package/dist/types/src/core/anim/clips/combat.d.ts +6 -0
  16. package/dist/types/src/core/anim/clips/cover.d.ts +19 -0
  17. package/dist/types/src/core/anim/clips/dodge.d.ts +8 -0
  18. package/dist/types/src/core/anim/clips/emotes.d.ts +21 -0
  19. package/dist/types/src/core/anim/clips/everyday.d.ts +15 -0
  20. package/dist/types/src/core/anim/clips/faces.d.ts +11 -0
  21. package/dist/types/src/core/anim/clips/gait.d.ts +17 -0
  22. package/dist/types/src/core/anim/clips/gunshot.d.ts +8 -0
  23. package/dist/types/src/core/anim/clips/helpers.d.ts +26 -0
  24. package/dist/types/src/core/anim/clips/index.d.ts +8 -0
  25. package/dist/types/src/core/anim/clips/interaction.d.ts +18 -0
  26. package/dist/types/src/core/anim/clips/lying.d.ts +8 -0
  27. package/dist/types/src/core/anim/clips/melee.d.ts +3 -0
  28. package/dist/types/src/core/anim/clips/mocap-data.d.ts +6 -0
  29. package/dist/types/src/core/anim/clips/reactions.d.ts +34 -0
  30. package/dist/types/src/core/anim/clips/recorded.d.ts +12 -0
  31. package/dist/types/src/core/anim/clips/runner.d.ts +10 -0
  32. package/dist/types/src/core/anim/clips/shooter.d.ts +15 -0
  33. package/dist/types/src/core/anim/clips/speech.d.ts +10 -0
  34. package/dist/types/src/core/anim/clips/swimming.d.ts +17 -0
  35. package/dist/types/src/core/anim/clips/types.d.ts +152 -0
  36. package/dist/types/src/core/anim/clips/vehicles.d.ts +28 -0
  37. package/dist/types/src/core/anim/evaluate.d.ts +188 -0
  38. package/dist/types/src/core/anim/mocap.d.ts +120 -0
  39. package/dist/types/src/core/anim/quat.d.ts +14 -0
  40. package/dist/types/src/core/anim/riding-weapons.d.ts +13 -0
  41. package/dist/types/src/core/anim/stage.d.ts +5 -0
  42. package/dist/types/src/core/assets.d.ts +114 -0
  43. package/dist/types/src/core/face.d.ts +56 -0
  44. package/dist/types/src/core/garments/bags.d.ts +2 -0
  45. package/dist/types/src/core/garments/beach.d.ts +9 -0
  46. package/dist/types/src/core/garments/body.d.ts +70 -0
  47. package/dist/types/src/core/garments/catalog.d.ts +8 -0
  48. package/dist/types/src/core/garments/drape.d.ts +86 -0
  49. package/dist/types/src/core/garments/dress-shoes.d.ts +7 -0
  50. package/dist/types/src/core/garments/earpiece.d.ts +2 -0
  51. package/dist/types/src/core/garments/gowns.d.ts +2 -0
  52. package/dist/types/src/core/garments/gulf.d.ts +2 -0
  53. package/dist/types/src/core/garments/heels.d.ts +8 -0
  54. package/dist/types/src/core/garments/index.d.ts +36 -0
  55. package/dist/types/src/core/garments/kit.d.ts +173 -0
  56. package/dist/types/src/core/garments/last.d.ts +78 -0
  57. package/dist/types/src/core/garments/layering.d.ts +4 -0
  58. package/dist/types/src/core/garments/necklaces.d.ts +2 -0
  59. package/dist/types/src/core/garments/outfit-cut.d.ts +30 -0
  60. package/dist/types/src/core/garments/prison.d.ts +2 -0
  61. package/dist/types/src/core/garments/project.d.ts +61 -0
  62. package/dist/types/src/core/garments/ring.d.ts +100 -0
  63. package/dist/types/src/core/garments/sets.d.ts +41 -0
  64. package/dist/types/src/core/garments/shell.d.ts +37 -0
  65. package/dist/types/src/core/garments/sheriff.d.ts +2 -0
  66. package/dist/types/src/core/garments/shirts.d.ts +31 -0
  67. package/dist/types/src/core/garments/sneakers.d.ts +7 -0
  68. package/dist/types/src/core/garments/street.d.ts +2 -0
  69. package/dist/types/src/core/garments/suit.d.ts +2 -0
  70. package/dist/types/src/core/garments/swimwear.d.ts +2 -0
  71. package/dist/types/src/core/garments/textures.d.ts +53 -0
  72. package/dist/types/src/core/garments/wrist.d.ts +2 -0
  73. package/dist/types/src/core/garments/yoruba.d.ts +2 -0
  74. package/dist/types/src/core/geometry.d.ts +31 -0
  75. package/dist/types/src/core/human.d.ts +42 -0
  76. package/dist/types/src/core/looks/hair.d.ts +64 -0
  77. package/dist/types/src/core/looks/index.d.ts +38 -0
  78. package/dist/types/src/core/looks/jewelry.d.ts +20 -0
  79. package/dist/types/src/core/looks/mouth.d.ts +12 -0
  80. package/dist/types/src/core/looks/overlay.d.ts +42 -0
  81. package/dist/types/src/core/looks/tattoos.d.ts +11 -0
  82. package/dist/types/src/core/looks/textures.d.ts +8 -0
  83. package/dist/types/src/core/math.d.ts +29 -0
  84. package/dist/types/src/core/mesh.d.ts +75 -0
  85. package/dist/types/src/core/morph.d.ts +11 -0
  86. package/dist/types/src/core/pack.d.ts +7 -0
  87. package/dist/types/src/core/params.d.ts +103 -0
  88. package/dist/types/src/core/props/bicycle.d.ts +26 -0
  89. package/dist/types/src/core/props/carry.d.ts +67 -0
  90. package/dist/types/src/core/props/helicopter-layout.d.ts +11 -0
  91. package/dist/types/src/core/props/horse-gait.d.ts +11 -0
  92. package/dist/types/src/core/props/parachute.d.ts +14 -0
  93. package/dist/types/src/core/props/stage-props.d.ts +23 -0
  94. package/dist/types/src/core/props/vehicle-actions.d.ts +23 -0
  95. package/dist/types/src/core/props/vehicle-bodies.d.ts +5 -0
  96. package/dist/types/src/core/props/vehicle-car.d.ts +2 -0
  97. package/dist/types/src/core/props/vehicle-doors.d.ts +2 -0
  98. package/dist/types/src/core/props/vehicle-helicopter.d.ts +2 -0
  99. package/dist/types/src/core/props/vehicle-horse.d.ts +2 -0
  100. package/dist/types/src/core/props/vehicle-kit.d.ts +61 -0
  101. package/dist/types/src/core/props/vehicle-land.d.ts +3 -0
  102. package/dist/types/src/core/props/vehicle-merge.d.ts +3 -0
  103. package/dist/types/src/core/props/vehicle-motion.d.ts +104 -0
  104. package/dist/types/src/core/props/vehicle-special.d.ts +3 -0
  105. package/dist/types/src/core/props/vehicle-stunt.d.ts +16 -0
  106. package/dist/types/src/core/props/vehicle-water.d.ts +2 -0
  107. package/dist/types/src/core/props/vehicle.d.ts +49 -0
  108. package/dist/types/src/core/props/vehicles.d.ts +60 -0
  109. package/dist/types/src/core/props/weapons.d.ts +21 -0
  110. package/dist/types/src/core/rig/poses.d.ts +7 -0
  111. package/dist/types/src/core/rig/rig.d.ts +75 -0
  112. package/dist/types/src/core/rig/skeletons.d.ts +33 -0
  113. package/dist/types/src/core/rig/socket.d.ts +21 -0
  114. package/dist/types/src/core/skin-rough.d.ts +11 -0
  115. package/dist/types/src/export/fbx.d.ts +10 -0
  116. package/dist/types/src/export/glb.d.ts +9 -0
  117. package/dist/types/src/export/index.d.ts +22 -0
  118. package/dist/types/src/export/obj.d.ts +6 -0
  119. package/dist/types/src/export/plan.d.ts +63 -0
  120. package/package.json +12 -4
package/README.md CHANGED
@@ -1,6 +1,25 @@
1
1
  # ara3d
2
2
 
3
- Generate realistic, rigged and animated 3D characters from the command line: GLB, FBX, OBJ or a ZIP bundle for Unity, Unreal, Godot, Blender and the web. Free and open source; everything runs on your machine.
3
+ Realistic, rigged and animated 3D characters, free and open source: a **three.js library** for your web app or game, and a **command-line tool** that writes GLB, FBX or OBJ files for Unity, Unreal, Godot and Blender. Everything runs on your machine or your visitors' devices.
4
+
5
+ ## In the browser
6
+
7
+ ```bash
8
+ npm install ara3d three
9
+ ```
10
+
11
+ ```js
12
+ import * as THREE from 'three';
13
+ import { createCharacter } from 'ara3d';
14
+
15
+ const hero = await createCharacter('The Soldier', { animations: ['walk', 'run', 'idle'], weapon: 'rifle' });
16
+ scene.add(hero.scene);
17
+ new THREE.AnimationMixer(hero.scene).clipAction(hero.clip('walk')).play();
18
+ ```
19
+
20
+ Characters are built in a background worker, and the character data loads from a free CDN. TypeScript types are included. Guide: [ara3dgen.com/docs/library](https://ara3dgen.com/docs/library/).
21
+
22
+ ## On the command line
4
23
 
5
24
  ```bash
6
25
  npx ara3d export --preset "The Soldier"
@@ -9,12 +28,14 @@ npx ara3d export --preset "The Soldier" --animations walk,run,idle --root-motion
9
28
  npx ara3d new hero && npx ara3d export --params hero.json --formats glb,fbx
10
29
  ```
11
30
 
12
- The first run downloads the character data (about 50 MB) and caches it. Needs Node 20+.
31
+ The first run downloads the character data (about 50 MB) and caches it. Needs Node 20+. Guide: [ara3dgen.com/docs/cli](https://ara3dgen.com/docs/cli/).
32
+
33
+ ## Both
13
34
 
14
- - **Commands:** `export`, `presets`, `animations`, `props`, `new`, `schema`; run `npx ara3d --help`.
15
- - **Props:** weapons, carried items and 13 vehicles fitted to the rider (`--weapon rifle --carry backpack --vehicle motorcycle`).
16
- - **Animations:** 216 motion-captured and hand-made clips. Pick only the ones you need, add root motion, or get one file per clip.
17
- - **Character files** use a published JSON schema, so editors autocomplete them and AI assistants can write them.
18
- - **Licence:** the tool is MIT. The characters are built from CC0 MakeHuman data, with animations from the CMU Graphics Lab Motion Capture Database, so you can use them in commercial projects.
35
+ - **32 presets**, random characters from a seed, or your own character files, checked against a [published JSON schema](https://ara3dgen.com/schemas/character.v1.json) that editors autocomplete and AI assistants can follow.
36
+ - **216 animations:** pick only the ones you need, with optional root motion.
37
+ - **Props:** weapons, carried items and 13 vehicles fitted to the rider.
38
+ - **In the browser:** random characters from a seed, characters designed in the [Ara builder](https://ara3dgen.com/app/) from their share link, new colours for clothes, bags and vehicles, and faces that change expression, blink and lip-sync (Oculus viseme names).
39
+ - **Licence:** the code is MIT. Characters are built from CC0 MakeHuman data, with animations from the CMU Graphics Lab Motion Capture Database, so you can use them in commercial projects.
19
40
 
20
- Full guide: [ara3dgen.com/docs/cli](https://ara3dgen.com/docs/cli/). Make characters in the browser at [ara3dgen.com](https://ara3dgen.com). Source: [github.com/olatunde85/3d-gen](https://github.com/olatunde85/3d-gen).
41
+ Make characters in the browser at [ara3dgen.com](https://ara3dgen.com). Source: [github.com/olatunde85/3d-gen](https://github.com/olatunde85/3d-gen).