@inglorious/engine 0.1.0 → 0.1.1

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@inglorious/engine",
-  "version": "0.1.0",
+  "version": "0.1.1",
   "description": "A JavaScript game engine written with global state, immutability, and pure functions in mind. Have fun(ctional programming) with it!",
   "author": "IceOnFire <antony.mistretta@gmail.com> (https://ingloriouscoderz.it)",
   "license": "MIT",
@@ -29,16 +29,6 @@
   "publishConfig": {
     "access": "public"
   },
-  "scripts": {
-    "lint": "eslint . --ext js,jsx --report-unused-disable-directives --max-warnings 0",
-    "format": "prettier --write '**/*.{js,jsx}'",
-    "test:watch": "vitest",
-    "test": "vitest run",
-    "start": "serve",
-    "storybook": "storybook dev -p 6006",
-    "build-storybook": "storybook build",
-    "prepare": "husky"
-  },
   "dependencies": {
     "immer": "^10.1.1",
     "react": "^19.0.0",
@@ -72,5 +62,14 @@
     "storybook": "^8.6.12",
     "vite": "^4.4.5",
     "vitest": "^0.34.3"
+  },
+  "scripts": {
+    "lint": "eslint . --ext js,jsx --report-unused-disable-directives --max-warnings 0",
+    "format": "prettier --write '**/*.{js,jsx}'",
+    "test:watch": "vitest",
+    "test": "vitest run",
+    "start": "serve",
+    "storybook": "storybook dev -p 6006",
+    "build-storybook": "storybook build"
   }
-}
+}

package/src/docs/ai/movement/dynamic/align.js

@@ -1,131 +0,0 @@
-import align, {
-  DEFAULT_SLOW_RADIUS,
-  DEFAULT_TARGET_RADIUS,
-  DEFAULT_TIME_TO_TARGET,
-} from "@inglorious/engine/ai/movement/dynamic/align.js"
-import { clampToBounds } from "@inglorious/game/bounds.js"
-import { enableCharacter } from "@inglorious/game/decorators/character.js"
-import {
-  createControls,
-  enableControls,
-} from "@inglorious/game/decorators/input/controls.js"
-import { enableMouse } from "@inglorious/game/decorators/input/mouse.js"
-import { merge } from "@inglorious/utils/data-structures/objects.js"
-import { clamp } from "@inglorious/utils/math/numbers.js"
-import { pi } from "@inglorious/utils/math/trigonometry.js"
-
-export default {
-  types: {
-    mouse: [
-      enableMouse(),
-      {
-        "field:change"(instance, event) {
-          const { id, value } = event.payload
-          if (id === "targetOrientation") {
-            instance.orientation = -value * pi()
-          }
-        },
-
-        "game:update"(instance, event, options) {
-          const { input0 } = options.instances
-
-          if (input0.left || input0.up) {
-            instance.orientation += 0.1
-          } else if (input0.right || input0.down) {
-            instance.orientation -= 0.1
-          }
-          instance.orientation = clamp(instance.orientation, -pi(), pi())
-        },
-      },
-    ],
-
-    ...enableControls(),
-
-    character: [
-      enableCharacter(),
-      {
-        "game:update"(instance, event, { dt, instances }) {
-          const target = instances.mouse
-          const { fields } = instances.parameters.groups.align
-
-          merge(
-            instance,
-            align(instance, target, {
-              dt,
-              targetRadius: fields.targetRadius.value,
-              slowRadius: fields.slowRadius.value,
-              timeToTarget: fields.timeToTarget.value,
-            }),
-          )
-
-          clampToBounds(instance, instances.game.bounds)
-        },
-      },
-    ],
-
-    form: {
-      "field:change"(instance, event) {
-        const { id, value } = event.payload
-        instance.groups.align.fields[id].value = value
-      },
-    },
-  },
-
-  instances: {
-    mouse: {
-      type: "mouse",
-      position: [400, 0, 300],
-      orientation: 0,
-    },
-
-    ...createControls("input0", {
-      ArrowLeft: "left",
-      ArrowRight: "right",
-      ArrowDown: "down",
-      ArrowUp: "up",
-    }),
-
-    character: {
-      type: "character",
-      maxAngularSpeed: pi() / 4,
-      maxAngularAcceleration: 10,
-      position: [400, 0, 300],
-    },
-
-    parameters: {
-      type: "form",
-      position: [800 - 328, 0, 600],
-      groups: {
-        align: {
-          title: "Dynamic Align",
-          fields: {
-            targetRadius: {
-              label: "Target Radius",
-              inputType: "number",
-              defaultValue: DEFAULT_TARGET_RADIUS,
-            },
-            slowRadius: {
-              label: "Slow Radius",
-              inputType: "number",
-              defaultValue: DEFAULT_SLOW_RADIUS,
-            },
-            timeToTarget: {
-              label: "Time To Target",
-              inputType: "number",
-              step: 0.1,
-              defaultValue: DEFAULT_TIME_TO_TARGET,
-            },
-            targetOrientation: {
-              label: "Target Orientation",
-              inputType: "number",
-              step: 0.25,
-              min: -1,
-              max: 1,
-              defaultValue: 0,
-            },
-          },
-        },
-      },
-    },
-  },
-}

