@inglorious/engine 0.1.0 → 0.2.0

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

@@ -1,71 +0,0 @@
-import wander, {
-  DEFAULT_WANDER_OFFSET,
-  DEFAULT_WANDER_RADIUS,
-} from "@inglorious/engine/ai/movement/dynamic/wander.js"
-import { flip } from "@inglorious/game/bounds.js"
-import { enableCharacter } from "@inglorious/game/decorators/character.js"
-import { merge } from "@inglorious/utils/data-structures/objects.js"
-import { pi } from "@inglorious/utils/math/trigonometry.js"
-
-export default {
-  types: {
-    character: [
-      enableCharacter(),
-      {
-        "game:update"(instance, event, { dt, instances }) {
-          const { fields } = instances.parameters.groups.wander
-
-          merge(
-            instance,
-            wander(instance, {
-              dt,
-              wanderOffset: fields.wanderOffset.value,
-              wanderRadius: fields.wanderRadius.value,
-            }),
-          )
-          flip(instance, instances.game.bounds)
-        },
-      },
-    ],
-
-    form: {
-      "field:change"(instance, event) {
-        const { id, value } = event.payload
-        instance.groups.wander.fields[id].value = value
-      },
-    },
-  },
-
-  instances: {
-    character: {
-      type: "character",
-      maxAcceleration: 1000,
-      maxSpeed: 250,
-      maxAngularSpeed: pi() / 4,
-      position: [400, 0, 300],
-    },
-
-    parameters: {
-      type: "form",
-      position: [800 - 352, 0, 600],
-      groups: {
-        wander: {
-          title: "Dynamic Wander",
-          fields: {
-            wanderOffset: {
-              label: "Wander Offset",
-              inputType: "number",
-              defaultValue: DEFAULT_WANDER_OFFSET,
-            },
-            wanderRadius: {
-              label: "Wander Radius",
-              inputType: "number",
-              step: 0.1,
-              defaultValue: DEFAULT_WANDER_RADIUS,
-            },
-          },
-        },
-      },
-    },
-  },
-}

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

@@ -1,122 +0,0 @@
-import align, {
-  DEFAULT_TARGET_RADIUS,
-  DEFAULT_TIME_TO_TARGET,
-} from "@inglorious/engine/ai/movement/kinematic/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,
-              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,
-      position: [400, 0, 300],
-    },
-
-    parameters: {
-      type: "form",
-      position: [800 - 328, 0, 600],
-      groups: {
-        align: {
-          title: "Kinematic Align",
-          fields: {
-            targetRadius: {
-              label: "Target Radius",
-              inputType: "number",
-              defaultValue: DEFAULT_TARGET_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/kinematic/arrive.js

@@ -1,78 +0,0 @@
-import arrive, {
-  DEFAULT_TARGET_RADIUS,
-  DEFAULT_TIME_TO_TARGET,
-} from "@inglorious/engine/ai/movement/kinematic/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,
-              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",
-      maxSpeed: 250,
-      position: [400, 0, 300],
-    },
-
-    parameters: {
-      type: "form",
-      position: [800 - 328, 0, 600],
-      groups: {
-        arrive: {
-          title: "Kinematic Arrive",
-          fields: {
-            targetRadius: {
-              label: "Target Radius",
-              inputType: "number",
-              defaultValue: DEFAULT_TARGET_RADIUS,
-            },
-            timeToTarget: {
-              label: "Time To Target",
-              inputType: "number",
-              step: 0.1,
-              defaultValue: DEFAULT_TIME_TO_TARGET,
-            },
-          },
-        },
-      },
-    },
-  },
-}

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

@@ -1,82 +0,0 @@
-import {
-  DEFAULT_TARGET_RADIUS,
-  DEFAULT_TIME_TO_TARGET,
-} from "@inglorious/engine/ai/movement/kinematic/align.js"
-import face from "@inglorious/engine/ai/movement/kinematic/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,
-              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,
-            },
-            timeToTarget: {
-              label: "Time To Target",
-              inputType: "number",
-              step: 0.1,
-              defaultValue: DEFAULT_TIME_TO_TARGET,
-            },
-          },
-        },
-      },
-    },
-  },
-}

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

@@ -1,36 +0,0 @@
-import flee from "@inglorious/engine/ai/movement/kinematic/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",
-      maxSpeed: 250,
-      position: [400, 0, 300],
-    },
-  },
-}

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

