open-hand-tracker v1.0.9

Open Hand History

A TypeScript library for creating and managing poker hand histories following the Open Hand History standard.

Installation | Quick Start | API Reference | Development | Contributing

Installation

npm install open-hand-tracker

Quick Start

import { OpenHandHistory } from 'open-hand-tracker';

// Initialize hand history
const ohh = new OpenHandHistory({
  siteName: 'MyPokerSite',
  tableSize: 6
  // other properties...
});

// Add a player
ohh.addPlayer({
  name: 'Player 1',
  id: 1,
  starting_stack: 1000,
  seat: 1
});

// Add a round
ohh.addRound({
  id: 1,
  street: 'PREFLOP',
  actions: []
});

// Add action to round
ohh.addActionToRound(1, {
  action_number: 1,
  player_id: 1,
  action: 'RAISE',
  amount: 100
});

// Calcuatle winnings
win_amount = ohh.calculateWinningAmount(1, 50); // Pass the player ID 

// Add pot 
ohh.addPot({
  number: 1,
  amount: 50,
  player_wins: [{ player_id: 1, win_amount: win_amount }],
});

// Get JSON representation
ohh.getJSON()

// Save to file
ohh.saveToFile('hand_history.json');

API Reference

OpenHandHistory

Constructor Options

{
  specVersion?: string;         // Default: '1.4.6'
  internalVersion?: string;     // Default: '1.4.6'
  networkName?: string;         // Default: 'CustomGame'
  siteName?: string;            // Default: 'HomeGame'
  gameType?: string;            // Default: 'Holdem'
  tableName?: string;           // Default: 'Sample Table'
  tableSize?: number;           // Default: 3
  gameNumber?: string;          // Default: '1'
  startDateUTC?: string;        // Default: current date
  currency?: string;            // Default: 'Chips'
  anteAmount?: number;          // Default: 0
  smallBlindAmount?: number;    // Default: 1
  bigBlindAmount?: number;      // Default: 2
  betCap?: number;              // Default: 0
  betType?: string;             // Default: 'NL'
  dealerSeat?: number;          // Default: 1
  heroPlayerId?: number;        // Default: 0
}

Methods

addPlayer(player: Player): void

Add a player to the hand history.

interface Player {
  name: string;
  id: number;
  starting_stack: number;
  seat: number;
  cards?: string[];
}

addRound(round: Round): void

Add a new round to the hand history.

interface Round {
  id: number;
  cards?: string[];
  street: "Preflop" | "Flop" | "Turn" | "River" | "Showdown"
  actions: Action[];
}

addActionToRound(roundId: number, action: Action): void

Add an action to a specific round.

interface Action {
  action_number: number;
  player_idd: number;
  action: string;
  amount?: number;
  is_allin?: boolean;
}

addPot(pot: Pot): void

Add a pot to the hand history.

interface Pot {
  rake?: number;
  number: number;
  amount: number;
  player_wins: { player_id: number; win_amount: number }[];
}

calculateWinningAmount(player_id: number, totalPot: number): number

Calculates the winners winnings

toJSON(): string

Convert the hand history to JSON string.

saveToFile(filename: string): void

Save the hand history to a file.

Development

Setup

git clone https://github.com/yourusername/open-hand-history.git
cd open-hand-history
npm install

Testing

npm test

Building

npm run build

Contributing

1. Fork the repository
2. Create your feature branch (git checkout -b feature/amazing-feature)
3. Commit your changes (git commit -m 'Add amazing feature')
4. Push to the branch (git push origin feature/amazing-feature)
5. Open a Pull Request

License

MIT