sadpmpk
/
pyFloatingBridge
1
0
Fork 0
Code Issues Pull Requests Projects Releases Wiki Activity

Modify Readme on the controls

master
En Yi 2019-06-15 18:02:44 +01:00
parent 1c813e0fac
commit 84f733b6bb
1 changed files with 8 additions and 5 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

13
README.md
View File

@ -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`
@ -31,11 +32,13 @@ This command runs the game with all bots and a seed from `./seeds/low_point_hand
# Controls # Controls
I hope that you know how to play the Singaporean version of Bridge. I hope that you know how to play the Singaporean version of Bridge.
Currently, the `p` key has to be pressed to begin the game. The `p` key has to be pressed to begin the game.
During the game, **all inputs are done through the terminal**. During the game, a panel will pop up for you to input the bid and call you partner.
Instructions on the input format should appear in the terminal. To play a card, double click on a card in your hand.
I'm looking into changing the input to be mouse-based as a separate version. If you are using the legacy terminal inputting option,
**all inputs are done through the terminal**.
Instructions on the input format should appear in the terminal.
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 +47,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.