UNPKG

@nodots-llc/backgammon-ai

Version:

AI and integration for nodots-backgammon using gnubg as a backend engine.

68 lines (44 loc) 1.49 kB
# Nodots Backgammon AI A TypeScript library that provides AI capabilities for backgammon games using GNU Backgammon (gnubg) as the backend engine. This package is part of the Nodots Backgammon ecosystem. ## Features - Integration with GNU Backgammon (gnubg) engine - TypeScript support with full type definitions - Comprehensive test coverage - Built on top of @nodots-llc/backgammon-core ## Installation ```bash npm install @nodots-llc/backgammon-ai ``` ## Prerequisites This package requires GNU Backgammon (gnubg) to be installed on your system. Please refer to the [GNU Backgammon documentation](https://www.gnu.org/software/gnubg/) for installation instructions. ## Usage ```typescript import { BackgammonAI } from '@nodots-llc/backgammon-ai' // Initialize the AI const ai = new BackgammonAI() // Get AI move suggestions const move = await ai.getBestMove(gameState) ``` ## Development ### Setup 1. Clone the repository: ```bash git clone https://github.com/nodots/nodots-backgammon-ai.git cd nodots-backgammon-ai ``` 2. Install dependencies: ```bash npm install ``` ### Available Scripts - `npm run build` - Build the project - `npm run test` - Run tests - `npm run test:watch` - Run tests in watch mode - `npm run test:coverage` - Run tests with coverage report - `npm run lint` - Run ESLint - `npm run lint:fix` - Fix ESLint issues - `npm run clean` - Clean build artifacts ## License MIT © [Nodots LLC](https://nodots.com) ## Author Ken Riley <kenr@nodots.com>