@rig-c/three 0.1.0 → 0.1.1

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 (2) hide show
  1. package/README.md +5 -1
  2. package/package.json +6 -2
package/README.md CHANGED
@@ -4,11 +4,15 @@ Draw a rig-c model in a native Three.js scene through `@rig-c/play`. `ThreeRig`
4
4
  is a flat `Group`: each drawn slot is a `Mesh` with native float32 geometry,
5
5
  with one shared shader material per page per instance. It poses no bones itself.
6
6
 
7
+ ## Install
8
+
7
9
  ```sh
8
10
  npm install @rig-c/three three @rig-c/play
9
11
  npm install --save-dev @types/three
10
12
  ```
11
13
 
14
+ ## Minimal usage
15
+
12
16
  ```ts
13
17
  import { loadModel } from '@rig-c/play';
14
18
  import { OrthographicCamera, Scene, WebGLRenderer } from 'three';
@@ -36,7 +40,7 @@ requestAnimationFrame(frame);
36
40
  ```
37
41
 
38
42
  Use the model document and image pages from `rigc build`, unchanged. Tested with
39
- Three.js **0.186.1** and play **1.10.0**. The API is 0.x.
43
+ Three.js **0.186.1** and play **1.10.0**. The API is 0.x. See [`packages/three` in the repository](https://github.com/rig-c/adapters/tree/main/packages/three) for source and parity tests.
40
44
 
41
45
  ## Live object
42
46
 
package/package.json CHANGED
@@ -1,14 +1,18 @@
1
1
  {
2
2
  "name": "@rig-c/three",
3
- "version": "0.1.0",
3
+ "version": "0.1.1",
4
4
  "description": "Play rig-c model documents in a native Three.js scene through @rig-c/play.",
5
5
  "type": "module",
6
6
  "license": "MIT",
7
7
  "repository": {
8
8
  "type": "git",
9
- "url": "https://github.com/rig-c/adapters.git",
9
+ "url": "git+https://github.com/rig-c/adapters.git",
10
10
  "directory": "packages/three"
11
11
  },
12
+ "homepage": "https://github.com/rig-c/adapters/tree/main/packages/three#readme",
13
+ "bugs": {
14
+ "url": "https://github.com/rig-c/adapters/issues"
15
+ },
12
16
  "exports": {
13
17
  ".": {
14
18
  "types": "./dist/index.d.ts",