@bloopjs/engine 0.0.0

package/js/contexts/timeContext.ts

@@ -0,0 +1,31 @@
+export class TimeContext {
+  dataView?: DataView;
+
+  constructor(dataView?: DataView) {
+    this.dataView = dataView;
+  }
+
+  /** The number of fixed timestep frames processed */
+  get frame(): number {
+    if (!this.dataView) {
+      throw new Error("TimeContext DataView is not initialized");
+    }
+    return this.dataView.getUint32(0, true);
+  }
+
+  /** The number of seconds since the last frame */
+  get dt(): number {
+    if (!this.dataView) {
+      throw new Error("TimeContext DataView is not initialized");
+    }
+    return this.dataView.getUint32(4, true) / 1000;
+  }
+
+  /** The total number of seconds since the engine started */
+  get time(): number {
+    if (!this.dataView) {
+      throw new Error("TimeContext DataView is not initialized");
+    }
+    return this.dataView.getUint32(8, true) / 1000;
+  }
+}

package/js/engine.ts

@@ -0,0 +1,34 @@
+export * as Enums from "./codegen/enums";
+export * from "./contexts/inputContext";
+export * from "./contexts/timeContext";
+export * from "./inputs";
+export type * from "./wasmEngine";
+
+/**
+ * A pointer to shared wasm memory space. Use it like
+ *
+ * const dataView = new DataView(wasmMemory.buffer, ptr);
+ */
+export type EnginePointer = number;
+export type EngineLen = number;
+/**
+ * A return value indicating success.
+ *
+ * 0 = success
+ * 1 = failure
+ * other values are function specific error codes
+ */
+export type EngineOk = number;
+
+export const DEFAULT_WASM_URL = new URL("../wasm/bloop.wasm", import.meta.url);
+
+export const TIME_CTX_OFFSET = 0;
+export const INPUT_CTX_OFFSET = TIME_CTX_OFFSET + 4;
+export const EVENTS_OFFSET = INPUT_CTX_OFFSET + 4;
+
+/**
+ * Size of snapshot header in bytes
+ */
+export const SNAPSHOT_HEADER_LEN = 16;
+export const SNAPSHOT_HEADER_USER_LEN_OFFSET = 4;
+export const SNAPSHOT_HEADER_ENGINE_LEN_OFFSET = 8;

package/js/inputs.ts

@@ -0,0 +1,47 @@
+import * as Enums from "./codegen/enums";
+
+// todo - move magic numbers to codegen
+export const MOUSE_OFFSET = 256;
+export const MOUSE_BUTTONS_OFFSET = 16;
+export const KEYBOARD_OFFSET = 0;
+
+export const EVENT_PAYLOAD_SIZE = 8;
+export const EVENT_PAYLOAD_ALIGN = 4;
+
+export type MouseButton = keyof typeof Enums.MouseButton;
+export type Key = keyof typeof Enums.Key;
+
+export function keyToKeyCode(key: Key): Enums.Key {
+  return Enums.Key[key];
+}
+
+export function keyCodeToKey(code: Enums.Key | number): Key {
+  return Enums.Key[code] as Key;
+}
+
+export function mouseButtonToMouseButtonCode(
+  button: MouseButton,
+): Enums.MouseButton {
+  return Enums.MouseButton[button];
+}
+
+export function mouseButtonCodeToMouseButton(
+  code: Enums.MouseButton | number,
+): MouseButton {
+  return Enums.MouseButton[code] as MouseButton;
+}
+
+export type KeyState = {
+  down: boolean;
+  held: boolean;
+  up: boolean;
+};
+
+export type MouseState = {
+  left: KeyState;
+  middle: KeyState;
+  right: KeyState;
+  wheel: { x: number; y: number };
+  x: number;
+  y: number;
+};

package/js/wasmEngine.ts

@@ -0,0 +1,47 @@
+import type * as Enums from "./codegen/enums";
+import type { EngineOk, EnginePointer } from "./engine";
+
+export type WasmEngine = {
+  initialize: () => void;
+  alloc: (size: number) => EnginePointer;
+  free: (ptr: EnginePointer, size: number) => void;
+  register_systems: (cb_handle: number) => void;
+
+  get_time_ctx: () => EnginePointer;
+
+  /**
+   * Step forward one simulation frame
+   */
+  step: (ms: number) => void;
+  /**
+   * Seek to a specific frame number
+   */
+  seek: (frame: number) => void;
+  /**
+   * Start recording inputs to tape
+   */
+  start_recording: (data_len: number, max_events: number) => EngineOk;
+  /**
+   * Whether the engine is currently recording to tape
+   */
+  is_recording: () => boolean;
+  /**
+   * Whether the engine is currently replaying from tape
+   */
+  is_replaying: () => boolean;
+
+  // Input platform events
+  emit_keydown: (key: Enums.Key) => void;
+  emit_keyup: (key: Enums.Key) => void;
+  emit_mousedown: (button: Enums.MouseButton) => void;
+  emit_mouseup: (button: Enums.MouseButton) => void;
+  emit_mousemove: (x: number, y: number) => void;
+  emit_mousewheel: (x: number, y: number) => void;
+
+  /**
+   * Returns a pointer to the snapshot data.
+   */
+  take_snapshot: (data_len: number) => EnginePointer;
+  /** Restores the engine state from a snapshot */
+  restore: (ptr: EnginePointer) => void;
+};

package/package.json

@@ -0,0 +1,37 @@
+{
+  "name": "@bloopjs/engine",
+  "version": "0.0.0",
+  "type": "module",
+  "repository": {
+    "type": "git",
+    "url": "https://github.com/bloopgames/bloop"
+  },
+  "publishConfig": {
+    "access": "public"
+  },
+  "files": [
+    "dist",
+    "js",
+    "wasm"
+  ],
+  "exports": {
+    ".": {
+      "import": "./js/engine.ts",
+      "types": "./js/engine.ts"
+    }
+  },
+  "scripts": {
+    "build": "bun run build:wasm && bun build js/engine.ts --outdir=dist --sourcemap=linked && bun run build:tsc",
+    "build:tsc": "tsc -p publish/tsconfig.publish.json",
+    "build:wasm": "zig build -p .",
+    "ci:tsc": "tsc --noEmit",
+    "check:wasm": "wasm-objdump -x wasm/bloop.wasm",
+    "dev": "zig build -p . --watch"
+  },
+  "devDependencies": {
+    "@types/bun": "latest"
+  },
+  "peerDependencies": {
+    "typescript": "^5"
+  }
+}