npm-chess-game

A simple and lightweight Chess Logic Engine implemented in TypeScript. This package provides all the core chess rules, including piece movements, check, checkmate detection, and more.

Features

✅ Supports all standard chess rules ✅ Move validation for each piece ✅ Detects check and checkmate ✅ Easily extendable and lightweight

Installation

Install using npm: npm install npm-chess

Usage

Import the package and start using it:

import { Board } from "npm-chess"          // main chess board
import { piece_name, color, coordinate, location, piece, response, check } from "npm-chess/dist/types"          // Types for typescript

API Methods

Board.canMoveTo(board, current_x, current_y)

• Description - Return the moves the piece can take and if it can cut any piece.
• Arguements -
  • board - Board object.
  • current_x - x coordinate of the piece to move.
  • current_y - y coordinate of the piece to move.
• Response -
  • null or
  • canMoveto : []
  • canCut : []

Board.move(board, current_x, current_y, goal_x, goal_y)

• Description - moves or cuts the piece on chess board and returns check or checkmate if happens.
• Arguements -
  • board - Board object.
  • current_x - x coordinate of the piece to move.
  • current_y - y coordinate of the piece to move.
  • goal_y - y coordinate where you want to move the piece.
  • goal_y - y coordinate where you want to move the piece.
• Response -
  • null or
  • board : Board object
  • check : boolean
  • checkMate : boolean

Board.getBoard()

• Description - returns the chess board
• Response -
  • board : chess board

Board.getTurn()

• Description - returns the color whose turn is to move.
• Response -
  • turn : color of piece which has turn

Board.getSteps()

• Description - returns the move history.
• Response -
  • steps : []

Board.getWinner()

• Description - returns the winner of the game.
• Response -
  • null or
  • winner : color of the piece which won

Board.getCaptured()

• Description - returns an object of black and white captured pieces array.
• Response -
  • captured : object of black and white captured pieces array

Links

• GitHub Repository