Docs & Guides

1 · Install

BOOMKIT is a single package with zero dependencies. npm, a CDN, or just a script tag:

# npm
npm install boomkit

# or CDN
<script src="https://cdn.boomkit.dev/boomkit.js"></script>

2 · Your first game

Boot the engine and add a player. That's the whole skeleton:

import boomkit from "boomkit";

boomkit();

const bomb = add([
  sprite("bomb"),
  pos(center()),
  body(),
]);

3 · Blocks, not classes

Everything is a block: small pieces of behavior you attach to a game object. Combine them however you like — sprite(), pos(), body(), area(), health() — and BOOMKIT composes them for you.

Custom blocks are just functions that return an object. Write one, reuse it everywhere:

const explodeOnTouch = () => ({
  id: "explosive",
  onCollide() { destroy(this); addKaboom(this.pos); },
});

4 · TypeScript friendly

BOOMKIT is written in TypeScript and ships its own types. Your blocks get autocompletion, your game objects get typed events — no config, no generation step.

const bomb = add([
  sprite("bomb"),
  pos(center()),
  area(),
  "player", // tag
]);

bomb.onCollide("enemy", (e) => {
  bomb.hurt(1);
});