gyges_engine 1.0.2

A powerful Gygès engine.
Documentation 
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131

# Description of the Universal Gyges Interface (UGI) [Jan 2024]


## Move Format:


Moves are formated by numbers seperated with a `|`. Every number represents a position on the board. You can find the board layout in the `BoardState` documentation.
The format is as follows:
 - The first number is the position of the piece you start with.
 - The second number is the position of the piece you want to replace.
 - The third number is the position you want to drop the replaced piece.

```
<start>|<end>|<drop>
---------------------
   1   |  2  |  9
```
	- Grab the piece at position 1 on the board.
	- Replace the piece at position 2 on the board with it.
	- Drop the replaced piece at position 9.


If a move doesnt require a drop, the format is as follows:
``` 
<start>|<end>
-------------
   1   |  2
```
	- Grab the piece at position 1 on the board.
	- Move it to position 2 on the board.



## Communation Protocol:

All communication takes place over the command line.

### Communation to Engine:

* `ugi`
	Initiates communication with the engine.

* `isready`
	Synchronizes the engine with the GUI, indicating readiness.

* `setoption <name> <value>`
	Used to modify internal parameters.
	* `MaxPly`: int > 0 
	* `MaxTime`: int > 0 (time in seconds)

* `setpos <layout>`
	Sets the board layout; no response is sent.
	* `bench`
	* `start`
	* `data <_>` followed by the board layout

* `go`
	Initiates the engine to start searching.
	Subsequently sends "info <_>" commands during the search.
	Responds with "bestmove <_>" when the search is complete.

* `stop`
	Instructs the engine to stop calculations as soon as possible.
	Response: "bestmove <_>"

* `quit`
	Terminates the program.


### Communation from Engine:

* `ugiok` 
	Sent after processing the `ugi` command to acknowledge UGI mode.

* `id <_>` 
	Information about the engine after the `ugi` command.
	* `name` (engine name)
	* `author` (author name)

* `option <_>`
	Informs the GUI about parameters that can be changed in the engine sent after the `ugi` command.
	* `maxPly`
	* `maxTime` 
	* `ttEnabled`

* `readyok`
	Responds with when ready to accept new commands after the `isready` command.
 
* `info <_>` 
	The engine sends information to the GUI during a search.
    * `ply` (depth of search)
	* `bestmove` (best move found)
	* `score` (evaluation of best move)
	* `nodes` (number of nodes searched)
	* `nps` (nodes per second)
	* `abf` (average branching factor)
	* `time` (time taken to search)

* `bestmove <_>`
	Sent after a completed search to indicate the best move found.
	* `move` (best move found)

## Example:

Communication session between GUI and the engine.

'*' indicates the engine's communication.

```bash
* Gyges UGI Engine v1.0.0

ugi
* id name Helios
* id author beck-bjella
* option maxply
* option maxtime
* option tt_enabled
* ugiok

setpos data 321123/000000/000000/000000/000000/321123 

setoption maxPly 7

isready
* readyok

go
* info ply 1 bestmove 0|1|9 score 1061 nodes 225 nps 234619 abf 225 time 0.000959
* info ply 3 bestmove 0|1|14 score 3493 nodes 68861 nps 72432 abf 40.988 time 0.950

stop
* info ply 3 bestmove 0|1|14 score 3493 nodes 68861 nps 72432 abf 40.988 time 0.950
*bestmove 0|1|14

quit
```