node-uci

Universal Chess Interface protocol implementation for node.js

Usage no npm install needed!

<script type="module">
  import nodeUci from 'https://cdn.skypack.dev/node-uci';
</script>

README

node-uci

node-uci is an implementation of the Universal Chess Interface protocol for node.js. In short, you can talk to engines (like Stockfish, Rybka, etc.) from node.js without any headaches. Abstracts away the pesky communication and parsing of UCI and provides a sane API to communicate with engines.

Build Status Code Climate Test Coverage

Install

Through npm with npm install node-uci.

Usage / Docs

Usage examples and documentation

TLDR;

import { Engine } from 'node-uci'
// or
const Engine = require('node-uci').Engine

// async/await
const engine = new Engine('engine/executable/path')
await engine.init()
await engine.setoption('MultiPV', '4')
await engine.isready()
console.log('engine ready', engine.id, engine.options)
const result = await engine.go({ nodes: 2500000 })
console.log('result', result)
await engine.quit()

//promises with chain
const engine = new Engine('engine/executable/path')
engine
  .chain()
  .init()
  .setoption('MultiPV', 3)
  .position('r1bqkbnr/pppp1ppp/2n5/1B2p3/4P3/5N2/PPPP1PPP/RNBQK2R b KQkq - 3 3')
  .go({ depth: 15 })
  .then(result => {
    console.log(result)
  })

License

MIT

Contribute

PRs always welcome