holdem-engine v0.1.3

HoldemEngine – Texas Hold'em Poker Engine

This project started when I realized I needed to build a state machine for a 2D poker game, but none of the existing solutions really fit my needs. So, I created APE – the ultimate TypeScript-powered poker engine for building Texas Hold'em games! Whether you're building a multiplayer poker platform, a simulation engine, or just having some fun, APE provides a flexible, modular, and fully customizable solution for managing poker hands, game states, and player actions. As I dove into the process, I ended up learning a ton along the way, and it’s been an amazing experience putting everything together!

Features

1. Player Management Players can join the table and be associated with a specific seat. Player information includes name, hand, bet amount, and their status. Players are tracked by their unique seat.
2. Game State Management The game state is updated based on player actions (e.g., bets, folds). Hand history tracking is implemented for reviewing the sequence of actions in a game. State of the game is updated in real-time as players make moves.
3. Betting System Players can place bets, fold, or check. The engine tracks player bets for each round. Pot management to accumulate the total money staked by players during a hand. Player’s individual bet amounts are updated throughout the game.
4. Card Handling Cards are represented in an object-oriented structure, likely using CardSuit and CardRank. Deck of cards is shuffled and distributed to players. Card actions such as revealing community cards (flop, turn, river) are handled. Emoji-based visual representation for displaying cards.
5. Hand Evaluation Each player's hand is evaluated to determine the best possible poker hand. Multiple players can be evaluated at once to find the winners. Hand rankings such as “High Card”, “Pair”, “Full House” are likely part of the hand evaluation logic.
6. Winner Determination After all rounds are completed, the engine determines who wins based on the best hand. Winners are printed with their hand details, hand ranking, and winning value.
7. Logging Detailed logs are generated for players’ actions, including bet amounts and final hands. Log output for the state of the game and the winners at the end of a hand.
8. AI & Game Flow Management The game’s flow is managed by a state machine (likely implied), progressing through stages like pre-flop, flop, turn, and river. Likely handling for multiple players acting sequentially.
9. Game Round Mechanics Tracks and displays each phase of the poker hand. Community cards are revealed progressively, and players act accordingly. Likely has the ability to process player actions like folding, raising, checking, and all-in.
10. Multiplayer Support Supports multiple players, each with their unique cards and actions. Players interact with the game in real-time with their respective bets and actions.

Installation

You can install the APE Poker Engine via npm:

npm install ape-poker-engine

Or via yarn:

yarn add ape-poker-engine

Getting Started

Here’s a quick example to get you started with APE:

1. Create a new game instance

import { Game } from 'ape-poker-engine';

const game = new Game();

2. Start a new hand

game.startNewHand();

3. Record player actions

game.currentHand.recordPlayerAction({
  playerId: 'player1',
  action: 'Bet',
  amount: 100
});

4. Transition game states

game.currentHand.recordGameStateChange({
  newState: 'flop'
});

5. Track game history

const gameHistory = game.getHandHistory();
console.log(gameHistory);

API Documentation

Table

Each Table represents a single hand in the game.

HandHistory

Stores the full history of a specific hand, including actions, player states, and game events.

• gameLog: GameLogEntry[]: The list of all actions and events that occurred during the hand.

PlayerAction

Represents possible player actions during the game.

export const PlayerAction = {
  Fold: "Fold",
  Call: "Call",
  Raise: "Raise",
  Check: "Check",
  Bet: "Bet"
} as const;

GameLogEntry

The log of any event or action that happens during a hand.

interface GameLogEntry {
  type: 'PlayerAction' | 'GameStateChange' | 'PotUpdate' | 'RoundEnd';
  timestamp: Date;
  details: PlayerActionRecord | GameStateChange | PotUpdate | RoundEnd;
}

Contributing

Contributions are welcome! Feel free to open an issue or submit a pull request if you find a bug or want to improve the engine.

License

This project is licensed under the MIT License - see the LICENSE file for details.