recast-navigation 0.0.0-development-0

package/LICENSE

@@ -0,0 +1,21 @@
+The MIT License
+
+Copyright © 2022 Isaac Mason
+
+Permission is hereby granted, free of charge, to any person obtaining a copy
+of this software and associated documentation files (the "Software"), to deal
+in the Software without restriction, including without limitation the rights
+to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
+copies of the Software, and to permit persons to whom the Software is
+furnished to do so, subject to the following conditions:
+
+The above copyright notice and this permission notice shall be included in
+all copies or substantial portions of the Software.
+
+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
+IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
+FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
+AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
+LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
+OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN
+THE SOFTWARE.

package/README.md

@@ -0,0 +1,193 @@
+# recast-navigation
+
+### Recast Navigation for JavaScript!
+
+A WebAssembly port of [Recast Navigation](https://github.com/recastnavigation/recastnavigation), plus other goodies.
+
+## Features
+
+- 📐 ‎ NavMesh generation
+- 🧭 ‎ Path-finding
+- 🧑‍🤝‍🧑 ‎ Crowd simulation
+- 🌐 ‎ 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)
+
+## Installation
+
+```sh
+npm install recast-navigation
+```
+
+## Usage
+
+### Initialization
+
+Before you can use the library, you must initialize it. This is an asynchronous operation.
+
+Calling `init()` after the library has already been initialized will return a promise that resolves immediately.
+
+```ts
+import { init } from 'recast-navigation';
+
+await init();
+```
+
+### Creating a NavMesh
+
+```ts
+import { NavMesh } from 'recast-navigation';
+
+const navMesh = new NavMesh();
+
+const positions = [
+  /* ... */
+];
+
+const indices = [
+  /* ... */
+];
+
+const navMeshConfig = {
+  /* ... */
+};
+
+navMesh.build(positions, indices, navMeshConfig);
+```
+
+### Querying a NavMesh
+
+```ts
+const navMesh = new NavMesh();
+
+/* initialize the NavMesh */
+// ...
+
+/* get the closest point on the NavMesh to the given position */
+const position = { x: 0, y: 0, z: 0 };
+navMesh.getClosestPoint(position);
+
+/* get a random point around the given position */
+const radius = 0.5;
+navMesh.getRandomPointAround(position, radius);
+```
+
+### Adding Obstacles to a NavMesh
+
+Recast Navigation supports creating Box and Cylinder obstacles.
+
+```ts
+/* add a Box obstacle to the NavMesh */
+const position = { x: 0, y: 0, z: 0 };
+const extent = { x: 1, y: 1, z: 1 };
+const angle = 0;
+const boxObstacleRef = navMesh.addBoxObstacle(position, extent, angle);
+
+/* add a Cylinder obstacle to the NavMesh */
+const radius = 1;
+const height = 1;
+const cylinderObstacleRef = navMesh.addCylinderObstacle(
+  position,
+  radius,
+  height,
+  angle
+);
+
+/* remove the obstacles from the NavMesh */
+navMesh.removeObstacle(boxObstacleRef);
+navMesh.removeObstacle(cylinderObstacleRef);
+```
+
+### Crowds and Agents
+
+First, create a `Crowd` instance.
+
+```ts
+import { Crowd } from 'recast-navigation';
+
+const maxAgents = 10;
+const maxAgentRadius = 0.6;
+
+const crowd = new Crowd({ maxAgents, maxAgentRadius, navMesh });
+```
+
+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);
+```
+
+Next, you can create and interface with agents in the crowd.
+
+```ts
+const position = { x: 0, y: 0, z: 0 };
+const radius = 0.6;
+
+const initialAgentPosition = navMesh.getRandomPointAround(
+  { x: 0, y: 0, z: 0 },
+  2
+);
+
+const agentIndex = crowd.addAgent(initialAgentPosition, {
+  radius: 0.5,
+  height: 0.5,
+  maxAcceleration: 4.0,
+  maxSpeed: 1.0,
+  collisionQueryRange: 0.5,
+  pathOptimizationRange: 0.0,
+  separationWeight: 1.0,
+});
+
+/* get information about the agent */
+const agentPosition = crowd.getAgentPosition(agentIndex);
+const agentVelocity = crowd.getAgentVelocity(agentIndex);
+const agentNextTargetPath = crowd.getAgentNextTargetPath(agentIndex);
+const agentState = crowd.getAgentState(agentIndex);
+const agentCorners = crowd.getAgentCorners(agentIndex);
+const agentParameters = crowd.getAgentParameters(agentIndex);
+
+/* tell the agent to move to a target position */
+const targetPosition = { x: 0, y: 0, z: 0 };
+crowd.goto(agentIndex, targetPosition);
+
+/* teleport the agent to a position */
+crowd.teleport(agentIndex, targetPosition);
+
+/* update some parameters of the agent */
+crowd.updateAgentParameters(agentIndex, {
+  maxAcceleration: 4.0,
+});
+
+/* set all parameters for an agent */
+crowd.setAgentParameters(agentIndex, {
+  // any omitted parameters will be set to their default values
+});
+
+/* destroy the agent */
+crowd.removeAgent(agentIndex);
+```
+
+### Debugging
+
+You can use `getDebugNavMesh` to get a debug representation of the NavMesh.
+
+```ts
+const debugNavMesh = navMesh.getDebugNavMesh();
+
+const { positions, indices } = debugNavMesh.positions;
+```
+
+If you are using `@recast-navigation/three`, you can use `NavMeshHelper` to easily visualize the NavMesh.
+
+### Exporting and Importing a NavMesh
+
+```ts
+const navMeshData: Uint8Array = navMesh.getNavMeshData();
+
+const newNavMesh = new NavMesh();
+newNavMesh.buildFromNavMeshData(navMeshData);
+```

package/index.d.ts

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

package/index.js

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

package/package.json

@@ -0,0 +1,89 @@
+{
+  "name": "recast-navigation",
+  "description": "Recast Navigation for JavaScript!",
+  "keywords": [
+    "recastnavigation",
+    "recast-navigation",
+    "recast",
+    "detour",
+    "navmesh",
+    "pathfinding",
+    "navigation",
+    "crowd-simulation",
+    "wasm",
+    "webassembly"
+  ],
+  "author": {
+    "name": "Isaac Mason",
+    "email": "isaac@isaacmason.com",
+    "url": "https://isaacmason.com/"
+  },
+  "version": "0.0.0-development-0",
+  "license": "MIT",
+  "homepage": "https://github.com/isaac-mason/recast-navigation-js",
+  "bugs": {
+    "url": "https://github.com/isaac-mason/recast-navigation-js/issues"
+  },
+  "type": "module",
+  "main": "./index.js",
+  "types": "./index.d.ts",
+  "exports": {
+    ".": {
+      "import": "./index.js"
+    },
+    "./three": {
+      "import": "./three.js"
+    }
+  },
+  "files": [
+    "index.js",
+    "index.d.ts",
+    "three.js",
+    "three.d.ts",
+    "LICENSE",
+    "README.md"
+  ],
+  "scripts": {
+    "build": "rollup --config rollup.config.js --bundleConfigAsCjs",
+    "storybook": "start-storybook -p 6006",
+    "build-storybook": "build-storybook"
+  },
+  "dependencies": {
+    "@recast-navigation/core": "0.0.0-development-0",
+    "@recast-navigation/three": "0.0.0-development-0"
+  },
+  "peerDependencies": {
+    "three": "^0.150.1"
+  },
+  "devDependencies": {
+    "@babel/core": "^7.21.3",
+    "@mdx-js/react": "^1.6.22",
+    "@react-three/csg": "^2.2.0",
+    "@react-three/drei": "^9.58.5",
+    "@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": "^6.5.16",
+    "@storybook/addon-docs": "^6.5.16",
+    "@storybook/addon-essentials": "^6.5.16",
+    "@storybook/addon-interactions": "^6.5.16",
+    "@storybook/addon-links": "^6.5.16",
+    "@storybook/builder-vite": "^0.4.2",
+    "@storybook/builder-webpack4": "^6.5.16",
+    "@storybook/manager-webpack4": "^6.5.16",
+    "@storybook/react": "^6.5.16",
+    "@types/react": "^18.0.28",
+    "@types/react-dom": "^18.0.11",
+    "@types/three": "^0.150.0",
+    "babel-loader": "^8.3.0",
+    "rollup": "^3.20.0",
+    "rollup-plugin-copy": "^3.4.0",
+    "rollup-plugin-filesize": "^10.0.0",
+    "suspend-react": "^0.0.9",
+    "three": "^0.150.1"
+  },
+  "packageManager": "yarn@3.2.2"
+}

package/three.d.ts

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

package/three.js

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