recast-navigation 0.3.0 → 0.4.0

package/README.md

@@ -40,9 +40,7 @@ await init();
 ### Creating a NavMesh
 
 ```ts
-import { NavMeshGenerator } from 'recast-navigation';
-
-const navMeshGenerator = new NavMeshGenerator();
+import { generateSoloNavMesh } from 'recast-navigation';
 
 const positions = [
   /* flat array of positions */
@@ -57,7 +55,7 @@ const navMeshConfig = {
   /* ... */
 };
 
-const { navMesh } = navMeshGenerator.generateSoloNavMesh(
+const { success, navMesh } = generateSoloNavMesh(
   positions,
   indices,
   navMeshConfig
@@ -87,11 +85,17 @@ Recast Navigation supports creating Box and Cylinder obstacles.
 Note that in order to use obstacles, you must create a tiled NavMesh.
 
 ```ts
+import { generateTiledNavMesh } from 'recast-navigation';
+
 /* create a tiled NavMesh */
-const { navMesh, tileCache } = navMeshGenerator.generateTiledNavMesh(positions, indices, {
-  /* ... */
-  tileSize: 16,
-});
+const { success, navMesh, tileCache } = generateTiledNavMesh(
+  positions,
+  indices,
+  {
+    /* ... */
+    tileSize: 16,
+  }
+);
 
 /* add a Box obstacle to the NavMesh */
 const position = { x: 0, y: 0, z: 0 };
@@ -207,17 +211,33 @@ If you are using `@recast-navigation/three`, you can use `NavMeshHelper` and `Cr
 A NavMesh and TileCache can be exported and imported as a Uint8Array.
 
 ```ts
-/* exporting */
-const navMeshExporter = new NavMeshExporter();
+import { exportNavMesh, importNavMesh } from 'recast-navigation';
 
-const navMeshExport: Uint8Array = navMeshExporter.export(
+/* exporting */
+const navMeshExport: Uint8Array = exportNavMesh(
   navMesh,
   tileCache // optional
 );
 
 /* importing */
-const navMeshImporter = new NavMeshImporter();
+const { navMesh, tileCache } = importNavMesh(navMeshExport);
+```
 
-const { navMesh, tileCache } =
-  navMeshImporter.import(navMeshExport);
+### Escape Hatches
+
+This library provides a higher level api over Recast, but also exposes a `Raw` api that aims to match the recast and detour libraries as much as possible.
+
+This functionality is experimental, and not all of recast is exposed yet. You will need to have familiarity with the recast and detour c++ libraries, and you may need to submit an issue or a PR if something you need is not exposed yet.
+
+Auto-generated documentation can be found here: https://docs.recast-navigation-js.isaacmason.com/variables/index.Raw.html
+
+```ts
+import { Raw } from 'recast-navigation';
+
+const navMeshData = Raw.DetourNavMeshBuilder.createNavMeshData(/* ... */);
 ```
+
+The solo and tiled nav mesh generators in this library are adaptations of the `RecastDemo` examples: https://github.com/isaac-mason/recastnavigation/blob/main/RecastDemo/Source/Sample_SoloMesh.cpp
+
+You can use the solo and tiled nav mesh generators in this library as the basis of a nav mesh generator suiting your requirements. See: https://github.com/isaac-mason/recast-navigation-js/tree/main/packages/recast-navigation-core/src/generators
+

package/package.json

@@ -18,7 +18,7 @@
     "email": "isaac@isaacmason.com",
     "url": "https://isaacmason.com/"
   },
-  "version": "0.3.0",
+  "version": "0.4.0",
   "license": "MIT",
   "homepage": "https://github.com/isaac-mason/recast-navigation-js",
   "bugs": {
@@ -44,48 +44,50 @@
     "README.md"
   ],
   "scripts": {
-    "build": "rollup --config rollup.config.js --bundleConfigAsCjs",
+    "clean": "(rm index.js index.d.ts three.js three.d.ts || true)",
+    "build": "yarn clean && rollup --config rollup.config.js --bundleConfigAsCjs",
     "storybook": "storybook dev -p 6006",
     "build-storybook": "storybook build"
   },
   "dependencies": {
-    "@recast-navigation/core": "0.3.0",
-    "@recast-navigation/three": "0.3.0"
+    "@recast-navigation/core": "0.4.0",
+    "@recast-navigation/three": "0.4.0"
   },
   "peerDependencies": {
-    "three": "^0.150.1"
+    "three": "^0.155.0"
   },
   "devDependencies": {
-    "@babel/core": "^7.21.3",
-    "@mdx-js/react": "^1.6.22",
-    "@react-three/csg": "^2.2.0",
-    "@react-three/drei": "^9.72.1",
+    "@babel/core": "^7.22.5",
+    "@mdx-js/react": "^2.3.0",
+    "@pmndrs/assets": "^1.6.0",
+    "@react-three/csg": "^3.0.0",
+    "@react-three/drei": "^9.78.2",
     "@react-three/fiber": "^8.12.0",
     "@rollup/plugin-commonjs": "^24.0.1",
     "@rollup/plugin-multi-entry": "^6.0.0",
     "@rollup/plugin-node-resolve": "^15.0.1",
-    "@rollup/plugin-terser": "^0.4.0",
-    "@rollup/plugin-typescript": "^11.0.0",
-    "@storybook/addon-actions": "^7.0.22",
-    "@storybook/addon-essentials": "^7.0.22",
-    "@storybook/addon-interactions": "^7.0.22",
-    "@storybook/addon-links": "^7.0.22",
-    "@storybook/addon-mdx-gfm": "^7.0.22",
-    "@storybook/react": "^7.0.22",
-    "@storybook/react-vite": "^7.0.22",
+    "@rollup/plugin-terser": "^0.4.3",
+    "@rollup/plugin-typescript": "^11.1.2",
+    "@storybook/addon-actions": "^7.3.2",
+    "@storybook/addon-essentials": "^7.3.2",
+    "@storybook/addon-interactions": "^7.3.2",
+    "@storybook/addon-links": "^7.3.2",
+    "@storybook/addon-mdx-gfm": "^7.3.2",
+    "@storybook/react": "^7.3.2",
+    "@storybook/react-vite": "^7.3.2",
     "@types/react": "^18.2.11",
-    "@types/react-dom": "^18.0.11",
-    "@types/three": "^0.150.0",
+    "@types/react-dom": "^18.2.7",
+    "@types/three": "^0.155.0",
     "babel-loader": "^8.3.0",
-    "leva": "^0.9.34",
+    "leva": "^0.9.35",
     "react": "^18.2.0",
     "react-dom": "^18.2.0",
-    "rollup": "^3.20.0",
+    "rollup": "^3.26.3",
     "rollup-plugin-copy": "^3.4.0",
     "rollup-plugin-filesize": "^10.0.0",
-    "storybook": "^7.0.22",
-    "suspend-react": "^0.0.9",
-    "three": "^0.150.1",
+    "storybook": "^7.3.2",
+    "suspend-react": "^0.1.3",
+    "three": "^0.155.0",
     "three-pathfinding": "^1.2.0"
   },
   "packageManager": "yarn@3.2.2"