recast-navigation 0.28.0 → 0.29.1

package/README.md

@@ -58,10 +58,10 @@ 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.27.0/dist/index.mjs",
-      "@recast-navigation/wasm": "https://unpkg.com/@recast-navigation/wasm@0.27.0/dist/recast-navigation.wasm-compat.js",
-      "@recast-navigation/generators": "https://unpkg.com/@recast-navigation/generators@0.27.0/dist/index.mjs",
-      "@recast-navigation/three": "https://unpkg.com/@recast-navigation/three@0.27.0/dist/index.mjs"
+      "@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"
     }
   }
 </script>
@@ -220,6 +220,51 @@ const maxAgentRadius = 0.6;
 const crowd = new Crowd(navMesh, { maxAgents, maxAgentRadius });
 ```
 
+**Updating a Crowd**
+
+There are a few options for updating a crowd:
+
+**Variable time stepping**
+
+The simplest approach is to do varible time stepping. Simply call `crowd.update` with your delta time every frame.
+
+```ts
+crowd.update(timeSinceLastFrame);
+```
+
+This approach is suitable for most use cases, but the variable timestep will result in non-deterministic behaviour.
+
+Depending on your use case, you might want to clamp `timeSinceLastFrame` to a maximum value to prevent large time steps causing issues.
+
+**Fixed time stepping with interpolation**
+
+Fixed time stepping with interpolation can be preferable if you need deterministic behaviour, but still want smooth agent position updates each frame.
+
+If you provide `update` with a `dt` value and a `timeSinceLastFrame` value, the crowd update will do fixed time stepping with interpolation.
+
+```ts
+const dt = 1 / 60;
+const maxSubSteps = 10;
+
+crowd.update(dt, timeSinceLastFrame, maxSubSteps);
+```
+
+This will update the `interpolatedPosition` vector3 on each agent, which you can use to render a smoothly interpolated agent position between updates.
+
+```ts
+console.log(agent.interpolatedPosition); // { x: 1, y: 2, z: 3 }
+```
+
+**Manual fixed time stepping**
+
+If you want full control over crowd updates, you can simply call `crowd.update` with a given `dt` value.
+
+```ts
+const dt = 1 / 60;
+
+crowd.update(dt);
+```
+
 **Creating an Agent in a Crowd**
 
 ```ts
@@ -257,18 +302,6 @@ agent.requestMoveTarget(targetPosition);
 agent.resetMoveTarget();
 ```
 
-**Updating the Crowd**
-
-To update the crowd, first set a timeStep, then call `update` each frame with the delta time.
-
-```ts
-const dt = 1 / 60;
-crowd.timeStep = dt;
-
-// you should call this every frame
-crowd.update(dt);
-```
-
 **Interacting with Agents**
 
 ```ts
@@ -581,6 +614,18 @@ Helpers for three.js.
 > npm install @recast-navigation/three
 ```
 
+### [**`@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.
+
+```bash
+> npm install @recast-navigation/wasm
+```
+
 ## Apps
 
 ### [NavMesh Generator](https://navmesh.isaacmason.com/)

package/package.json

@@ -18,7 +18,7 @@
     "email": "isaac@isaacmason.com",
     "url": "https://isaacmason.com/"
   },
-  "version": "0.28.0",
+  "version": "0.29.1",
   "license": "MIT",
   "homepage": "https://github.com/isaac-mason/recast-navigation-js",
   "bugs": {
@@ -67,9 +67,9 @@
     "lint": "eslint --ext .ts src"
   },
   "dependencies": {
-    "@recast-navigation/core": "0.28.0",
-    "@recast-navigation/generators": "0.28.0",
-    "@recast-navigation/three": "0.28.0"
+    "@recast-navigation/core": "0.29.1",
+    "@recast-navigation/generators": "0.29.1",
+    "@recast-navigation/three": "0.29.1"
   },
   "devDependencies": {
     "@babel/core": "^7.24.5",
@@ -79,7 +79,7 @@
     "@mdx-js/react": "^2.3.0",
     "@pmndrs/assets": "^1.6.0",
     "@react-three/drei": "^9.105.4",
-    "@react-three/fiber": "^8.15.12",
+    "@react-three/fiber": "^8.16.3",
     "@rollup/plugin-babel": "^6.0.4",
     "@rollup/plugin-commonjs": "^25.0.7",
     "@rollup/plugin-node-resolve": "^15.0.1",