garak/pokerino

A PHP library to manage Poker card games

dev-main / 1.0.x-dev 2024-04-07 09:36 UTC

Requires

• php: ^8.1
• doctrine/collections: ^2.1
• garak/card: ^0.4

Requires (Dev)

• phpunit/phpunit: ^9.6

LGPL-3.0-or-later

• Massimiliano Arione

README

Introduction

This library offers some objects useful for creating a Poker card game:

• Game (to be extended)
• Player (to be extended)
• Hand
• PokerRank

Installation

Run composer require garak/pokerino.

Usage

Here is an example of a game:

<?php

require 'vendor/autoload.php';

use App\Game;   // this is your Game class, extending \Garak\Pokerino\Game
use App\Player;   // this is your Player class, extending \Garak\Pokerino\Player

$game = new Game();
$game->addPlayer(new Player('Marty McFly'));
$game->addPlayer(new Player('Biff Tannen'));
$game->addPlayer(new Player('Emmett Brown'));
$game->addPlayer(new Player('Jennifer Parker'));
$game->deal();  // deal 2 cards to each player
$game->hands(); // return an array of \Garak\Pokerino\Hand

Credits

The original idea was developed with davidino.