# peeko.js

> The game engine handling Peeko's board position and move validation

Latest version **0.1.2** (published 2019-04-21) · Apache-2.0 license · 0 weekly downloads

## Install

```sh
npm install peeko.js
pnpm add peeko.js
yarn add peeko.js
bun add peeko.js
```

## Health

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

Positive: has types; no vulnerabilities; high quality score.

Warnings: low downloads; no esm support; pre 1.0.

Negative: abandoned; low maintenance score.

## Facts

| | |
|---|---|
| Version | 0.1.2 |
| Published | 2019-04-21 |
| First published | 2019-03-29 |
| Weekly downloads | 0 |
| License | Apache-2.0 |
| TypeScript types | bundled |
| Module format | CommonJS |
| Dependencies | 1 |
| Unpacked size | 120.9 KB |
| Known vulnerabilities | 0 |
| Install scripts | no |
| Author | Charles Tatibouët |
| Maintainers | charlestati |
| Keywords | peeko, game engine |

## Links

- npm: https://www.npmjs.com/package/peeko.js
- Repository: https://github.com/charlestati/peeko.js
- Homepage: https://github.com/charlestati/peeko.js#readme
- Issues: https://github.com/charlestati/peeko.js/issues
- npm.io page: https://npm.io/package/peeko.js

## Dependencies (1)

- [lodash](https://npm.io/package/lodash.md) ^4.17.11

## Recent versions

- 0.1.2 (latest) — 2019-04-21
- 0.1.1 — 2019-04-21
- 0.0.1 — 2019-03-29

## README

# Peeko.js

The game engine handling Peeko's board position and move validation

## Installation
 
```shell
npm install peeko.js
```

## Usage

See [peeko.ppgn](peeko.ppgn) for PPGN documentation.

```javascript
const opn = [
  '0,0:2 2,0:1 4,0:2 6,0:1 8,0:1 10,0:1 12,0:1 14,0:3',
  '1,1:1 3,1:2 5,1:2 7,1:1 9,1:2 11,1:1 13,1:3',
  '0,2:3 2,2:2 4,2:1 6,2:1 8,2:1 10,2:2 12,2:1 14,2:1',
  '1,3:1 3,3:2 5,3:2 7,3:1 9,3:2 11,3:1 13,3:2',
  '0,4:3 2,4:2 4,4:2 6,4:2 8,4:1 10,4:2 12,4:1 14,4:3',
  '1,5:1 3,5:1 5,5:1 7,5:1 9,5:3 11,5:3 13,5:1',
  '0,6:1 2,6:2 4,6:3 6,6:1 8,6:2 10,6:1 12,6:3 14,6:2',
  '1,7:1 3,7:1 5,7:1 7,7:2 9,7:1 11,7:3 13,7:2',
  '1 4 2',
].join(' ');
const peeko = new Peeko(opn);
peeko.play('2,4');
```

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