bin/Data Structures: The Card Game

#!/usr/bin/env .wiki
This is a card game, created by Gregor Richards and Harrison Metzger. It is absurdly complicated.

== The data structures

=== Deck
The game is played with two standard 52-card decks.

=== Queue
In the center of the table is a queue. The queue has a maximum of five cards, and moves in a predetermined direction. The stack of cards is placed at the beginning of the queue to indicate its direction. The cards in the queue are face-up.

=== Stacks
Each player has a stack. The stack is face-up in front of the player.

=== Hands
Each player has a five-card hand.

=== Arrays
Each player has three arrays. The objective of the game is to get all three arrays to have every value (2, 3, 4, 5, 6, 7, 8, 9, 10, J, Q, K) in order. The lists may start with any value, but must loop back 'round to one less than that value.

== Setup

At the beginning of the game, the deck is placed to one side. All five cards of the queue are set out, as are a single card for each stack, and each player's five-card hand.

== Gameplay

The game is a turn based game. Each players turn can be divided up into phases.

=== Phase 1 (Inserting into arrays)
During this phase, the player can use any card from their hand, pop for any of the 2 stacks, or remove the head of the list to place the proper next card on his or her own array. An array can only be started from a card in the player's hand. Should an array become complete on a card move, the array is turned upside down (so all cards are now face down) and will be shuffled back into the deck at the end of the turn.

Should the player use all 5 cards in their hand, they are allowed to redraw all 5 cards. Likewise, should all 5 cards in the queue be used, it will be refilled here.

Alternatively, should the player be unable to play any card (this is verified by showing all cards in the hand to the opponent) they can chose to burn 4 out of their 5 cards. This forcebly ends phase 1 (although it would be ended automatically as there are no moves, but we want to be explicit incase burning is allowed if moves are a possibility to expand the scope of the rule)

=== Phase 2 (Discards)
Phase 2 begins by "burning" the head of the queue. The player removes the head of the queue and places it on the to-be-shuffle-back-in pile.

The player then must place one of their cards on the stack.

Should the player have any cards in their hand and the queue not be full, they can optionally put cards from their hand into the queue.

=== Phase 3 (Replenish)

Should any arrays be closed they, along with the garbage pile are shuffle back into the deck.

At this phase should the queue be less than 5 cards, it is replenished by drawing from the deck.

Also, the players hand is replenished to 5 cards.

An invariant is that on the beginning of each players turn, both players have 5 cards in their hand and the queue is filled with 5 cards.