https://github.com/seikho/node-chess
Extensible Chess engine in JavaScript
https://github.com/seikho/node-chess
chess node typescript
Last synced: 2 months ago
JSON representation
Extensible Chess engine in JavaScript
- Host: GitHub
- URL: https://github.com/seikho/node-chess
- Owner: Seikho
- Created: 2015-03-22T01:49:21.000Z (over 10 years ago)
- Default Branch: master
- Last Pushed: 2020-04-30T03:37:53.000Z (about 5 years ago)
- Last Synced: 2025-05-07T03:01:41.841Z (2 months ago)
- Topics: chess, node, typescript
- Language: JavaScript
- Homepage:
- Size: 691 KB
- Stars: 22
- Watchers: 3
- Forks: 2
- Open Issues: 3
-
Metadata Files:
- Readme: readme.md
Awesome Lists containing this project
README
# Node-chess
A fully isomorphic and extensible chess engine with position analysis, board analysis, and computer opposition.
[](https://www.npmjs.org/package/node-chess)
[](https://travis-ci.org/Seikho/node-chess)
### What does it do? How is it extensible?
Node-chess allows you extend the board and add your own rules. The analysis engine and computer player will automatically factor these changes/additions into their calculations and adjust accordingly.
With node-chess you can:
- define your own pieces and modify existing pieces
- (re-)define their notation, movement, value, and capture logic
- add, change, and remove rules such as win and loss conditions
- extend the existing engine to improve the calculations for your own variants
### Installation
Add it as a dependency to your project
```javascript
npm install node-chess
```
In the browser
```html
var game = chess.classic.engine();
```
The engine comes with a 'classic' implementation of Chess.
```javascript
var chess = require("node-chess");
var game = chess.classic.engine();
```
### Using the board
```javascript
// Move the E2 pawn to E4
game.movePiece( { from: { file: 5, rank: 2 } , to: { file: 5, rank: 4 } });
// Move the B8 knight to C6
game.movePiece( { from: { file: 2, rank: 8 }, to: { file: 3, rank: 6 } });
// Try and make an invalid move
// No piece is on B8
game.movePiece({ from: { file: 2, rank: 8 }, to: { file: 3, rank: 6 } }); === null; // true
// Promotion
// To a queen (by default)
game.movePiece({ from: { file: 1, rank: 7 }, to: { file: 1, rank: 8 } });
// To a rook
game.movePiece({ from: { file: 1, rank: 7 }, to: { file: 1, rank: 8 } }, "r");
// Print the available moves of the C6 knight to the console
console.log(classicEngine.getMoves({ file: 3, rank: 6 }));
```
### Defining your own pieces
The 'super knight' moves 3 squares laterally before moving 1 square on the opposite axis!
```javascript
var Direction = require("./engine/direction");
var customEngine = new chess.Engine();
var upLeft = makeMove(-1, 3);
var upRight = makeMove(1, 3);
var downLeft = makeMove(-1, -3);
var downRight = makeMove(1, -3);
var leftUp = makeMove(-3, 1);
var leftDown = makeMove(-3, -1);
var rightUp = makeMove(3, 1);
var rightDown = makeMove(3, -1);
function makeMove(file, rank) {
return {
canCapture: true,
canMove: true,
transforms: { file: file, rank: rank, canJump: true }
}
}
var superKnight = {
name: "SuperKnight",
movement: [upLeft, upRight, downLeft, downRight, leftUp, leftDown, rightUp, rightDown],
canQueen: false,
canSpawn: true,
value: 3.5,
notation: "s"
}
customEngine.pieces.push(superKnight);
```
[](https://github.com/Seikho/watcher)
[](https://semaphoreci.com/seikho/node-chess)