Compare commits
5 Commits
1c813e0fac
...
b6f0edfc48
Author | SHA1 | Date |
---|---|---|
|
b6f0edfc48 | |
|
ca27a81dc2 | |
|
8726f09a91 | |
|
6f35e269f6 | |
|
84f733b6bb |
17
README.md
17
README.md
|
@ -1,12 +1,12 @@
|
||||||
# SingBridge
|
# SingBridge
|
||||||
A python implementation of the Singaporean version of the Bridge Card game.
|
A python implementation of the Floating Bridge Card game using PyGame.
|
||||||
|
|
||||||
# Requirements
|
# Requirements
|
||||||
Python 3.6, pygame, signalslot
|
Python 3.6, pygame, signalslot
|
||||||
|
|
||||||
# Installation
|
# Installation
|
||||||
1. Clone this repository
|
1. Clone this repository
|
||||||
2. Make a virtual environment (optinal but recommended). Remember to activate it.
|
2. Make a virtual environment (optional but recommended). Remember to activate it.
|
||||||
3. Install the required packages from requirements.txt:
|
3. Install the required packages from requirements.txt:
|
||||||
`pip install -r requirements.txt`
|
`pip install -r requirements.txt`
|
||||||
4. Run main.py:
|
4. Run main.py:
|
||||||
|
@ -22,6 +22,7 @@ When running `main.py`, you can give options:
|
||||||
* `-va` or `--view-all`: All player cards are revealed
|
* `-va` or `--view-all`: All player cards are revealed
|
||||||
* `-s` or `--seed` followed by a file path: To run the game with a specified RNG seed
|
* `-s` or `--seed` followed by a file path: To run the game with a specified RNG seed
|
||||||
* `-t` or `--terminal`: To play with legacy terminal inputting
|
* `-t` or `--terminal`: To play with legacy terminal inputting
|
||||||
|
|
||||||
An example command:
|
An example command:
|
||||||
|
|
||||||
`python main.py -a -s ./seeds/low_point_hand.rng`
|
`python main.py -a -s ./seeds/low_point_hand.rng`
|
||||||
|
@ -29,14 +30,14 @@ An example command:
|
||||||
This command runs the game with all bots and a seed from `./seeds/low_point_hand.rng`
|
This command runs the game with all bots and a seed from `./seeds/low_point_hand.rng`
|
||||||
|
|
||||||
# Controls
|
# Controls
|
||||||
I hope that you know how to play the Singaporean version of Bridge.
|
The `p` key has to be pressed to begin the game.
|
||||||
|
During the game, a panel will pop up for you to input the bid and call you partner, in which the list is scrollable.
|
||||||
|
To play a card, double click on a card in your hand.
|
||||||
|
|
||||||
Currently, the `p` key has to be pressed to begin the game.
|
If you are using the legacy terminal inputting option,
|
||||||
During the game, **all inputs are done through the terminal**.
|
**all inputs are done through the terminal**.
|
||||||
Instructions on the input format should appear in the terminal.
|
Instructions on the input format should appear in the terminal.
|
||||||
|
|
||||||
I'm looking into changing the input to be mouse-based as a separate version.
|
|
||||||
|
|
||||||
When closing the game, please be a bit patient. It should close within a second or two.
|
When closing the game, please be a bit patient. It should close within a second or two.
|
||||||
You may also close it via Keyboard Interrupt (i.e. `Ctrl+c`) in the terminal.
|
You may also close it via Keyboard Interrupt (i.e. `Ctrl+c`) in the terminal.
|
||||||
|
|
||||||
|
@ -44,5 +45,5 @@ You may also close it via Keyboard Interrupt (i.e. `Ctrl+c`) in the terminal.
|
||||||
Please report any bugs, specifying how the bug can be recreated.
|
Please report any bugs, specifying how the bug can be recreated.
|
||||||
The more specific it is, the better.
|
The more specific it is, the better.
|
||||||
|
|
||||||
Suggestions for improvements on the code are welcomed.
|
Suggestions for improvements are welcomed.
|
||||||
|
|
||||||
|
|
Binary file not shown.
Before Width: | Height: | Size: 87 KiB After Width: | Height: | Size: 87 KiB |
Loading…
Reference in New Issue