cowchina

README

CowChina

Visit the project page on humaidq.ae

1. Description

CowChina is a logger for a variant of the Spades playing card game. It logs the moves, invalid cards (cheating) and winners.

This could only be used with our variant of Spades, called Hokm.

2. Requirements

The following packages must be installed on your system.

• Go
• Git

3. Copying and contributing

This program is written by Humaid AlQassimi, and is distributed under the MIT license.

4. Download and install

$ go get -u git.sr.ht/~humaid/cowchina
$ go install git.sr.ht/~humaid/cowchina

5. Usage

To run the program:

$ cowchina

To begin, the names of the four players, the highest bid, bidding suit chosen, and highest bidding team is entered.

Then the each card is inputed. Below is a cheat sheet of possible inputs.

5.1. Input cheat sheet

Input	Description
ca	Ace of Clubs
da	Ace of Diamonds
ha	Ace of Hearts
sa	Ace of Spades
c{6-9}	Clubs 6 to 9
s{6-9}	Diamonds 6 to 9
h{6-9}	Hearts 6 to 9
s{6-9}	Spades 6 to 9
c{j,q,k}	Clubs {jack, queen, king}
d{j,q,k}	Diamonds {jack, queen, king}
h{j,q,k}	Hearts {jack, queen, king}
s{j,q,k}	Spades {jack, queen, king}
z	Black Joker
x	Red Joker
{enter}	PASS
{tab}	Go back (TODO)
:<id>	Jump to player (TODO)

Documentation

Overview

The MIT License (MIT)

Copyright (c) 2016-2017 Sheikh Humaid AlQassimi

Permission is hereby granted, free of charge, to any person obtaining a copy of this software and associated documentation files (the "Software"), to deal in the Software without restriction, including without limitation the rights to use, copy, modify, merge, publish, distribute, sublicense, and/or sell copies of the Software, and to permit persons to whom the Software is furnished to do so, subject to the following conditions:

The above copyright notice and this permission notice shall be included in all copies or substantial portions of the Software.

THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.