chess-console

chess-console

ChessConsole is a JavaScript-based chess game client framework that uses cm-chessboard and Bootstrap to create a browser-based, mobile-friendly, responsive chess game GUI.

• Repository on GitHub
• Demo pages

chess-console is used in Production

Used by chessmail as a framework for an online chess computer.

Component structure

Because of its component architecture chess-console is expandable for all kind of chess pages. You may check out the Stockfish Player for chess-console, a fully functional online chess computer.

Screenshot

Installation

Option 1: Download from GitHub

• Clone the repository:

  git clone https://github.com/shaack/chess-console.git
  

• Navigate to the project directory and install dependencies:

  cd chess-console
  npm install
  

Option 2: Install via npm

• Install the npm package:

  npm install chess-console
  

Usage

Initialization

To initialize a new ChessConsole instance, you need to provide the context, player, opponent, and optional properties.

import { ChessConsole } from 'chess-console';

const context = document.getElementById('chess-console');
// a LocalPlayer, that can be controlled by the user
const player = { type: LocalPlayer, name: 'Player 1', props: {} };
// an engine player, that playes random moves
const opponent = { type: RandomPlayer, name: 'Player 2', props: {} };

const chessConsole = new ChessConsole(context, player, opponent, {
    locale: 'en',
    playerColor: 'w',
    pgn: undefined,
    accessible: false
});

Licenses

Source code license: MIT,
License for the Sounds: CC BY 4.0,
License of the SVG pieces CC BY-SA 3.0.

Copyright © shaack.com.