[![crates.io](https://img.shields.io/crates/v/casino_poker.svg)](https://crates.io/crates/casino_poker) [![Poker Test](https://github.com/winstonrc/casino/actions/workflows/casino_poker.yml/badge.svg?branch=main)](https://github.com/winstonrc/casino/actions/workflows/casino_poker.yml)

# casino_poker

A library that provides hand ranking & the backend for poker games. 

**Note:** This library is still a work-in-progress. While stability during updates is a goal, expect occasional breaking changes for the time being.

## Usage

### Hand Ranking & High Cards

```rust
fn main() {
    use casino_cards::card;
    use casino_cards::card::{Card, Rank, Suit};
    use casino_poker::hand_rankings::{get_high_card_value, rank_hand, HandRank};
    let ace_of_diamonds = card!(Ace, Diamond);
    let two_of_diamonds = card!(Two, Diamond);
    let three_of_diamonds = card!(Three, Diamond);
    let four_of_diamonds = card!(Four, Diamond);
    let five_of_diamonds = card!(Five, Diamond);
    let seven_of_diamonds = card!(Seven, Diamond);
    let eight_of_diamonds = card!(Eight, Diamond);

    let cards_to_rank: Vec<Card> = vec![
        ace_of_diamonds,
        two_of_diamonds,
        three_of_diamonds,
        four_of_diamonds,
        five_of_diamonds,
        seven_of_diamonds,
        eight_of_diamonds,
    ];

    // high_card == Card { rank: Ace, suit: Diamond, face_up: true }
    let high_card = get_high_card_value(&cards_to_rank);

    // hand_rank == StraightFlush([Card { rank: Ace, suit: Diamond, face_up: true }, Card { rank: Two, suit: Diamond, face_up: true }, Card { rank: Three, suit: Diamond, face_up: true }, Card { rank: Four, suit: Diamond, face_up: true }, Card { rank: Five, suit: Diamond, face_up: true }])
    let hand_rank: HandRank = rank_hand(cards_to_rank);
}
```

### Texas hold 'em

```rust
use poker::games::texas_hold_em::TexasHoldEm;

const MINIMUM_TABLE_BUY_IN_CHIPS_AMOUNT: u32 = 100;
const MAXIMUM_TABLE_PLAYERS: usize = 10;
const SMALL_BLIND: u32 = 1;
const BIG_BLIND: u32 = 3;
const LIMIT: bool = false;

fn main() {
    let mut texas_hold_em_1_3_no_limit = TexasHoldEm::new(
        MINIMUM_TABLE_BUY_IN_CHIPS_AMOUNT,
        MAXIMUM_TABLE_PLAYERS,
        SMALL_BLIND,
        BIG_BLIND,
        LIMIT,
    );

    // A Player can be created without chips.
    let mut player1 = texas_hold_em_1_3_no_limit.new_player("Player 1");

    // But the Player must have the minimum_table_buy_in_chips_amount before they can be added to the table.
    player1.add_chips(100);

    // add_player() returns a Result, which can be handled.
    match texas_hold_em_1_3_no_limit.add_player(player1) {
        Ok(()) => {}
        Err("The player does not have enough chips to play at this table.") => {
            eprintln!("The player does not have enough chips to play at this table.")
        }
        Err(_) => {
            eprintln!("Unable to add player to the table. Reason unknown.");
        }
    }

    // A Player can also be created with chips.
    let player2 = texas_hold_em_1_3_no_limit.new_player_with_chips("Player 2", 100);

    // You can try to add a player without handling the result.
    texas_hold_em_1_3_no_limit.add_player(player2).unwrap();

    // A tournament can be played, which iterates through rounds until there is only one player remaining.
    texas_hold_em_1_3_no_limit.play_tournament();

    // Or a single round can be run.
    // The dealer's seat index must be provided in order to determine the order of dealing and the small and big blinds.
    let dealer_seat_index: usize = 0;
    texas_hold_em_1_3_no_limit.play_round(dealer_seat_index);
}
```