/ 
Game-Cribbage-0.12
River stage zero No dependents
/ Game::Cribbage

NAME

Game::Cribbage - Cribbage game engine

VERSION

Version 0.12

SYNOPSIS

lnation$ cribbage

...

use Game::Cribbage;

Game::Cribbage->new()->start();

...
Inlineimage 
...

use Game::Cribbage::Board;

my $engine = Game::Cribbage::Board->new();

$engine->add_player(name => 'Robert');
$engine->add_player(name => 'Joseph');

$engine->start_game();

# low card logic to then set the dealer/crib player
$engine->set_crib_player('player1');

# deal hands
$engine->draw_hands();

$engine->crib_player_cards('player1', $cards);
$engine->crib_player_cards('player2', $cards);

# split to get starter
$engine->add_starter_card('player2', $card);

$engine->play_card('player1', $card);
$engine->play_card('player2', $card);

...

$engine->next_play();

...

$engine->end_hands();
$engine->score;

DESCRIPTION

Cribbage is a card game, typically for two players, where the goal is to be the first to reach 121 points by forming counting combinations of cards and using a special pegging board to track scores.

The Game::Cribbage class is an implementation of cribbage using the terminal. The distribution itself is an game engine and should contain all the logic you need to build a version of Cribbage using any alternative interface.

PROPERTIES

The following properties are defined in Game::Cribbage

board

Property to store the current Game::Cribbage::Board

$game->board;

dealer

Property to store a boolean of whether the current player is the dealer for the current round. If true they are.

$game->dealer;

crib_set

Property to store a boolean of whether the current plays crib is set.

$game->crib_set;

starter_card

Property to store the starter card for the current play.

$game->starter_card;.

FUNCTIONS

The following functions are defined in Game::Cribbage

	my $game = Game::Cribbage->new;

	$game->clear_screen;

        $game->print_header("Welcome to terminal Cribbage");

        $game->print_footer("Insert name: ");

        my $name = <STDIN>;

        chomp($name);

        my $board = Game::Cribbage::Board->new();

        $board->add_player(name => 'Bot');
        $board->add_player(name => $name);

        $board->start_game();
/split
        $game->board = $board;

	$game->clear_screen;

	$game->reset_cursor();
	
	$game->split_cards();

	$game->init_draw();

start

Start a new terminal cribbage game. This function setups the Game::Cribbage::Board setting the players and starting the game. It will then call init_game.

$game->start();

init_game

Initialise a new terminal game, clearing the welcome start screen, calling split_cards and then init_draw.

$game->init_game();

init_draw

This is where the main terminal game loop happens. For each new round/draw this function is called recursively. Cards are drawn, discarded and the starter card is set. Hands are played until no cards are left, scores are calculated and we repeat..

$game->init_draw();

end_hands

When all cards have been used in the current draw/round then this end_hands function should be called. It handles the ending of the round and will render to the terminal an overview of the round/draw including all cards and the relevant scores.

$game->end_hands();

play_hand

Contains the logic needed to handle the play of the players hand, aka placing a card or calling go because you cannot play a card.

$game->play_hand();.

split_cards

Contains the logic needed to decide which player goes first as the dealer.

$game->split_cards();

draw_cards

Contains the logic needed to draw player cards so they can then decide which two to discard.

$game->draw_cards();

discard_cards

Contains the logic neeeded to discard two cards from the players and bots hands into the crib.

$game->discard_cards();

starter

Contains the logic needed to select the starter card for the current draw.

$game->starter();

render_card

Contians the logic needed to render a card to the terminal.

$game->render_card($card, $row, $col);

render_opponent_cards

Contains the logic needed to render the opponents cards to the terminal. AKA face down at the top of the screen.

$game->render_opponent_cards($num);

render_player_cards

Contains the logic needed to render the players cards to the terminal. AKA face up at the bottom of the screen.

$game->render_player_cards($cards, $row, $col, $all);

render_run_play

Contains the logic needed to render the current plays run cards. AKA the cards that have been played for the current play in the middle of the screen.

$game->render_run_play;

show_face_down_split

Utility function to render face down cards to the terminal.

$game->show_face_down_split($num, $vertical);

draw_background

Utility function to draw the basic cribbage game, this function calls draw_dealer, draw_crib, draw_starter and reset_cursor. It will render the green background, dealer, crib and starter card to the terminal.

$game->draw_background();

draw_starter

Utility function to draw the starter card to the terminal. If no starter card is set then nothing will be drawn.

$game->draw_starter();

draw_crib

Utility function to draw the crib to the terminal, depending on who is the dealer.

$game->draw_crib();

draw_go

Utitlity function to draw GO to the terminal.

$game->draw_go();

draw_dealer

Utility function to draw the text "Dealer" to the terminal, this will be against the player who is currently the dealer.

$game->draw_dealer();.

draw_scores

Utility function to draw the current scores to the terminal.

$game->draw_scores();

winner

Utility function to draw the winners screen to the terminal at the end of the game.

$game->winner();

clear_screen

Utility function to clear the terminal.

$game->clear_screen();

reset_cursor

Utility function to reset the terminal cursor position.

$game->reset_cursor();

set_cursor_vertical

Utiltiy function to set the vertical position of the terminal cursor.

$game->set_cursor_vertical($y);

set_cursor_horizontal

Utility function to set the horizontal position of the terminal cursor.

$game->set_cursor_horizontal($x);

say

Utility function to print text to the terminal.

$game->say("Hello World", $new_line, $indent, $color, $background);

Utility function to print the header to the terminal

$game->print_header("Print some header text");

Utility function to print the footer to the terminal

$game->print_footer("Print some footer text");

AUTHOR

LNATION, <email at lnation.org>

BUGS

Please report any bugs or feature requests to bug-game-cribbage at rt.cpan.org, or through the web interface at https://rt.cpan.org/NoAuth/ReportBug.html?Queue=Game-Cribbage. I will be notified, and then you'll automatically be notified of progress on your bug as I make changes.

SUPPORT

You can find documentation for this module with the perldoc command.

perldoc Game::Cribbage

You can also look for information at:

ACKNOWLEDGEMENTS

LICENSE AND COPYRIGHT

This software is Copyright (c) 2024 by LNATION.

This is free software, licensed under:

The Artistic License 2.0 (GPL Compatible)