Skip to content

Commit 131a797

Browse files
authored
Update README.md
1 parent 5bbd73b commit 131a797

1 file changed

Lines changed: 42 additions & 1 deletion

File tree

README.md

Lines changed: 42 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -1,7 +1,7 @@
11
# Python Easy Chess GUI
22
A Chess GUI based from Python using PySimpleGUI and Python-Chess modules. Users can also load a chess engine and play with it. This program is based on a [demo chess against ai](https://github.com/PySimpleGUI/PySimpleGUI/tree/master/Chess) from PySimpleGUI.<br>
33

4-
![](https://i.imgur.com/ij2aKAl.png)
4+
![](https://i.imgur.com/J09H5GX.png)
55

66
### Requirements
77
Windows exe file will be available upon release. In the meantime to get it running the following are required.
@@ -63,6 +63,47 @@ Typical command line:<br>
6363
#### To Hide/Unhide Book info
6464
* Press the Book 1 or Book 2 text
6565

66+
### 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 <br>
71+
_If user wants to play as black_
72+
* Set engine opponent
73+
* Select engine
74+
* Set Threads
75+
* Set Hash
76+
* Set engine opponent opening book settings
77+
* Enable/disable book
78+
* Set best move / random book moves
79+
* Set engine thinking time and maximum search depths
80+
* Set engine adviser
81+
* Select engine
82+
* Set Threads
83+
* Set Hash
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+
* Paste a FEN
89+
* Set engine opponent
90+
* Select engine
91+
* Set Threads
92+
* Set Hash
93+
* Set engine thinking time and maximum search depths
94+
* Can ask opening book assistance
95+
* Can ask adviser engine on its best move and/or principal variation
96+
* Can Save game
97+
* Can Set opponent engine opening book
98+
* Change to Neutral mode
99+
2. Engine opponent to move
100+
* User can interrupt engine while thinking by
101+
* Move now
102+
* New Game
103+
* Quit the app
104+
105+
106+
66107
### Credits
67108
* PySimpleGUI<br>
68109
https://github.com/PySimpleGUI/PySimpleGUI

0 commit comments

Comments
 (0)