Package Exports
- @beetpx/beetpx
- @beetpx/beetpx/dist/index.js
This package does not declare an exports field, so the exports above have been automatically detected and optimized by JSPM instead. If any package subpath is missing, it is recommended to post an issue to the original package (@beetpx/beetpx) to support the "exports" field. If that is not possible, create a JSPM override to customize the exports field for this package.
Readme
BeetPx
.png){kind=logo}
A mini framework for low-res browser games, written in TypeScript.
Getting Started
Add it to your project with:
npm install --save-dev --save-exact @beetpx/beetpxIt might make sense in a future to drop --save-exact flag, but for now better be safe than sorry – in this early phase
of development the framework constantly evolves and quite often breaking changes are introduced.
There is a simple example in ./examples/simple/ . Run it as described in its README.
Also, you might want to take a look at how following projects are using BeetPx:
- https://github.com/beetrootpaul/towers-of-survival-beetpx
- https://github.com/beetrootpaul/avoid-your-past-beetpx
API Documentation
For a nicely formatted list of API exposed by BeetPx run:
npm run docsto open it in your default browser. In case of any issues, the website which is supposed to open is located under docs/index.html
Development Setup
This projects is developed on Node.js 14.18.
You might find it helpful to use nvm in order to make sure you use the same Node.js version as which is specified in .nvmrc.
Random Notes
- gamepad input seems to be laggy (at least on Firefox), unsuitable for fast paced games