@pawngine/types

TypeScript type definitions for Pawngine plugin development.

Installation

npm install -D @pawngine/types

Usage

import type { PawnginePlugin, PluginContext, Entity } from "@pawngine/types";

export default {
  name: "@myplugin/hello",
  version: "1.0.0",
  description: "A simple hello world plugin",
  icon: "👋",

  activate(ctx: PluginContext) {
    const pet = ctx.spawn({
      id: "hello-pet",
      type: "pet",
      tags: ["character"],
    });

    ctx.renderer.attach(pet, { type: "text", content: "👋" });

    ctx.onUpdate((dt) => {
      // Update logic runs every frame
    });
  },
} satisfies PawnginePlugin;

What's Included

• PawnginePlugin — Plugin interface
• PluginContext — Full plugin API (ctx)
• Entity, Transform, Vec2 — ECS types
• EngineEvents, EntityEvents — Event maps
• SettingsSchema, SettingField — Plugin settings
• ComponentTypeMap — Extensible component registry
• Hook types: SyncHook, SyncBailHook, SyncWaterfallHook, AsyncSeriesHook
• SystemDef, PipelineBuilder, Query — Systems and queries

License

MIT