SquaredJS
A 2D Tile-Based WebGL Game Engine
Official website with documentation
If you're reading this on npmjs.com, this README is likely more up-to-date on our Github project page.
Alpha - Work In Progress
During the alpha, the npm package might not be kept up-to-date, due to frequent changes in the codebase. To install and use the latest version, follow these steps:
- Clone or download this project
npm run build
cd dist
, then npm link
- In your game project's folder:
npm link squaredjs
More info on npm link.
SquaredJS is a WebGL game engine, built for 2D tile-based games. It is built for amateur developers and hobbyists who want to ship web games quickly and easily.
Don't worry about a dev server, packaging or transpilation, SquaredJS manages that for you and lets you focus on your code. It leverages modern and well-known tools like TypeScript, npm and Webpack 4. It is even compatible out-of-the-box with the Tiled Map Editor.
Features
- Specialized for tile-based, 2D games
- Entirely written in TypeScript
- Rendered with PixiJS
- Simple and efficient API
- Compatible out-of-the-box with the Tiled Map Editor
- Batteries included
SquaredJS is currently in early alpha and in active development. Features are missing, bugs need to be squashed, docs are sparse, and the API will likely change in the future.