@nodots-llc/backgammon-types v2.2.1

@nodots-llc/backgammon-types

Type definitions for the nodots-backgammon project. This package provides TypeScript type definitions and interfaces for representing backgammon game states, moves, and related functionality.

Overview

This package contains TypeScript type definitions for:

• Game state and management
• Board representation
• Checker movements and positions
• Dice rolls and cube decisions
• Player information and states
• Move validation and game rules
• Game offers and decisions

Installation

Install the package from npm:

npm install @nodots-llc/backgammon-types

Project Structure

The type definitions are organized into the following modules:

• board.ts - Board state and position types
• checker.ts - Checker representation and movement
• checkercontainer.ts - Container management for checkers
• cube.ts - Doubling cube related types
• dice.ts - Dice roll types and validation
• game.ts - Core game state and management
• move.ts - Move representation and validation
• offer.ts - Game offers (double, resign, etc.)
• pip.ts - Pip counting and management
• play.ts - Play action types and validation
• player.ts - Player state and management

Usage

Import the types you need in your TypeScript files:

import { Game, Move, Player, Board } from '@nodots-llc/backgammon-types'

Development

Prerequisites

• Node.js (Latest LTS recommended)
• npm

Setup

1. Clone the repository
2. Install dependencies:

   npm install

Building

To compile the TypeScript files:

npm run build

This will generate the compiled JavaScript and type definition files in the dist directory.

Scripts

• npm run build - Compiles the TypeScript code
• npm run prepare - Runs automatically before the package is packed or installed

License

MIT License - See LICENSE file for details

Author

Ken Riley kenr@nodots.com