https://github.com/schlechtwetterfront/rfw
2D rendering library for WebGL.
https://github.com/schlechtwetterfront/rfw
javascript rendering typescript visualization webgl
Last synced: 3 months ago
JSON representation
2D rendering library for WebGL.
- Host: GitHub
- URL: https://github.com/schlechtwetterfront/rfw
- Owner: Schlechtwetterfront
- License: mit
- Created: 2024-04-01T15:45:20.000Z (about 1 year ago)
- Default Branch: main
- Last Pushed: 2025-02-15T14:21:40.000Z (4 months ago)
- Last Synced: 2025-02-15T14:22:52.555Z (4 months ago)
- Topics: javascript, rendering, typescript, visualization, webgl
- Language: TypeScript
- Homepage: https://schlechtwetterfront.github.io/rfw/
- Size: 821 KB
- Stars: 0
- Watchers: 1
- Forks: 0
- Open Issues: 0
-
Metadata Files:
- Readme: README.md
- License: LICENSE
Awesome Lists containing this project
README
# `rfw` [](https://www.npmjs.com/package/rfw2d)
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`:
```sh
npm install rfw2d
```
And import from `rfw2d`:
```ts
import { Vec2 } from 'rfw2d';
```
For more instructions and samples, check out the [Guide](https://schlechtwetterfront.github.io/rfw/guide/).
## Contribute
### Development
Use `npm run dev ` to run any of the apps in a Vite dev web server. E.g.:
```sh
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](https://opensource.org/licenses/MIT)