--- /dev/null
+<html>\r
+<header>\r
+<title>WGP: UCI installation</title>\r
+</header>\r
+<body>\r
+<table cellpadding="20"><tr><td>\r
+<h1>The WinBoard Gold Pack 4.4.0</h1>\r
+<h2>For the ultimate WinBoard experience!</h2>\r
+</td><td>\r
+<img src="../../WinBoard/doc/mini.gif">\r
+</td></tr></table>\r
+<h3>Getting UCI Engines to run under Polyglot</h3>.\r
+<p>\r
+UCI engines need the Polyglot adapter to communicate with WinBoard.\r
+As far as WinBoard is concerned, Polyglot is the engine.\r
+Polyglot has to be instructed to which real engine it should 'connect',\r
+and it takes this information from file, known as a Polyglot .ini file.\r
+Apart from telling polyglot which UCI engine to run,\r
+Polyglot alo has to supply all paramter settings for this UCI engine\r
+that WInBoard doesn't.\r
+And UCI engines usually need a lot more support from their GUI than WinBoard engines.\r
+Polyglot has to fill in the gaps, again from information stored in the Polyglot .ini file.\r
+</p><p>\r
+This leaves us with the problem to fill that Poglot .ini file with all the required info.\r
+For the engine name, location and standard parameters this is not such a big problem:\r
+we could copy the .ini file of another engine, and just change the name in it.\r
+But every UCI engine defines its own engine-specific options,\r
+and they all do it in different ways, needing different values for them.\r
+Polyglot GUI is a program that figures out what options a UCI engine needs,\r
+and what their defaut settings what should be.\r
+It then can create a Polyglot .ini file for that engine that contins all this information.\r
+</p><p>\r
+Navigate to the Polyglot14w folder of the WinBoard Gold Pack.\r
+This folder contains two application files, polyglot itself\r
+(which is there ony for running by WinBoard),\r
+and Polyglot GUI.\r
+Double-click the latter to start Polyglot GUI.\r
+A file-selector window will pop, though which you can browse to one of your UCI engines.\r
+By double-clicking the engine application file in the corresponding engine folder,\r
+you will make Polyglot GUI interrogate this engine in UCI protocol,\r
+to learn which options it supports and requires.\r
+In this example we have used Fruit 2.1 for this purpose.\r
+</p><p>\r
+After selecting the engine, a window that is divided in a right and left part will appear.\r
+On the left you will see a set of controls for the engine-specific options,\r
+on the right the options for Polyglot (which are thus always the same).\r
+Both parts of the screen have a vertical slider, as the number of options is usually too large to fit the window.\r
+Fortunately all options are already preset to their default value,\r
+and unless you know very well what an option does, it is best to leave it there.\r
+So we will now only discuss the options that require attention.\r
+</p><p>\r
+We start wit the Polyglot settings on the right.\r
+From top to bottom we see: Engine name, installation folder and name of the application.\r
+In fact this is what we just entered by clicking the engine application, so it is always correct.\r
+Then we must select if Polyglot wil use a book on behalf of the engine,\r
+and where to find this book file (which must be a book in Polyglot format).\r
+Although WinBoard is also able to consult a book on behalf of the engines,\r
+it currently always consults the same book for both engines.\r
+So it does not make much sense to ut the same general book here as WinBoard is already using.\r
+But some UCI engines are dependent on Polyglot for their opening book,\r
+although it is a book that is made especially for them.\r
+For such engines it would make sense to put the book dedicated to them here.\r
+Then they can use their private book, while the opponent is using another one.\r
+Fruit downloads usually comes with an opening book called "book_small.bin",\r
+and we could type that in the book field, provided that we have put it in the Polyglot14w folder\r
+with the other Polyglot books, including the general book "default.bin" that came with the WinBoard Gold Pack.\r
+If we prefer to keep the book in the Fruit2_1 folder,\r
+we must type "../Fruit2_1/book_small.bin" here (without the quotes).\r
+This is not really needed, though, as Fruit is perfectly able to consult its own book.\r
+(Polyglot and Fruit use the same book format, as they are by the same author!)\r
+</p><p>\r
+Next check box and text field only have to be completed if we want to make a log file\r
+(recording all communication between Polyglot and WinBoard), which makes little sense for normal use.\r
+(It is meant for debugging.)\r
+Then we can control if Polyglot must be able to resign on behalf of the engine.\r
+(UCI engines cannot resign by themselves.)\r
+</p>\r
+<img src="PGfruit.png">\r
+<p>\r
+The left part of the Polyglot GUI window will look different for every engine,\r
+as it represents the engine-specific options.\r
+Some options are standard, though.\r
+These are shown at the top.\r
+We startd there entering the size of the hash table.\r
+(Future Polyglot versions might overrule this with the value specified in WinBoard, \r
+but for now it is an important engine parameter.)\r
+The check box that follows is not important,\r
+as Polylot will translate and transmit the ponder command from WinBoard to the engine in real time,\r
+and is not dependent on a static setting gven in the Polyglot .ini file.\r
+If you want to run matches between 2 engines, select about 1/4 of your computer's memory size.\r
+</p><p>\r
+Next you would have to specify if the engine has an "own" book, \r
+i.e. one that it can consult without the aid of Polyglot.\r
+We already mentioned that for Fruit you can do both, because the format of ts own book\r
+is the same as hat of a Polyglot book.\r
+But in general, that will not be the case, and books downloaded with the engine might have\r
+an unknown proprietry formt.\r
+Then it is really essential to put the name of that book here, \r
+and not in the right part as Polyglot book, as Polyglot wouldn't understand any of it.\r
+In the Fruit example, the following options are already specialist options for tuning the engine,\r
+and we leave them alone.\r
+</p><p>\r
+SMP engines might have another important parameter, the number of CPUs they must use.\r
+The name for this option is not standardized,\r
+but contains something like "threads", "cores", or "CPUs" in its description.\r
+Better not use values larger than the number of cores your computer has if you plan to play without ponder,\r
+and even half of tat when you want to play with ponder on.\r
+</p>\r
+<h3>Saving the Settings in a Polyglot .ini file</h3>\r
+<p>\r
+The last, and most important step is to save the settings we just made in a Polyglot .ini file.\r
+To this end we must first type the name of the file we want,\r
+which is the name that we also use when installing the engine in the PSWBTM engine database.\r
+This name must be unique, as all Polyglot .ini files sit in the same folder in the \r
+configuration the WinBoard Gold Pack uses.\r
+So never call it polyglot.ini, as Polyglot GUI proposes.\r
+For Fruit we would call it fruit.ini.\r
+If we have multiple versions of Fruit on our computer they all must have their own .ini file \r
+with its own unique name.\r
+After having typed this name, we click the "Save" button on the bottom right.\r
+That terminates Polyglot GUI,\r
+and leaves the .ini file in the Polyglot14w folder (which is where Polyglot expects it).\r
+</p><p>\r
+</p><p>\r
+<a href=".html"></a>\r
+</br>\r
+<a href=".html"></a>\r
+</br>\r
+<a href=".html"></a>\r
+</br>\r
+<a href=".html"></a>\r
+</br>\r
+<a href=""></a>\r
+</br>\r
+<a href=""></a>\r
+</br>\r
+<a href=""></a>\r
+</p><p>\r
+</p><p>\r
+</p><p>\r
+</p><p>\r
+</p><p>\r
+\r
+</p>\r
+</body>\r
+</html>
\ No newline at end of file
projects / xboard.git / blobdiff