Skip to content

Commit 9b5d4f6

Browse files
authored
Update README.md
1 parent b6f9fd6 commit 9b5d4f6

File tree

1 file changed

+5
-40
lines changed

1 file changed

+5
-40
lines changed

README.md

Lines changed: 5 additions & 40 deletions
Original file line numberDiff line numberDiff line change
@@ -7,10 +7,11 @@ A Chess GUI based from Python using PySimpleGUI and Python-Chess modules. Users
77
Windows exe file will be available upon release. In the meantime to get it running the following are required.
88
* Python 3.7 and up
99
* Python-chess v0.28.0 and up
10-
* PySimpleGUI 4.0.0
10+
* PySimpleGUI 4.0.0 and up
1111
* Pyperclip
1212

1313
### B. Installation
14+
1. If you want to run from the source code
1415
* Python Easy Chess GUI<br>
1516
Download the files including the Images, Engines and Book directories. You can use your favorite uci chess engine like stockfish by copying it into the engines dir.
1617
* Python 3<br>
@@ -24,11 +25,14 @@ pip install pysimplegui
2425
* Pyperclip<br>
2526
https://github.com/asweigart/pyperclip<br>
2627
pip install pyperclip
28+
2. If you want to run from the exe
29+
* Download the exe file from the release link
2730

2831
### C. How to play
2932
* Execute python_easy_chess_gui.py<br>
3033
Typical command line:<br>
3134
`python python_easy_chess_gui.py`
35+
* Execute the exe when using exe file
3236

3337
#### To play as white
3438
* Mode->Play
@@ -63,45 +67,6 @@ Typical command line:<br>
6367
#### To Hide/Unhide Book info
6468
* Right-click on BOOK 1 or BOOK 2 labels
6569

66-
### D. GUI/User process flow
67-
1. This app has 2 modes Neutral and Play. After executing the app the user is brought to Neutral mode.
68-
69-
2. In Neutral mode user can
70-
* Flip the board
71-
* If user wants to play as black
72-
* Quit the app
73-
* Set engine opponent
74-
* Set opponent engine opening book settings
75-
* Enable/disable book
76-
* Set best move / random book moves
77-
* Set opponent engine time control
78-
* Fischer type
79-
* Timepermove type
80-
* Set engine adviser
81-
* Set time control of User
82-
* Fischer type
83-
* Delay type
84-
+ Change to Play mode <br>
85-
Play mode has 2 main states
86-
1. User to move
87-
* User can make a move on the board by pressing the from square and the to square
88-
* User can make the engine think and play a move by pressing Engine->Go
89-
* Paste a FEN
90-
* Use wants to play from a different position than the usual startposition
91-
* Can ask opening book assistance
92-
* Can ask adviser engine on its best move and/or principal variation
93-
* After pressing the text Advise button, the adviser will search for best move. Once the color of pv line becomes blue that means it is done thinking and the user can now make a move on the board.
94-
* Can Save game
95-
* Change to Neutral mode
96-
2. Engine opponent to move
97-
* User can interrupt engine while thinking by
98-
* Move now
99-
* New Game
100-
* Quit the app
101-
* Hide/unhide engine search info
102-
* Hide/unhide 2 user books
103-
* Change mode back to neutral
104-
10570
### E. Credits
10671
* PySimpleGUI<br>
10772
https://github.com/PySimpleGUI/PySimpleGUI

0 commit comments

Comments
 (0)