--- /dev/null
+<html>\r
+<header>\r
+<title>WGP: Installing Engines</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>Installing Engines in PSWBTM</h3>\r
+<p>\r
+Installing a Chess engine always begins with obtaining the necessary files.\r
+There are many places from which you can download Chess engines.\r
+Especially the website of \r
+<a href="http://wbec-ridderkerk.nl/html/enginesindex.htm">WBEC</a> offers a good overview of which engines are around,\r
+and where they can be obtained.\r
+</p><p>\r
+When downloading an engine, it usually come as a compressed archive, (e.g. a .zip file),\r
+containing the engine executabe (= application), plus the data files it needs for its operation\r
+(opening books, logos, manuals, sometimes source code).\r
+There are many compression formats around, e.g. .zip, .tar.gz, .rar, .7z.\r
+On a modern Windows system, the decompression sftware will understand most of those.\r
+</p><p>\r
+One thing one should carefully observe is if the downloaded archive contains a single folder,\r
+or large group of individual files and folders.\r
+In the first case, we would like to place this single folder in the folder on our computer\r
+that holds all our Chess engines:\r
+we would like to have a single folder for each engine, or each version of an engine there.\r
+Otherwise, things would quickly degenerate into a mess, one Chess engine using incompatible data of another,\r
+because it happened to have the same name, etc.\r
+So if the engine comes as a set of loose files inside the archive, rather than a single folder,\r
+we first want to create a new folder inside the folder that holds all our engines,\r
+and unpack the archive there.\r
+Otherwise we would have a lot of trouble collecting the just unpacked files and folders\r
+from amongst out other engine folders.\r
+Milk is a lot easier to spill on the floor than to get back into the bottle, and the same holds for files.\r
+So just to be save I always create a new folder for the engine I am downloading.\r
+If it turns out that unpacking the download gives me a single folder inside this folder,\r
+it is easy enough to eliminate one level of folders, by selecting all the contents,\r
+and dragging it to the encompassing folder.\r
+Very often it is the folder that came with the archive that I get rid off, because it has a cumbersome name.\r
+</p><p>\r
+When the files are sitting where you want them, you have to tell PSWBTM were they are.\r
+PSWBTM will transmit that information to WinBoard when it wants this engine to play.\r
+So WinBoard itself does not have to know anything of the engines,\r
+except when you also want to run the without PSWBTM,\r
+through the WinBoard startup dialog.\r
+</p><p>\r
+To install an engine in PSWBTM, you start up PSWBTM, and select "Tools -> Engine Manager" to pop up\r
+the engine-manager window.\r
+First click the "New" button on the lower-left, to signal that you are going to install a new engine.\r
+(Otherwise you run the risk to overwrite an existing engine, so that it wil disappear from te PSWBTM database.)\r
+After that, you have to complete the three text fields on the upper right.\r
+</p><p>\r
+In the upper field you have to type the name under which you want this engine to appear in the list you see on the left.\r
+You can give it any name you like, this information is only for your convenience.\r
+On the second line you must tell PSWBTM where it can find the engine application file.\r
+Simplest is to use the "Browse" button to browse to it.\r
+This pops up a file-selector dialog.\r
+What you have to do then depends on the type of engine,\r
+if it is WinBoard or UCI.\r
+First we discuss the WinBoard case.\r
+</p>\r
+<h3>WinBoard Engines</h3>\r
+<p>\r
+Navigate through your file-system tree, first to your folder where all engines folders are, \r
+and then to the folder of the freshly downloaded engine in it.\r
+The file-selector dialog only shows you folders and application (.exe) files.\r
+Usually the engine applicaton is present in the folder you downloaded; \r
+sometimes it in a sub-folder "bin".\r
+Once you reach the executable, double-click it, and the file-selector dialaog will close,\r
+and leave the full name of the application in the second input field of the engine manager window.\r
+</p><p>\r
+The third line has to contain the options the engine needs on the command line that starts it.\r
+What you have to put here can vary enormously, and suffers from total absence of standardization.\r
+Some engines do not need any options on their command line,\r
+because they read all their settings from asom fixed file.\r
+(Usulally this is a .ini file that came with the download of the engine, and sits with it in the same folder.)\r
+Fairy-max is a very simple engine, and the only argument it can have is a number to specify the size of its hash table.\r
+If you omit this, Fairy-Mas uses a default value (96MB), so the option is not strictly needed.\r
+In the WinBoard Gold Pack Fairy-Max is installed with an 48MB hash table, which for Fairy-Max is indicated by the option "22".\r
+Which options you need, and what their values mean can only be learned from reading the documentation that came with the engine.\r
+Fairly common is an option to set the hash size, often called hash, -hash or /hash=....\r
+Some engines need an option xboard or /xboard or --io-mode=xboard to work as WinBoard engines,\r
+and use their own built-in GUI otherwise.\r
+Anyway, whatever the engine needs, you have to type in this third line.\r
+</p>\r
+<h3>UCI Engines</h3>\r
+<p>\r
+For UCI Engines you must not browse to the engine aplication, but to Polygot in stead.\r
+The latter can be found in the Polyglot15w folder of the WinBoard Gold Pack,\r
+which should also be located in the folder with all engine folders.\r
+In fact Polyglot is an engine for WinBoard, \r
+except that it does't think up the moves it sends toWinBoard by itself,\r
+but consults a UCI engine (speaking to it in UCI protocol) without WinBoard knowing anything about it.\r
+The application you need is named "polyglot.exe" in this folder.\r
+Do not confuse it with "Polyglot GUI.exe, which should also be in this folder,\r
+if you downloaded it.\r
+Double-click polyglot to leave the file-selector dialog, and get its full file name in the second input field of the engine manager.\r
+</p><p>\r
+The third line, for the engine options, now contains the options for Polyglot.\r
+The latter needs only a single option, the name of a file where is specified what it really has to do\r
+(i.e. which UCI engine it should fire up to get the moves, and what parameter settings it should use to control this engine).\r
+If you type a simple filename (without a folder-name part, i.e. without backslashes '\' in it),\r
+Polyglot will look for this file in the directory where its .exe file is located,\r
+which is just the place where we put all such files.\r
+So we type such a simple filename here, which reminds us of the engine.\r
+E.g. to install Fruit, we would type "fruit.ini" on the third line.\r
+That is not the full story yet,\r
+as we also would have to provide the fruit.ini file.\r
+Normally we would have made that file before we would install the engine in PSWBTM,\r
+(see the <a = href="polyglotGUI">installing UCI engines with Polygot GUI</a> page),\r
+but you can also do it afterwards.\r
+The WinBoard Gold pack does already contain a pre-installed fruit.ini file, though,\r
+so at the moment we can simply continue.\r
+</p>\r
+<h3>Finishing the install for both WB and UCI engines</h3>\r
+<p>\r
+It is possible to add few options for WinBoard that will only be used with this engine,\r
+and not automatically with any other engine you put it with in the same tournament.\r
+(Usually you don't need that so you might skip this paragraph, but it is useful to be aware of the possibility.)\r
+E.g., you could give it a time-odds penalty if it was too strong to make the tournament interesting,\r
+and let it play with only half the time (say) of its opponents.\r
+Winboard does have the optons /firstTimeOdd=2 and /secondTimeOdds=2 for this.\r
+PSWBTM does not have a separate input field for such engine-specific WinBoard settigs,\r
+but you can enter them at the end of te engine options, on the third input line,\r
+after the word "WBopt".\r
+Everything behind this word will be interpreted as WinBoard options,\r
+which will overrule any options in the winboard.ini, or even on the command line invoking WinBoard.\r
+Because the engine will sometimes run under WinBoard as first, and sometimes as second engine,\r
+(depending on the color it plays),\r
+you have to leave it open which of the two time-odds options should be used.\r
+This is done by replacing the "first" or "second" in the option name by "%s".\r
+So for the time-odds example, you would add "WBopt /%sTimeOdds=1" to the third line.\r
+An example for Fairy-Max is pre-installed.\r
+</p><p>\r
+When you have completed all three text-input fields, you should press the button "Save" below it.\r
+After that, you could install a new engine by pressing "New",\r
+but be sure you press "Save" first, or you would lose everything you just did!\r
+If you don't ant to install any other engines,\r
+you should press "Save Changes", and then "Exit" to close the engine manager.\r
+(It is kind eough to arn you if you forget to press "Save Changes",\r
+which is just as well, as exiting without it would make you lose all engines you just installed!)\r
+The newly installed engines are then ready for selection in a tournament!\r
+(Unless it was UCI and you forgot to make the Polyglot .ini file!)\r
+Befor you press "Exit"\r
+</p>\r
+<h3>Links</h3>\r
+<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