Skip to content

Commit

Permalink
docu
Browse files Browse the repository at this point in the history
  • Loading branch information
LocutusOfPenguin committed Jan 1, 2018
1 parent 328eb13 commit bf17fb3
Show file tree
Hide file tree
Showing 5 changed files with 17 additions and 15 deletions.
12 changes: 6 additions & 6 deletions docs/usage.rst
Original file line number Diff line number Diff line change
Expand Up @@ -6,7 +6,7 @@ Setup the starting position
Place the pieces in starting position. It doesn't matter if you have the white or black pieces in front of you. Both ways will work. Keep in mind that with black pieces in front of you the (printed) coordinates of your dgt-board also reversed.
You can now start a game by moving a piece or press the lever to let picochess start as white.

Its also possible to play a chess960 (Fischer Random Chess) game. Just set up your chess960 position. Please choose "Stockfish" as your engine, cause the other engines dont support chess960 mode.
Its also possible to play a chess960 (Fischer Random Chess) game. Just set up your chess960 position. Please choose "Stockfish", "Galjoen" or "WyldChess" as your engine, cause the other engines dont support chess960 mode.
Before or during your game you can also change your settings like book, time, engine, and many more (see details below). These settings are safed and reloaded, so you start with your old settings first.
Settings can be changed by placing the white & black queen at the fields a4-h6 (you must be in the starting position) or by using the clock buttons (no matter the board position).
With the queen placing you can change some default values, whereas the clock buttons offers the complete options.
Expand All @@ -16,11 +16,11 @@ Playing/Training Modes

When using these modes, please be patient and don't rush moves. Allow a few seconds for the scores and moves to appear. If you see any bug when rushing moves, let us know on the mailing list.

* Game mode (enabled by **white** queen on **A5**). This is the default mode. You can play against the computer. The clock displays the remaining thinking time for both sides. Press the second button to show the position evaluation, expressed in centipawns. Press again to show a hint ("ponder move").
* Game mode (enabled by **white** queen on **A5**). This is the default mode. You can play against the computer. The clock displays the remaining thinking time for both sides.
* Brain mode (enabled by **white** queen on **B5**). This is same as Game mode but the computer is using the permanent brain to think ahead on your thinking time.
* Analysis mode (enabled by **white** queen on **C5**): the computer is watching the game, it does not play itself. The clock continually displays the best move for the side to play.
* Kibitz mode (enabled by **white** queen on **D5**): the computer is watching the game, it does not play itself. The clock continually displays the position score (right aligned) with the search depth (left aligned).
* Observe mode (enabled by **white** queen on **E5**): the computer is watching the game, it does not play itself. The clock displays the remaining thinking time for both sides. Press the second button once to show the position evaluation, twice to show a hint.
* Observe mode (enabled by **white** queen on **E5**): the computer is watching the game, it does not play itself. The clock displays the remaining thinking time for both sides. The computer is thinking silently ahead. You can see the results by pressing the clock buttons (see below)
* Ponder mode (enabled by **white** queen on **F5**): the computer is watching the game, it does not play itself. The clock displays the best move for the side to play in a 2 secs rotation with the position score together with the depth. So, this mode is a combination of "Analysis" & "Kibitz"
* Remote mode (enabled by **white** queen on **H5**): this mode will allow you to play against someone over internet. The remote player using the webserver whereas the other player using the pieces as normal to enter moves. A detailed documentation will be provided lateron.

Expand Down Expand Up @@ -80,7 +80,7 @@ engines are set with the extra **black** queen.
* **D6** - Rodent III
* **E6** - Zurichess neuchatel
* **F6** - WyldChess 10062017
* **G6** - Galjoen 0.37.1
* **G6** - Galjoen 0.37.2
* **H6** - Sayuri 2017.12.16

Another way to choose the engine is by entering the "Engine" menu with the clock buttons.
Expand Down Expand Up @@ -156,7 +156,7 @@ If you already inside the menu (clock showing you menu or value items) the funct

