@omniqlo/shogijs

A JavaScript Shogi library

Usage no npm install needed!

<script type="module">
  import omniqloShogijs from 'https://cdn.skypack.dev/@omniqlo/shogijs';
</script>

README

shogijs

Version Build Status License

A JavaScript Shogi library that supports:

  • Move generation/validation
  • Check/checkmate detection

Inspired by chess.js.

Installation

$ npm install @omniqlo/shogijs
# or
$ yarn add @omniqlo/shogijs

Setup

$ git clone git@github.com:omniqlo/shogijs.git
$ cd shogijs
$ npm run setup # or yarn setup

Usage

const Shogi = require("@omniqlo/shogijs");

// Initialize the Shogi game with the initial starting position
const shogi = Shogi();

// Move black's pawn from 57 to 56
shogi.move("P-56");

API

See API.md

LICENSE

BSD-3-Clause