[xboard.git] / winboard / install / files / root / PSWBTM / doc / install.html
1 <html>\r
2 <header>\r
3 <title>WGP: Installing Engines</title>\r
4 </header>\r
5 <body>\r
6 <table cellpadding="20"><tr><td>\r
7 <h1>The WinBoard Gold Pack 4.4.0</h1>\r
8 <h2>For the ultimate WinBoard experience!</h2>\r
9 </td><td>\r
10 <img src="../../WinBoard/doc/mini.gif">\r
11 </td></tr></table>\r
12 <h3>Installing Engines in PSWBTM</h3>\r
13 <p>\r
14 Installing a Chess engine always begins with obtaining the necessary files.\r
15 There are many places from which you can download Chess engines.\r
16 Especially the website of \r
17 <a href="http://wbec-ridderkerk.nl/html/enginesindex.htm">WBEC</a> offers a good overview of which engines are around,\r
18 and where they can be obtained.\r
19 </p><p>\r
20 When downloading an engine, it usually come as a compressed archive, (e.g. a .zip file),\r
21 containing the engine executabe (= application), plus the data files it needs for its operation\r
22 (opening books, logos, manuals, sometimes source code).\r
23 There are many compression formats around, e.g. .zip, .tar.gz, .rar, .7z.\r
24 On a modern Windows system, the decompression sftware will understand most of those.\r
25 </p><p>\r
26 One thing one should carefully observe is if the downloaded archive contains a single folder,\r
27 or  large group of individual files and folders.\r
28 In the first case, we would like to place this single folder in the folder on our computer\r
29 that holds all our Chess engines:\r
30 we would like to have a single folder for each engine, or each version of an engine there.\r
31 Otherwise, things would quickly degenerate into a mess, one Chess engine using incompatible data of another,\r
32 because it happened to have the same name, etc.\r
33 So if the engine comes as a set of loose files inside the archive, rather than a single folder,\r
34 we first want to create a new folder inside the folder that holds all our engines,\r
35 and unpack the archive there.\r
36 Otherwise we would have a lot of trouble collecting the just unpacked files and folders\r
37 from amongst out other engine folders.\r
38 Milk is a lot easier to spill on the floor than to get back into the bottle, and the same holds for files.\r
39 So just to be save I always create a new folder for the engine I am downloading.\r
40 If it turns out that unpacking the download gives me a single folder inside this folder,\r
41 it is easy enough to eliminate one level of folders, by selecting all the contents,\r
42 and dragging it to the encompassing folder.\r
43 Very often it is the folder that came with the archive that I get rid off, because it has a cumbersome name.\r
44 </p><p>\r
45 When the files are sitting where you want them, you have to tell PSWBTM were they are.\r
46 PSWBTM will transmit that information to WinBoard when it wants this engine to play.\r
47 So WinBoard itself does not have to know anything of the engines,\r
48 except when you also want to run the without PSWBTM,\r
49 through the WinBoard startup dialog.\r
50 </p><p>\r
51 To install an engine in PSWBTM, you start up PSWBTM, and select "Tools -> Engine Manager" to pop up\r
52 the engine-manager window.\r
53 First click the "New" button on the lower-left, to signal that you are going to install a new engine.\r
54 (Otherwise you run the risk to overwrite an existing engine, so that it wil disappear from te PSWBTM database.)\r
55 After that, you have to complete the three text fields on the upper right.\r
56 </p><p>\r
57 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
58 You can give it any name you like, this information is only for your convenience.\r
59 On the second line you must tell PSWBTM where it can find the engine application file.\r
60 Simplest is to use the "Browse" button to browse to it.\r
61 This pops up a file-selector dialog.\r
62 What you have to do then depends on the type of engine,\r
63 if it is WinBoard or UCI.\r
64 First we discuss the WinBoard case.\r
65 </p>\r
66 <h3>WinBoard Engines</h3>\r
67 <p>\r
68 Navigate through your file-system tree, first to your folder where all engines folders are, \r
69 and then to the folder of the freshly downloaded engine in it.\r
70 The file-selector dialog only shows you folders and application (.exe) files.\r
71 Usually the engine applicaton is present in the folder you downloaded; \r
72 sometimes it in a sub-folder "bin".\r
73 Once you reach the executable, double-click it, and the file-selector dialaog will close,\r
74 and leave the full name of the application in the second input field of the engine manager window.\r
75 </p><p>\r
76 The third line has to contain the options the engine needs on the command line that starts it.\r
77 What you have to put here can vary enormously, and suffers from total absence of standardization.\r
78 Some engines do not need any options on their command line,\r
79 because they read all their settings from asom fixed file.\r
80 (Usulally this is a .ini file that came with the download of the engine, and sits with it in the same folder.)\r
81 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
82 If you omit this, Fairy-Mas uses a default value (96MB), so the option is not strictly needed.\r
83 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
84 Which options you need, and what their values mean can only be learned from reading the documentation that came with the engine.\r
85 Fairly common is an option to set the hash size, often called hash, -hash or /hash=....\r
86 Some engines need an option xboard or /xboard or --io-mode=xboard to work as WinBoard engines,\r
87 and use their own built-in GUI otherwise.\r
88 Anyway, whatever the engine needs, you have to type in this third line.\r
89 </p>\r
90 <h3>UCI Engines</h3>\r
91 <p>\r
92 For UCI Engines you must not browse to the engine aplication, but to Polygot in stead.\r
93 The latter can be found in the Polyglot15w folder of the WinBoard Gold Pack,\r
94 which should also be located in the folder with all engine folders.\r
95 In fact Polyglot is an engine for WinBoard, \r
96 except that it does't think up the moves it sends toWinBoard by itself,\r
97 but consults a UCI engine (speaking to it in UCI protocol) without WinBoard knowing anything about it.\r
98 The application you need is named "polyglot.exe" in this folder.\r
99 Do not confuse it with "Polyglot GUI.exe, which should also be in this folder,\r
100 if you downloaded it.\r
101 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
102 </p><p>\r
103 The third line, for the engine options, now contains the options for Polyglot.\r
104 The latter needs only a single option, the name of a file where is specified what it really has to do\r
105 (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
106 If you type a simple filename (without a folder-name part, i.e. without backslashes '\' in it),\r
107 Polyglot will look for this file in the directory where its .exe file is located,\r
108 which is just the place where we put all such files.\r
109 So we type such a simple filename here, which reminds us of the engine.\r
110 E.g. to install Fruit, we would type "fruit.ini" on the third line.\r
111 That is not the full story yet,\r
112 as we also would have to provide the fruit.ini file.\r
113 Normally we would have made that file before we would install the engine in PSWBTM,\r
114 (see the <a = href="polyglotGUI">installing UCI engines with Polygot GUI</a> page),\r
115 but you can also do it afterwards.\r
116 The WinBoard Gold pack does already contain a pre-installed fruit.ini file, though,\r
117 so at the moment we can simply continue.\r
118 </p>\r
119 <h3>Finishing the install for both WB and UCI engines</h3>\r
120 <p>\r
121 It is possible to add  few options for WinBoard that will only be used with this engine,\r
122 and not automatically with any other engine you put it with in the same tournament.\r
123 (Usually you don't need that so you might skip this paragraph, but it is useful to be aware of the possibility.)\r
124 E.g., you could give it a time-odds penalty if it was too strong to make the tournament interesting,\r
125 and let it play with only half the time (say) of its opponents.\r
126 Winboard does have the optons /firstTimeOdd=2 and /secondTimeOdds=2 for this.\r
127 PSWBTM does not have a separate input field for such engine-specific WinBoard settigs,\r
128 but you can enter them at the end of te engine options, on the third input line,\r
129 after the word "WBopt".\r
130 Everything behind this word will be interpreted as WinBoard options,\r
131 which will overrule any options in the winboard.ini, or even on the command line invoking WinBoard.\r
132 Because the engine will sometimes run under WinBoard as first, and sometimes as second engine,\r
133 (depending on the color it plays),\r
134 you have to leave it open which of the two time-odds options should be used.\r
135 This is done by replacing the "first" or "second" in the option name by "%s".\r
136 So for the time-odds example, you would add "WBopt /%sTimeOdds=1" to the third line.\r
137 An example for Fairy-Max is pre-installed.\r
138 </p><p>\r
139 When you have completed all three text-input fields, you should press the button "Save" below it.\r
140 After that, you could install a new engine by pressing "New",\r
141 but be sure you press "Save" first, or you would lose everything you just did!\r
142 If you don't ant to install any other engines,\r
143 you should press "Save Changes", and then "Exit" to close the engine manager.\r
144 (It is kind eough to arn you if you forget to press "Save Changes",\r
145 which is just as well, as exiting without it would make you lose all engines you just installed!)\r
146 The newly installed engines are then ready for selection in a tournament!\r
147 (Unless it was UCI and you forgot to make the Polyglot .ini file!)\r
148 Befor you press "Exit"\r
149 </p>\r
150 <h3>Links</h3>\r
151 <p>\r
152 a href=".html"></a>\r
153 </br>\r
154 <a href=".html"></a>\r
155 </br>\r
156 <a href=".html"></a>\r
157 </br>\r
158 <a href=".html"></a>\r
159 </br>\r
160 <a href=""></a>\r
161 </br>\r
162 <a href=""></a>\r
163 </br>\r
164 <a href=""></a>\r
165 </p><p>\r
166 </p><p>\r
167 </p><p>\r
168 </p><p>\r
169 </p><p>\r
170 \r
171 </p>\r
172 </body>\r
173 </html>