@@ -1,67 +0,0 @@
-import { Canvas, Meta, Source } from '@storybook/blocks'
-import * as Kinematic from './kinematic.stories'
-
-import align from './align?raw'
-import arrive from './arrive?raw'
-import flee from './flee?raw'
-import seek from './seek?raw'
-import wander from './wander?raw'
-import wanderAsSeek from './wander-as-seek?raw'
-
-<Meta of={Kinematic} />
-
-# Kinematic Movement
-
-The algorithms described here make an NPC instance move by changing its velocity. The movement is a little snappy but it does the trick for simple games.
-
-Every algorithm returns some parameters, such as velocity, position, and orientation, which can be merged to the instance.
-
-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. Speed is constant and it makes the character flick around the target once reached.
-
-<Source dark code={seek} />
-
-<Canvas of={Kinematic.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={Kinematic.Flee} />
-
-## Arrive
-
-The arrive algorithm is a more refined version of seek: the instance will slow down as it approaches the target.
-
-<Source dark code={arrive} />
-
-<Canvas of={Kinematic.Arrive} />
-
-## Align
-
-The align algorithm makes the instance rotate to match the target's orientation.
-
-<Source dark code={align} />
-
-<Canvas of={Kinematic.Align} />
-
-## Wander
-
-The wander algorithm makes the instance move around randomly. It does so by changing its orientation by a small random amount at each frame.
-
-<Source dark code={wander} />
-
-<Canvas of={Kinematic.Wander} />
-
-## Wander as Seek
-
-This is a simpler version of the wander algorithm that does not require trigonometry. It just seeks a random point in the scene, and once it's reached, it seeks another one.
-
-<Source dark code={wanderAsSeek} />
-
-<Canvas of={Kinematic.WanderAsSeek} />

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

@@ -1,42 +0,0 @@
-import UiChooser from "@inglorious/docs/ui-chooser.jsx"
-
-import align from "./align.js"
-import arrive from "./arrive.js"
-import face from "./face.js"
-import flee from "./flee.js"
-import seek from "./seek.js"
-import wander from "./wander.js"
-import wanderAsSeek from "./wander-as-seek.js"
-
-export default {
-  title: "Engine/AI/Movement/Kinematic",
-  component: UiChooser,
-}
-
-export const Seek = {
-  args: { config: seek },
-}
-
-export const Flee = {
-  args: { config: flee },
-}
-
-export const Arrive = {
-  args: { config: arrive },
-}
-
-export const Align = {
-  args: { config: align },
-}
-
-export const Face = {
-  args: { config: face },
-}
-
-export const Wander = {
-  args: { config: wander },
-}
-
-export const WanderAsSeek = {
-  args: { config: wanderAsSeek },
-}

package/src/docs/ai/movement/kinematic/seek.js

@@ -1,34 +0,0 @@
-import seek from "@inglorious/engine/ai/movement/kinematic/seek.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, seek(instance, target, { dt }))
-        },
-      },
-    ],
-  },
-
-  instances: {
-    mouse: {
-      type: "mouse",
-      position: [400, 0, 300],
-    },
-
-    character: {
-      type: "character",
-      maxSpeed: 250,
-      position: [400, 0, 300],
-    },
-  },
-}

package/src/docs/ai/movement/kinematic/wander-as-seek.js

@@ -1,62 +0,0 @@
-import wanderAsSeek, {
-  DEFAULT_WANDER_RADIUS,
-} from "@inglorious/engine/ai/movement/kinematic/wander-as-seek.js"
-import { flip } from "@inglorious/game/bounds.js"
-import { enableCharacter } from "@inglorious/game/decorators/character.js"
-import { merge } from "@inglorious/utils/data-structures/objects.js"
-import { pi } from "@inglorious/utils/math/trigonometry.js"
-
-export default {
-  types: {
-    character: [
-      enableCharacter(),
-      {
-        "game:update"(instance, event, { dt, instances }) {
-          const { fields } = instances.parameters.groups.wanderAsSeek
-
-          merge(
-            instance,
-            wanderAsSeek(instance, {
-              dt,
-              wanderRadius: fields.wanderRadius.value,
-            }),
-          )
-          flip(instance, instances.game.bounds)
-        },
-      },
-    ],
-
-    form: {
-      "field:change"(instance, event) {
-        const { id, value } = event.payload
-        instance.groups.wanderAsSeek.fields[id].value = value
-      },
-    },
-  },
-
-  instances: {
-    character: {
-      type: "character",
-      maxSpeed: 250,
-      maxAngularSpeed: pi() / 4,
-      position: [400, 0, 300],
-    },
-
-    parameters: {
-      type: "form",
-      position: [800 - 352, 0, 600],
-      groups: {
-        wanderAsSeek: {
-          title: "Wander As Seek",
-          fields: {
-            wanderRadius: {
-              label: "Wander Radius",
-              inputType: "number",
-              defaultValue: DEFAULT_WANDER_RADIUS,
-            },
-          },
-        },
-      },
-    },
-  },
-}

package/src/docs/ai/movement/kinematic/wander.js

@@ -1,28 +0,0 @@
-import wander from "@inglorious/engine/ai/movement/kinematic/wander.js"
-import { flip } from "@inglorious/game/bounds.js"
-import { enableCharacter } from "@inglorious/game/decorators/character.js"
-import { merge } from "@inglorious/utils/data-structures/objects.js"
-import { pi } from "@inglorious/utils/math/trigonometry.js"
-
-export default {
-  types: {
-    character: [
-      enableCharacter(),
-      {
-        "game:update"(instance, event, { dt, instances }) {
-          merge(instance, wander(instance, { dt }))
-          flip(instance, instances.game.bounds)
-        },
-      },
-    ],
-  },
-
-  instances: {
-    character: {
-      type: "character",
-      maxSpeed: 250,
-      maxAngularSpeed: pi() / 4,
-      position: [400, 0, 300],
-    },
-  },
-}

package/src/docs/bounds.js

@@ -1,7 +0,0 @@
-export default {
-  instances: {
-    game: {
-      bounds: [0, 0, 600, 800],
-    },
-  },
-}

package/src/docs/code-reuse.js

@@ -1,35 +0,0 @@
-import { bounce } from "@inglorious/game/bounds.js"
-import { enableCharacter } from "@inglorious/game/decorators/character.js"
-import { enableFps } from "@inglorious/game/decorators/fps.js"
-import { merge } from "@inglorious/utils/data-structures/objects.js"
-import { zero } from "@inglorious/utils/math/linear-algebra/vector.js"
-import { pi } from "@inglorious/utils/math/trigonometry.js"
-
-export default {
-  types: {
-    character: [
-      enableCharacter(),
-      {
-        "game:update"(instance, event, options) {
-          merge(instance, bounce(instance, options))
-        },
-      },
-    ],
-
-    fps: [enableFps()],
-  },
-
-  instances: {
-    character: {
-      type: "character",
-      maxSpeed: 250,
-      orientation: pi() / 6,
-      position: zero(),
-    },
-
-    fps: {
-      type: "fps",
-      position: [0, 0, 600],
-    },
-  },
-}