package/src/docs/ai/movement/dynamic/arrive.js

@@ -1,88 +0,0 @@
-import arrive, {
-  DEFAULT_SLOW_RADIUS,
-  DEFAULT_TARGET_RADIUS,
-  DEFAULT_TIME_TO_TARGET,
-} from "@inglorious/engine/ai/movement/dynamic/arrive.js"
-import { clampToBounds } from "@inglorious/game/bounds.js"
-import { enableCharacter } from "@inglorious/game/decorators/character.js"
-import { enableMouse } from "@inglorious/game/decorators/input/mouse.js"
-import { merge } from "@inglorious/utils/data-structures/objects.js"
-
-export default {
-  types: {
-    mouse: [enableMouse()],
-
-    character: [
-      enableCharacter(),
-      {
-        "game:update"(instance, event, { dt, instances }) {
-          const target = instances.mouse
-          const { fields } = instances.parameters.groups.arrive
-
-          merge(
-            instance,
-            arrive(instance, target, {
-              dt,
-              targetRadius: fields.targetRadius.value,
-              slowRadius: fields.slowRadius.value,
-              timeToTarget: fields.timeToTarget.value,
-            }),
-          )
-
-          clampToBounds(instance, instances.game.bounds)
-        },
-      },
-    ],
-
-    form: {
-      "field:change"(instance, event) {
-        const { id, value } = event.payload
-        instance.groups.arrive.fields[id].value = value
-      },
-    },
-  },
-
-  instances: {
-    mouse: {
-      type: "mouse",
-      position: [400, 0, 300],
-    },
-
-    character: {
-      type: "character",
-      maxAcceleration: 1000,
-      maxSpeed: 250,
-      position: [400, 0, 300],
-    },
-
-    parameters: {
-      type: "form",
-      position: [800 - 328, 0, 600],
-      groups: {
-        arrive: {
-          title: "Dynamic Arrive",
-          fields: {
-            targetRadius: {
-              label: "Target Radius",
-              inputType: "number",
-              step: 0.1,
-              defaultValue: DEFAULT_TARGET_RADIUS,
-            },
-            slowRadius: {
-              label: "Slow Radius",
-              inputType: "number",
-              step: 0.1,
-              defaultValue: DEFAULT_SLOW_RADIUS,
-            },
-            timeToTarget: {
-              label: "Time To Target",
-              inputType: "number",
-              step: 0.1,
-              defaultValue: DEFAULT_TIME_TO_TARGET,
-            },
-          },
-        },
-      },
-    },
-  },
-}

package/src/docs/ai/movement/dynamic/dynamic.mdx

