Mobile/Web shogi UI for lishogi.org
GPL-3.0 License
Shogiground is a free/libre open source shogi UI forked from Chessground rewritten for lishogi.org. It targets modern browsers, as well as mobile development using Cordova.
Shogiground is distributed under the GPL-3.0 license (or any later version, at your option). When you use Shogiground for your website, your combined work may be distributed only under the GPL. You must release your source code to the users of your website.
Please read more about GPL for JavaScript on greendrake.info/#nfy0.
Shogiground is designed to fulfill all lishogi.org web and mobile apps needs, so it is pretty featureful.
npm install --save shogiground
import { Shogiground } from 'shogiground';
const config = {
sfen: {
board: 'lnsgkgsnl/1r5b1/ppppppppp/9/9/9/PPPPPPPPP/1B5R1/LNSGKGSNL',
},
};
const ground = Shogiground(config, { board: document.body });
Or you can simply pull the latest version from jsdelivr
.
<script src="https://cdn.jsdelivr.net/npm/shogiground@latest/dist/shogiground.min.js"></script>
To actually see and use the board you need some CSS. You can use the CSS in examples/assets
as a starting point. But it will take some work to get it exactly how you want it.
Install build dependencies:
npm install
To build the node module:
npm run compile -- --watch
To build the standalone:
npm run dist -- --watch