kokopu
    TypeScript icon, indicating that this package has built-in type declarations

    3.3.0 • Public • Published

    Kokopu

    Kokopu is a JavaScript/TypeScript library for chess applications. It implements the chess game rules, and provides tools to read/write the standard chess file formats (PGN, FEN, UCI, etc.).

    https://www.npmjs.com/package/kokopu

    Build Status Coverage Status

    Download

    https://kokopu.yo35.org/dist/kokopu.zip

    Documentation

    https://kokopu.yo35.org/

    Migrate to 3.x

    Version 3.0.0 introduces some breaking changes with regard to the previous versions. Please look at the migration guide to determine whether your codebase needs to be adapted or not when upgrading Kokopu from 1.x or 2.x to 3.0.0 (or any subsequent version).

    Features

    • Chess move generation.
    • Check, checkmate and stalemate detection.
    • Move legality check.
    • Algrebraic notation parsing and generation.
    • FEN notation parsing and generation.
    • UCI move parsing and generation.
    • PGN file parsing and generation (including advanced PGN features such as commentaries, sub-variations, NAGs, non-standard starting position...).
    • Support several chess variants:
      • Chess960, also known as Fischer Random Chess.
      • Antichess, also known as losing chess, giveaway chess, suicide chess...
      • Horde chess (following Lichess/Chess.com rules).

    Kokopu is a headless library, meaning it does not provide any user interface. If you are interested in UI features (e.g. to be able to render a chessboard component within a web page), you may take a look at Kokopu-React, which is a React-based library built on top of Kokopu to provide these kind of features.

    Example

    const { Position } = require('kokopu');
    
    // Create a new position, play some moves...
    const position = new Position();
    position.play('e4');
    position.play('e5');
    position.play('Nf3');
    
    // Display an ASCII-art representation of the position.
    console.log(position.ascii());
    
    // +---+---+---+---+---+---+---+---+
    // | r | n | b | q | k | b | n | r |
    // +---+---+---+---+---+---+---+---+
    // | p | p | p | p |   | p | p | p |
    // +---+---+---+---+---+---+---+---+
    // |   |   |   |   |   |   |   |   |
    // +---+---+---+---+---+---+---+---+
    // |   |   |   |   | p |   |   |   |
    // +---+---+---+---+---+---+---+---+
    // |   |   |   |   | P |   |   |   |
    // +---+---+---+---+---+---+---+---+
    // |   |   |   |   |   | N |   |   |
    // +---+---+---+---+---+---+---+---+
    // | P | P | P | P |   | P | P | P |
    // +---+---+---+---+---+---+---+---+
    // | R | N | B | Q | K | B |   | R |
    // +---+---+---+---+---+---+---+---+
    // b KQkq -
    
    // List the available moves.
    const moves = position.moves();
    console.log(moves.map(move => position.notation(move)));
    
    // [ 'a6', 'a5', 'b6', 'b5', 'c6', 'c5', 'd6','d5', 'f6', 'f5', 'g6',
    // 'g5', 'h6', 'h5', 'Na6', 'Nc6', 'Qe7', 'Qf6', 'Qg5', 'Qh4', 'Ke7',
    // 'Be7', 'Bd6', 'Bc5', 'Bb4', 'Ba3', 'Nf6', 'Nh6', 'Ne7' ]

    More examples available in documentation.

    Install

    npm i kokopu

    DownloadsWeekly Downloads

    34

    Version

    3.3.0

    License

    LGPL-3.0-or-later

    Unpacked Size

    1.25 MB

    Total Files

    355

    Last publish

    Collaborators

    • yo35