recast-navigation 0.4.1 → 0.5.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 (2) hide show
  1. package/README.md +10 -1
  2. package/package.json +4 -4
package/README.md CHANGED
@@ -37,7 +37,14 @@ import { init } from 'recast-navigation';
37
37
  await init();
38
38
  ```
39
39
 
40
- ### Creating a NavMesh
40
+ ### Generating a NavMesh
41
+
42
+ To create a NavMesh, you can use the `generateSoloNavMesh` and `generateTiledNavMesh` functions.
43
+
44
+ The input positions and indices should adhere to OpenGL conventions:
45
+ - Use the right-handed coordinate system
46
+ - Indices should be in counter-clockwise winding order
47
+ - The `positions` and `indices` arguments should be flat arrays of numbers
41
48
 
42
49
  ```ts
43
50
  import { generateSoloNavMesh } from 'recast-navigation';
@@ -62,6 +69,8 @@ const { success, navMesh } = generateSoloNavMesh(
62
69
  );
63
70
  ```
64
71
 
72
+ If you need to do something more advanced, you can use the lower level API to create your own NavMesh generator. See the "Escape Hatches" section for more information.
73
+
65
74
  ### Querying a NavMesh
66
75
 
67
76
  ```ts
package/package.json CHANGED
@@ -18,7 +18,7 @@
18
18
  "email": "isaac@isaacmason.com",
19
19
  "url": "https://isaacmason.com/"
20
20
  },
21
- "version": "0.4.1",
21
+ "version": "0.5.0",
22
22
  "license": "MIT",
23
23
  "homepage": "https://github.com/isaac-mason/recast-navigation-js",
24
24
  "bugs": {
@@ -50,14 +50,14 @@
50
50
  "build-storybook": "storybook build"
51
51
  },
52
52
  "dependencies": {
53
- "@recast-navigation/core": "0.4.1",
54
- "@recast-navigation/three": "0.4.1"
53
+ "@recast-navigation/core": "0.5.0",
54
+ "@recast-navigation/three": "0.5.0"
55
55
  },
56
56
  "peerDependencies": {
57
57
  "three": "^0.155.0"
58
58
  },
59
59
  "devDependencies": {
60
- "@babel/core": "^7.22.5",
60
+ "@babel/core": "^7.22.11",
61
61
  "@mdx-js/react": "^2.3.0",
62
62
  "@pmndrs/assets": "^1.6.0",
63
63
  "@react-three/csg": "^3.0.0",