@@ -1,99 +0,0 @@
-import { Canvas, Meta, Source } from '@storybook/blocks'
-import * as Dynamic from './dynamic.stories'
-
-import arrive from './arrive?raw'
-import flee from './flee?raw'
-import pursue from './pursue?raw'
-import evade from './evade?raw'
-import seek from './seek?raw'
-import wander from './wander?raw'
-import lookWhereYoureGoing from './look-where-youre-going?raw'
-import face from './face?raw'
-import align from './align?raw'
-import matchVelocity from './match-velocity?raw'
-
-<Meta of={Dynamic} />
-
-# Dynamic Movement
-
-The algorithms described here make an NPC instance move by applying forces, which in turn affect its acceleration and velocity. The movement is much smoother and more realistic than its [kinematic](/docs/ai-movement-kinematic--docs) counterpart.
-
-Every algorithm returns a steering object, which contains a linear and an angular acceleration. These can be used to update the instance's velocity and orientation.
-
-Most examples here make use of user [input](/?path=/docs/games-input--docs), so check those out if you haven't already.
-
-## Seek
-
-The seek algorithm makes the instance chase a target. The movement is much smoother than its kinematic counterpart.
-
-<Source dark code={seek} />
-
-<Canvas of={Dynamic.Seek} />
-
-## Flee
-
-The flee algorithm is the exact opposite of seek: the instance will run away from the target.
-
-<Source dark code={flee} />
-
-<Canvas of={Dynamic.Flee} />
-
-## Arrive
-
-The arrive algorithm is a more refined version of seek: the instance will slow down as it approaches the target, and the movement is much smoother.
-
-<Source dark code={arrive} />
-
-<Canvas of={Dynamic.Arrive} />
-
-## Pursue
-
-The pursue algorithm is an enhanced version of seek. It predicts the future position of a moving target and seeks that position.
-
-<Source dark code={pursue} />
-
-<Canvas of={Dynamic.Pursue} />
-
-## Evade
-
-Evade is the opposite of pursue. It predicts the future position of a moving target and flees from it.
-
-<Source dark code={evade} />
-
-<Canvas of={Dynamic.Evade} />
-
-## Wander
-
-The wander algorithm makes the instance move around randomly, but in a smooth and realistic way.
-
-<Source dark code={wander} />
-
-<Canvas of={Dynamic.Wander} />
-
-## Look Where You're Going
-
-A simple but effective algorithm that aligns the character's orientation with its direction of movement.
-
-<Source dark code={lookWhereYoureGoing} />
-
-<Canvas of={Dynamic.LookWhereYoureGoing} />
-
-## Align and Face
-
-The `align` algorithm makes the instance rotate to match the target's orientation, while `face` makes it rotate to look at the target's position. They are smoother versions of their kinematic counterparts.
-
-<Source dark code={align} />
-
-<Canvas of={Dynamic.Align} />
-
-<Source dark code={face} />
-
-<Canvas of={Dynamic.Face} />
-
-## Match Velocity
-
-This algorithm adjusts the instance's velocity to match the target's velocity. It's a key component for flocking behaviors.
-
-<Source dark code={matchVelocity} />
-
-<Canvas of={Dynamic.MatchVelocity} />

package/src/docs/ai/movement/dynamic/dynamic.stories.js

@@ -1,58 +0,0 @@
-import UiChooser from "@inglorious/docs/ui-chooser.jsx"
-
-import align from "./align.js"
-import arrive from "./arrive.js"
-import evade from "./evade.js"
-import face from "./face.js"
-import flee from "./flee.js"
-import lookWhereYoureGoing from "./look-where-youre-going.js"
-import matchVelocity from "./match-velocity.js"
-import pursue from "./pursue.js"
-import seek from "./seek.js"
-import wander from "./wander.js"
-
-export default {
-  title: "Engine/AI/Movement/Dynamic",
-  component: UiChooser,
-}
-
-export const Seek = {
-  args: { config: seek },
-}
-
-export const Flee = {
-  args: { config: flee },
-}
-
-export const Arrive = {
-  args: { config: arrive },
-}
-
-export const Pursue = {
-  args: { config: pursue },
-}
-
-export const Evade = {
-  args: { config: evade },
-}
-
-export const Wander = {
-  args: { config: wander },
-}
-
-export const LookWhereYoureGoing = {
-  name: "Look Where You're Going",
-  args: { config: lookWhereYoureGoing },
-}
-
-export const Align = {
-  args: { config: align },
-}
-
-export const Face = {
-  args: { config: face },
-}
-
-export const MatchVelocity = {
-  args: { config: matchVelocity },
-}

package/src/docs/ai/movement/dynamic/evade.js

@@ -1,72 +0,0 @@
-import evade, {
-  DEFAULT_MAX_PREDICTION,
-} from "@inglorious/engine/ai/movement/dynamic/evade.js"
-import { clampToBounds } from "@inglorious/game/bounds.js"
-import { enableCharacter } from "@inglorious/game/decorators/character.js"
-import { enableMouse } from "@inglorious/game/decorators/input/mouse.js"
-import { merge } from "@inglorious/utils/data-structures/objects.js"
-
-export default {
-  types: {
-    mouse: [enableMouse()],
-
-    character: [
-      enableCharacter(),
-      {
-        "game:update"(instance, event, { dt, instances }) {
-          const target = instances.mouse
-          const { fields } = instances.parameters.groups.evade
-
-          merge(
-            instance,
-            evade(instance, target, {
-              dt,
-              maxPrediction: fields.maxPrediction.value,
-            }),
-          )
-
-          clampToBounds(instance, instances.game.bounds)
-        },
-      },
-    ],
-
-    form: {
-      "field:change"(instance, event) {
-        const { id, value } = event.payload
-        instance.groups.evade.fields[id].value = value
-      },
-    },
-  },
-
-  instances: {
-    mouse: {
-      type: "mouse",
-      position: [400, 0, 300],
-      velocity: [0, 0, 0],
-    },
-
-    character: {
-      type: "character",
-      maxAcceleration: 1000,
-      maxSpeed: 250,
-      position: [400, 0, 300],
-    },
-
-    parameters: {
-      type: "form",
-      position: [800 - 343, 0, 600],
-      groups: {
-        evade: {
-          title: "Evade",
-          fields: {
-            maxPrediction: {
-              label: "Max Prediction",
-              inputType: "number",
-              defaultValue: DEFAULT_MAX_PREDICTION,
-            },
-          },
-        },
-      },
-    },
-  },
-}

