@vulfram/engine

Functional engine for the Vulfram core, focused on a simple API for creating worlds, entities, and mounting to targets.

Installation

bun add @vulfram/engine @vulfram/transport-browser

Use the transport that fits your environment (transport-browser, transport-bun, transport-napi).

Simple example

import { initEngine, tick } from '@vulfram/engine/core';
import { createWindow } from '@vulfram/engine/window';
import { mountWorldToWindow } from '@vulfram/engine/mount';
import * as World3D from '@vulfram/engine/world3d';
import { transportWasm } from '@vulfram/transport-browser';

initEngine({ transport: transportWasm });

const world = World3D.create3DWorld();
const { windowId } = createWindow({
  title: 'Vulfram Engine - Simple Demo',
  size: [1280, 720],
  position: [100, 100],
  initialState: 'windowed',
});

mountWorldToWindow(world, windowId);

const camera = World3D.create3DEntity(world);
World3D.create3DCamera(world, camera, {
  kind: 'perspective',
  near: 0.1,
  far: 100,
  order: 0,
});
World3D.update3DTransform(world, camera, {
  position: [0, 1.2, 4],
  rotation: [0, 0, 0, 1],
  scale: [1, 1, 1],
});

const light = World3D.create3DEntity(world);
World3D.create3DLight(world, light, {
  kind: 'directional',
  color: [1, 1, 1],
  intensity: 2,
});
World3D.update3DTransform(world, light, {
  position: [3, 6, 2],
  rotation: [0, 0, 0, 1],
  scale: [1, 1, 1],
});

const geom = World3D.create3DGeometry(world, { type: 'primitive', shape: 'cube' });
const mat = World3D.create3DMaterial(world, {
  kind: 'standard',
  options: {
    type: 'standard',
    content: {
      baseColor: [0.9, 0.2, 0.2, 1],
      surfaceType: 'opaque',
      flags: 0,
    },
  },
});

const cube = World3D.create3DEntity(world);
World3D.create3DModel(world, cube, { geometryId: geom, materialId: mat });
World3D.update3DTransform(world, cube, {
  position: [0, 0, 0],
  rotation: [0, 0, 0, 1],
  scale: [1, 1, 1],
});

let last = performance.now();
function frame(now: number) {
  const dt = now - last;
  last = now;
  tick(now, dt);
  requestAnimationFrame(frame);
}
requestAnimationFrame(frame);

Public module structure

• @vulfram/engine/core: init, tick, dispose, system/component registration
• @vulfram/engine/window: window APIs
• @vulfram/engine/world3d: 3D world APIs
• @vulfram/engine/world-ui: UI world APIs
• @vulfram/engine/mount: world binding to targets/windows
• @vulfram/engine/ecs: ECS types
• @vulfram/engine/types: command/event types

Documentation

Temporary documentation URL:

• https://vulppi.dev/vulfram/docs

When the final engine documentation URL is available, this README will be updated.