# squidlegs

> ES6 Game Framework

Latest version **0.1.15** (published 2017-02-08) · 0 weekly downloads

## Install

```sh
npm install squidlegs
pnpm add squidlegs
yarn add squidlegs
bun add squidlegs
```

## Health

**Score 0/100 (F)** — status: abandoned.

Positive: no vulnerabilities.

Warnings: low downloads; no types; no esm support; low quality score; pre 1.0.

Negative: abandoned; low maintenance score; declining downloads.

## Facts

| | |
|---|---|
| Version | 0.1.15 |
| Published | 2017-02-08 |
| First published | 2017-02-08 |
| Weekly downloads | 0 |
| TypeScript types | none |
| Module format | CommonJS |
| Dependencies | 2 |
| Known vulnerabilities | 0 |
| Install scripts | no |
| Author | alexking |
| Maintainers | lajosbencz |

## Links

- npm: https://www.npmjs.com/package/squidlegs
- npm.io page: https://npm.io/package/squidlegs

## Dependencies (2)

- [gulp-babel](https://npm.io/package/gulp-babel.md) ~5.1.0
- [gulp-concat](https://npm.io/package/gulp-concat.md) ~2.6.0

## Recent versions

- 0.1.15 (latest) — 2017-02-08

## README

## Squidlegs: ES6 Game Framework

Quick and dirty game framework that works with Babel and Gulp so you can write ES6 game code today, instead of &infin; days from now.

![Squidlegs](images/squid.gif)

It consists of –

- `1` squid
- `library/` A basic set of ES6 Javascript classes, designed to be pretty modular so you can `new` whatever you actually need
	- `Loop` - use `requestAnimationFrame` to setup your main game loop
	- `Canvas`, `DomCanvas`, and `VirtualCanvas` - wrapper to draw to an onscreen or offscreen canvas (holds `context` and has helpers like `rotate`)
	- `Mouse` - handles the conversion between click events and simple coordinates on a canvas
	- `Keyboard` and `KeyboardMovement` - handles `wasd` / &uarr;&rarr;&darr;&larr; events, and translation to location deltas and facing degrees
	- `Sprite` - loads a sprite sheet image, stores it in an offscreen canvas (to allow for rotation), and draws to a canvas
	- `Font` - loads and displays simple pixel fonts in the format of (one section per line)
		- `0..9`
		- `A..Z`
		- `Extras`
- `gulpfile.js` to translate the framework and your code into ES6 via [Babel](https://babeljs.io)
- `game/` - where your actual game code might go, currently home to a sample `main.js`
- `index.html` - a test page

It's open source, unstable, and has no tests - it may eat your dog, my dog, or any number of other figurative dogs.

### @todo

- Add a cohesive `export` / `import` system - currently extending classes depends on ordering the `gulpfile` – not cool
- Add moar things!

---
_Source: https://npm.io/package/squidlegs · Machine-readable twin of the npm.io package page. Health data is recomputed on every publish._
