lichess-org / chessground

Mobile/Web chess UI for lichess.org
https://lichess.org
GNU General Public License v3.0
1.05k stars 260 forks source link
board chess lichess typescript ui

Chessground

Continuous Integration npm

Chessground in 2D and 3D

Chessground is a free/libre open source chess UI developed for lichess.org. It targets modern browsers, as well as mobile development using Cordova.

License

Chessground is distributed under the GPL-3.0 license (or any later version, at your option). When you use Chessground 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.

Demos

Features

Chessground is designed to fulfill all lichess.org web and mobile apps needs, so it is pretty featureful.

Installation

npm install --save chessground

Usage

import { Chessground } from 'chessground';

const config = {};
const ground = Chessground(document.body, config);

Wrappers

More? Please make a pull request to include it here.

Documentation

Development

Install build dependencies:

pnpm install

To build the node module:

pnpm run compile --watch

To build the standalone:

pnpm run dist