Skip to content

Schlechtwetterfront/rfw

Repository files navigation

rfw npm

Documentation · Samples · Reference

2D rendering library for WebGL.

  • Get started easily with apps, providing a default "bundle" of systems to create your application from
  • Tickers: run logic in a manner similar to ECS systems
  • Scene (graphs)
  • Low abstraction render tooling
  • Math utility modules
  • Change tracking
  • Performance in mind
  • Minimal dependencies

Getting Started

Install the package from npm:

npm install rfw2d

And import from rfw2d:

import { Vec2 } from 'rfw2d';

For more instructions and samples, check out the Guide.

Contribute

Development

Use npm run dev <app path> to run any of the apps in a Vite dev web server. E.g.:

npm run dev samples/bunnymark

to run a sample.

Tests

Use npm run test to watch tests and npm run types:watch to continuously check types.

Docs

Use npm run docs:dev to start the doc dev web server. The benchmarks are available under benchmarks/.

The reference is built separately, with npm run reference:build and does not have a dev version.

License

MIT