recast-navigation 0.10.2 → 0.11.0

package/README.md

@@ -67,7 +67,11 @@ await init();
 
 ### Generating a NavMesh
 
-To create a NavMesh, you can use the `generateSoloNavMesh` and `generateTiledNavMesh` functions.
+The easiest way to generate a NavMesh is using the high level generator functions:
+
+- `generateSoloNavMesh` - Generates a NavMesh with a single tile. You can use this for smaller environments.
+- `generateTiledNavMesh` - Generates a NavMesh with multiple tiles. You should use this for larger environments.
+- `generateTileCache` - Generates a TileCache that supports temporary obstacles. See the [Temporary Obstacles](https://github.com/isaac-mason/recast-navigation-js#temporary-obstacles) section.
 
 The input positions and indices should adhere to OpenGL conventions:
 
@@ -98,7 +102,7 @@ const { success, navMesh } = generateSoloNavMesh(
 );
 ```
 
-If you need to do something more advanced, you can use the lower level API to create your own NavMesh generator. See the "Advanced Usage" section for more information.
+If you need to do something more advanced, you can use the lower level API to create your own NavMesh generator. See the [Advanced Usage](https://github.com/isaac-mason/recast-navigation-js#advanced-usage) section for more information.
 
 ### Querying a NavMesh
 
@@ -114,6 +118,12 @@ navMeshQuery.getClosestPoint(position);
 /* get a random point around the given position */
 const radius = 0.5;
 navMeshQuery.getRandomPointAround(position, radius);
+
+/* compute a straight path between two points */
+const path: Vector3[] = navMeshQuery.computePath(
+  { x: 0, y: 0, z: 0 }, // start position
+  { x: 2, y: 0, z: 0 } // end position
+);
 ```
 
 ### Crowds and Agents
@@ -292,14 +302,22 @@ This library provides low-level APIs that aim to match the recast and detour c++
 
 Please note that this functionality is experimental, and not all everything is exposed. Familiarity with the recast and detour C++ libraries is required. If you require unexposed functionality, please submit an issue or a pull request.
 
-<!-- REMOVE-FROM-DOCS-START -->
+## Documentation
 
-## API Documentation
+<!-- REMOVE-FROM-DOCS-START -->
 
-Documentation can be found at [https://docs.recast-navigation-js.isaacmason.com](https://docs.recast-navigation-js.isaacmason.com).
+API Documentation can be found at [https://docs.recast-navigation-js.isaacmason.com](https://docs.recast-navigation-js.isaacmason.com).
 
 <!-- REMOVE-FROM-DOCS-END -->
 
+Documentation for the Recast and Detour c++ libraries can be found here:
+
+- [Recast Navigation Website](http://recastnav.com/)
+- [Recast Navigation GitHub](https://github.com/recastnavigation/recastnavigation)
+- [Recast Navigation Google Discussions](https://groups.google.com/g/recastnavigation)
+
+The GitHub issues and Google Discussions are a great resources for learning about the library and getting guidance on common issues.
+
 ## Examples
 
 Some demonstrations of how to use the library in different environments can be found in the [examples](./examples) directory.

package/package.json

@@ -18,7 +18,7 @@
     "email": "isaac@isaacmason.com",
     "url": "https://isaacmason.com/"
   },
-  "version": "0.10.2",
+  "version": "0.11.0",
   "license": "MIT",
   "homepage": "https://github.com/isaac-mason/recast-navigation-js",
   "bugs": {
@@ -56,8 +56,8 @@
     "build-storybook": "storybook build"
   },
   "dependencies": {
-    "@recast-navigation/core": "0.10.2",
-    "@recast-navigation/three": "0.10.2"
+    "@recast-navigation/core": "0.11.0",
+    "@recast-navigation/three": "0.11.0"
   },
   "devDependencies": {
     "@babel/core": "^7.22.11",