recast-navigation 0.34.0 → 0.35.0

package/README.md

@@ -14,7 +14,7 @@
 - 🚧 ‎ Temporary obstacles
 - 🌐 ‎ Web and Node support
 - 💙 ‎ TypeScript friendly
-- 🖇 ‎ [Easy integration with three.js via @recast-navigation/three](https://github.com/isaac-mason/recast-navigation-js/tree/main/packages/recast-navigation-three)
+- 🖇 ‎ Easy integration with [three.js via @recast-navigation/three](https://github.com/isaac-mason/recast-navigation-js/tree/main/packages/recast-navigation-three) and [playcanvas via @recast-navigation/playcanvas](https://github.com/isaac-mason/recast-navigation-js/tree/main/packages/recast-navigation-playcanvas)
 
 ## Overview
 
@@ -29,7 +29,7 @@ Go to the [examples website](https://recast-navigation-js.isaacmason.com) to see
 - live: [https://recast-navigation-js.isaacmason.com](https://recast-navigation-js.isaacmason.com).
 - examples source code: [./packages/recast-navigation/.storybook/stories](./packages/recast-navigation/.storybook/stories).
 
-Demonstrations of how to use the library in different environments (such as NodeJS, CommonJS) can be found in the [examples](./examples) directory.
+Demonstrations of how to use the recast-navigation-js with different libraries and environments can be found in the [examples](./examples) directory.
 
 ## Installation
 
@@ -49,6 +49,18 @@ export default defineConfig(() => ({
 )}
 ```
 
+If you are planning to use the library with three.js, install the `@recast-navigation/three` package for three.js helpers:
+
+```sh
+npm install @recast-navigation/three
+```
+
+If you are planning to use the library with playcanvas, install the `@recast-navigation/playcanvas` package for playcanvas helpers:
+
+```sh
+npm install @recast-navigation/playcanvas
+```
+
 **Usage without bundlers**
 
 You can use import maps to use the library without a bundler:
@@ -57,10 +69,16 @@ You can use import maps to use the library without a bundler:
 <script type="importmap">
   {
     "imports": {
-      "@recast-navigation/core": "https://unpkg.com/@recast-navigation/core@0.29.0/dist/index.mjs",
-      "@recast-navigation/wasm": "https://unpkg.com/@recast-navigation/wasm@0.29.0/dist/recast-navigation.wasm-compat.js",
-      "@recast-navigation/generators": "https://unpkg.com/@recast-navigation/generators@0.29.0/dist/index.mjs",
-      "@recast-navigation/three": "https://unpkg.com/@recast-navigation/three@0.29.0/dist/index.mjs"
+      // required
+      "@recast-navigation/core": "https://unpkg.com/@recast-navigation/core@0.30.0/dist/index.mjs",
+      "@recast-navigation/wasm": "https://unpkg.com/@recast-navigation/wasm@0.30.0/dist/recast-navigation.wasm-compat.js",
+
+      // easy to use generators
+      "@recast-navigation/generators": "https://unpkg.com/@recast-navigation/generators@0.30.0/dist/index.mjs",
+      
+      // optional integrations
+      "@recast-navigation/three": "https://unpkg.com/@recast-navigation/three@0.30.0/dist/index.mjs",
+      "@recast-navigation/playcanvas": "https://unpkg.com/@recast-navigation/three@0.30.0/dist/index.mjs",
     }
   }
 </script>
@@ -153,7 +171,7 @@ See the docs for more information on generator options: https://docs.recast-navi
 
 It's possible to build a NavMesh in a Web Worker. This can be useful for offloading heavy computation from the main thread.
 
-The library doesn't include a web worker, but it's straightforward to create your own. An example of solo nav mesh generation in a web worker can be found here: https://github.com/isaac-mason/recast-navigation-js/tree/next/examples/vite-worker-example
+The library doesn't include a web worker, but it's straightforward to create your own. An example of solo nav mesh generation in a web worker can be found here: https://github.com/isaac-mason/recast-navigation-js/tree/next/examples/three-vite-worker-example
 
 The example uses `importNavMesh` and `exportNavMesh` to serialize and deserialize a NavMesh for transfer between the main thread and the web worker.
 
@@ -486,7 +504,7 @@ const debugNavMesh = navMesh.getDebugNavMesh();
 const { positions, indices } = debugNavMesh;
 ```
 
-If you are using three.js, you can use built-in helpers from the [`@recast-navigation/three` package](https://github.com/isaac-mason/recast-navigation-js/tree/main/packages/recast-navigation-three/README.md).
+If you are using three.js or playcanvas, you can use built-in helpers from the integration libraries [`@recast-navigation/three`](https://github.com/isaac-mason/recast-navigation-js/tree/main/packages/recast-navigation-three/README.md) / [`@recast-navigation/playcanvas`](https://github.com/isaac-mason/recast-navigation-js/tree/main/packages/recast-navigation-playcanvas/README.md).
 
 #### Detour Status Codes
 
@@ -582,9 +600,9 @@ const { navMesh, tileCache, allocator, compressor } = importTileCache(
 
 ## Packages
 
-Functionality is spread across packages in the `@recast-navigation/*` organization, with the `recast-navigation` acting as an umbrella package.
+Functionality is spread across packages in the `@recast-navigation/*` organization.
 
-You can choose between picking the scoped packages you need, or using the umbrella `recast-navigation` package, which provides additional entrypoints for specific frameworks and libraries.
+The `recast-navigation` package is the umbrella package for core packages, and has entrypoints for `@recast-navigation/core` and `@recast-navigation/generators`.
 
 All packages ship as ECMAScript modules, and are compatible with Node.js and browser environments.
 
@@ -598,6 +616,11 @@ The umbrella package for `recast-navigation`.
 > npm install recast-navigation
 ```
 
+```ts
+import { init } from 'recast-navigation';
+import { generateSoloNavMesh } from 'recast-navigation/generators';
+```
+
 ### [**`@recast-navigation/core`**](https://github.com/isaac-mason/recast-navigation-js/tree/main/packages/recast-navigation-core)
 
 [![Version](https://img.shields.io/npm/v/@recast-navigation/core)](https://www.npmjs.com/package/@recast-navigation/core)
@@ -628,13 +651,23 @@ Helpers for three.js.
 > npm install @recast-navigation/three
 ```
 
+### [**`@recast-navigation/playcanvas`**](https://github.com/isaac-mason/recast-navigation-js/tree/main/packages/recast-navigation-playcanvas)
+
+[![Version](https://img.shields.io/npm/v/@recast-navigation/playcanvas)](https://www.npmjs.com/package/@recast-navigation/playcanvas)
+
+Helpers for playcanvas.
+
+```bash
+> npm install @recast-navigation/playcanvas
+```
+
 ### [**`@recast-navigation/wasm`**](https://github.com/isaac-mason/recast-navigation-js/tree/main/packages/recast-navigation-wasm)
 
 [![Version](https://img.shields.io/npm/v/@recast-navigation/wasm)](https://www.npmjs.com/package/@recast-navigation/wasm)
 
 The WebAssembly build of the Recast and Detour libraries.
 
-You regularly won't need to use this package directly, as `@recast-navigation/core` uses it internally.
+You regularly won't need to use this package directly, `@recast-navigation/core` uses it internally.
 
 ```bash
 > npm install @recast-navigation/wasm

package/package.json

@@ -18,7 +18,7 @@
     "email": "isaac@isaacmason.com",
     "url": "https://isaacmason.com/"
   },
-  "version": "0.34.0",
+  "version": "0.35.0",
   "license": "MIT",
   "homepage": "https://github.com/isaac-mason/recast-navigation-js",
   "bugs": {
@@ -38,11 +38,6 @@
       "types": "./generators.d.ts",
       "import": "./generators.mjs",
       "default": "./generators.mjs"
-    },
-    "./three": {
-      "types": "./three.d.ts",
-      "import": "./three.mjs",
-      "default": "./three.mjs"
     }
   },
   "files": [
@@ -52,14 +47,11 @@
     "generators.mjs",
     "generators.mjs.map",
     "generators.d.ts",
-    "three.mjs",
-    "three.mjs.map",
-    "three.d.ts",
     "LICENSE",
     "README.md"
   ],
   "scripts": {
-    "clean": "(rm index.mjs index.d.ts generators.mjs generators.d.ts three.mjs three.d.ts || true)",
+    "clean": "(rm index.mjs index.d.ts generators.mjs generators.d.ts || true)",
     "build": "yarn clean && rollup --config rollup.config.js --bundleConfigAsCjs",
     "storybook": "storybook dev -p 6006",
     "build-storybook": "storybook build",
@@ -67,9 +59,8 @@
     "lint": "eslint src"
   },
   "dependencies": {
-    "@recast-navigation/core": "0.34.0",
-    "@recast-navigation/generators": "0.34.0",
-    "@recast-navigation/three": "0.34.0"
+    "@recast-navigation/core": "0.35.0",
+    "@recast-navigation/generators": "0.35.0"
   },
   "devDependencies": {
     "@babel/core": "^7.24.5",
@@ -94,7 +85,7 @@
     "@storybook/react-vite": "^8.0.9",
     "@types/react": "^18.3.1",
     "@types/react-dom": "^18.2.8",
-    "@types/three": "^0.167.1",
+    "@types/three": "^0.169.0",
     "@vitejs/plugin-react": "^4.2.1",
     "eslint": "^9.6.0",
     "leva": "^0.9.35",
@@ -105,11 +96,11 @@
     "rollup-plugin-filesize": "^10.0.0",
     "storybook": "^8.0.9",
     "suspend-react": "^0.1.3",
-    "three": "^0.167.1",
+    "three": "^0.169.0",
     "three-pathfinding": "^1.2.0",
     "typescript": "^5.4.3",
-    "vite": "^5.2.10",
-    "vitest": "^1.5.2",
+    "vite": "^5.4.8",
+    "vitest": "^2.1.2",
     "zustand": "^4.5.2"
   },
   "packageManager": "yarn@3.2.2"

package/three.d.ts

@@ -1 +0,0 @@
-export * from '@recast-navigation/three';

package/three.mjs

@@ -1,2 +0,0 @@
-export*from"@recast-navigation/three";
-//# sourceMappingURL=three.mjs.map

package/three.mjs.map

@@ -1 +0,0 @@
-{"version":3,"file":"three.mjs","sources":[],"sourcesContent":[],"names":[],"mappings":""}