package/src/docs/ai/movement/dynamic/face.js

@@ -1,90 +0,0 @@
-import {
-  DEFAULT_SLOW_RADIUS,
-  DEFAULT_TARGET_RADIUS,
-  DEFAULT_TIME_TO_TARGET,
-} from "@inglorious/engine/ai/movement/dynamic/align.js"
-import face from "@inglorious/engine/ai/movement/dynamic/face.js"
-import { clampToBounds } from "@inglorious/game/bounds.js"
-import { enableCharacter } from "@inglorious/game/decorators/character.js"
-import { enableMouse } from "@inglorious/game/decorators/input/mouse.js"
-import { merge } from "@inglorious/utils/data-structures/objects.js"
-import { pi } from "@inglorious/utils/math/trigonometry.js"
-
-export default {
-  types: {
-    mouse: [enableMouse()],
-
-    character: [
-      enableCharacter(),
-      {
-        "game:update"(instance, event, { dt, instances }) {
-          const target = instances.mouse
-          const { fields } = instances.parameters.groups.face
-
-          merge(
-            instance,
-            face(instance, target, {
-              dt,
-              targetRadius: fields.targetRadius.value,
-              slowRadius: fields.slowRadius.value,
-              timeToTarget: fields.timeToTarget.value,
-            }),
-          )
-
-          clampToBounds(instance, instances.game.bounds)
-        },
-      },
-    ],
-
-    form: {
-      "field:change"(instance, event) {
-        const { id, value } = event.payload
-        instance.groups.face.fields[id].value = value
-      },
-    },
-  },
-
-  instances: {
-    mouse: {
-      type: "mouse",
-      position: [400, 0, 300],
-    },
-
-    character: {
-      type: "character",
-      maxAngularSpeed: pi() / 4,
-      maxAngularAcceleration: 1000,
-      position: [400, 0, 300],
-    },
-
-    parameters: {
-      type: "form",
-      position: [800 - 328, 0, 600],
-      groups: {
-        face: {
-          title: "Face",
-          fields: {
-            targetRadius: {
-              label: "Target Radius",
-              inputType: "number",
-              step: 0.1,
-              defaultValue: DEFAULT_TARGET_RADIUS,
-            },
-            slowRadius: {
-              label: "Slow Radius",
-              inputType: "number",
-              step: 0.1,
-              defaultValue: DEFAULT_SLOW_RADIUS,
-            },
-            timeToTarget: {
-              label: "Time To Target",
-              inputType: "number",
-              step: 0.1,
-              defaultValue: DEFAULT_TIME_TO_TARGET,
-            },
-          },
-        },
-      },
-    },
-  },
-}

package/src/docs/ai/movement/dynamic/flee.js

@@ -1,38 +0,0 @@
-import flee from "@inglorious/engine/ai/movement/dynamic/flee.js"
-import { clampToBounds } from "@inglorious/game/bounds.js"
-import { enableCharacter } from "@inglorious/game/decorators/character.js"
-import { enableMouse } from "@inglorious/game/decorators/input/mouse.js"
-import { merge } from "@inglorious/utils/data-structures/objects.js"
-
-export default {
-  types: {
-    mouse: [enableMouse()],
-
-    character: [
-      enableCharacter(),
-      {
-        "game:update"(instance, event, { dt, instances }) {
-          const target = instances.mouse
-
-          merge(instance, flee(instance, target, { dt }))
-
-          clampToBounds(instance, instances.game.bounds)
-        },
-      },
-    ],
-  },
-
-  instances: {
-    mouse: {
-      type: "mouse",
-      position: [400, 0, 300],
-    },
-
-    character: {
-      type: "character",
-      maxAcceleration: 1000,
-      maxSpeed: 250,
-      position: [400, 0, 300],
-    },
-  },
-}