* **(<) button** - moving up a level inside the menu tree. If you already at top exists the menu
* **(-) button** - showing the previous value inside the menu tree
* **(=) button** - no function
* **(=) button** - no function (in position submenu: use last choosen values for the remaining questions)
* **(+) button** - showing the next value inside the menu tree
* **(>) button** - moving down a level inside the menu tree. If there is none, it accepts the choosen value and exists the menu

Expand All @@ -176,7 +176,7 @@ With the "=" button you can shortcut the 4 levels (useful for similar positions)

* **side** - decides with side to move first
* **origin** - is the board flipped (which side of board is white which is black)
* **chess960** - is this a fischer random position (used for castling) Please make sure your choose engine support 960 mode (right now only stockfish, galjoe)
* **chess960** - is this a fischer random position (used for castling) Please make sure your choose engine support 960 mode (right now only stockfish, galjoe, wyldchess)
* **scan** - after accepting with ">" picochess will scan in the position (last chance to setup your pieces) and a new game will start

Time Menu
Expand Down
12 changes: 6 additions & 6 deletions engines/descriptions.txt
Original file line number Diff line number Diff line change
@@ -1,5 +1,5 @@
PicoChess Engines
November 05, 2017
January 01, 2018


1. STOCKFISH
Expand Down Expand Up @@ -55,7 +55,7 @@ including skill levels to make it an attractive opponent for players of every st
4. RODENT III
===========================
Author: Paweł Kozioł
Version: 0.229
Version: 0.233
Date: November 2017
Elo: 2920
Levels: 'Personalities'
Expand Down Expand Up @@ -105,8 +105,8 @@ engines not as detailed, but its tactics is very strong.
7. GALJOEN
===========================
Author: Werner Taelemans
Version: 0.36
Date: July 2017
Version: 0.37.2
Date: December 2017
Elo: 2150
Levels: yes
Chess960: yes
Expand All @@ -122,8 +122,8 @@ user interface, which is, of course, not used by PicoChess.
8. SAYURI
===========================
Author: Hironori Ishibashi
Version: 2017.09.29
Date: September 2017
Version: 2017.12.16
Date: December 2017
Elo: 1840
Levels: no
Chess960: no
Expand Down
Binary file modified manual/ShortManual.odt
Binary file not shown.
Binary file modified manual/ShortManual.pdf
Binary file not shown.
8 changes: 5 additions & 3 deletions picochess.ini.example
Original file line number Diff line number Diff line change
@@ -1,5 +1,5 @@
### ===================================
### = picochess.ini.example v0.9[l-z] =
### = picochess.ini.example v0.9[m-z] =
### ===================================
### Example and description how to configure PicoChess
### To use this file, simply copy this file to picochess.ini and edit the appropriate settings
Expand Down Expand Up @@ -50,15 +50,17 @@
## Sets the UCI engine used at startup
## handle with care. If you setup this section wrong, picochess won't start.
## Path to the engine relative to the 'picochess' folder (local engine - standard case)
## If you use a remote engine server, please make sure that you also set 'engine-remote-home' accordingly
# engine = engines/armv7l/a-stockf
## What level the engine should have at startup?
## For a (correct) value please take a look at 'engines/<your_plattform>/<engine_name>.uci'
# engine-level = Level@20
### =========================
### = Remote engine options =
### =========================
### Parameters for a remote engine (server) - good chances you do not need them ;-)
## Path to the remote engine - good chances you do not need them ;-)
## Please make sure that you also set 'engine-remote-home' accordingly
# engine-remote = engines/armv7l/a-stockf
### Parameters for a remote engine (server)
## Where is the server with the engine
# engine-remote-server = engine.remote-domain.com
## What user to use for connect to the remote-engine server
Expand Down

0 comments on commit bf17fb3

Please sign in to comment.