c8c2ced3dfd1a2526f240137cfcc27120e6d47a3
[xboard.git] / winboard / install / files / root / PSWBTM / README.txt
1 =================\r
2 PSWBTM 2.0 README\r
3 =================\r
4 \r
5 Website\r
6 =======\r
7 http://www.prism.gatech.edu/~gtg365v/PSWBTM/\r
8 \r
9 Release Note\r
10 ============\r
11 I had promised there would be a Linux release with this PSWBTM but I haven't had the\r
12 time to do it yet and I've also found out that Xboard is very different from Winboard.\r
13 Perhaps it would be a better idea to port Winboard to various operating systems by\r
14 using a cross-platform programming API like wxWidgets.\r
15 \r
16 Licence\r
17 =======\r
18 Copyright (C) 2006 Pradu Kannan\r
19 \r
20 This software is provided 'as-is', without any express or implied warranty. In\r
21 no event will the authors be held liable for any damages arising from the use of\r
22 this software.\r
23 \r
24 Permission is granted to anyone to use this software for any purpose, including\r
25 commercial applications, and to alter it and redistribute it freely, subject to\r
26 the following restrictions:\r
27 \r
28 1. The origin of this software must not be misrepresented; you must not claim\r
29 that you wrote the original software. If you use this software in a product, an\r
30 acknowledgment in the product documentation would be appreciated but is not required.\r
31 \r
32 2. Altered source versions must be plainly marked as such, and must not be\r
33 misrepresented as being the original software.\r
34 \r
35 3. This notice may not be removed or altered from any source distribution. \r
36 \r
37 \r
38 Instructions\r
39 ============\r
40 \r
41 PSWBTM should be mostly intuitive so the instructions will only point out\r
42 peculiar behaviours of the program.\r
43 \r
44 General\r
45 -------\r
46 All windows are resizable.\r
47 \r
48 Engine Manager\r
49 --------------\r
50 The "save" button only updates the engine list you are editing; you will have to\r
51 click "save as" to save the changes permenantly.\r
52 \r
53 "Select Duplicates" selects all engines with the same name.\r
54 "Select Invalid" does not check java engines for validity.\r
55 \r
56 You can "Import" from Toms's Simple Engine Manger produced winboard.ini files as\r
57 well as PSWBTM export files.\r
58 \r
59 "Export" will only export engines that exists inside the directory where the\r
60 save file is located and it saves all paths as relative. This way you can move\r
61 directories of engines from one computer/drive to another and update PSWBTM\r
62 easily.\r
63 \r
64 You can select multiple engines from the engine list.\r
65 \r
66 New Tournament\r
67 --------------\r
68 \r
69 PSWBTM allows engine updates during a tourney and therefore a pgn file which has\r
70 the updated names will be placed in the Result Table PGN for the purpose of\r
71 producing cross tables.\r
72 \r
73 All debug files will be placed in the debug folder will have the number of its\r
74 respective game in the PGN.\r
75 \r
76 NOTE: winboard.debug will show up in the PSWBTM folder not the Winboard folder.\r
77 NOTE: winboard.ini is loaded from the PSWBTM folder for the tourney.\r
78 \r
79 Starting Postions\r
80 You can setup starting positions using FEN or PGN files.  The position loaded\r
81 will increment every two games in a pairing.  You must make sure there are\r
82 enough positions for the number of games otherwise the game won't start.  You can have PSWBTM rewind after a certain number of starting positions have been played by checking the Rewind checkbox and typing the number of positions to parameter box next to the Rewind checkbox.  If you check two games, then PSWBTM will check play two games with one starting position.  This is helpful say when you are doing two games per pairing and you want to use the same starting position twice with the engines having the colors alternated.\r
83 \r
84 Doubble clicking in the Available or Participants box will move engines to the\r
85 other side.  You can select multiple engines and use the move buttons as well.  You can import pairings from a PGN file or just a regular text file which has lines for "White Player" and "Black Player".  PSWBTM can find matches to the engine names by itself.  For example it can tell that "Buzz, 2.01" is the same engine as "Buzz" or "Buzz 2.01" or "Buzz v201" or pretty much anything else that looks close to "Buzz, 2.01".\r
86 \r
87 Round Robin pairings done FIDE Berger style.\r
88 \r
89 Pairings Tab\r
90 ------------\r
91 You can move the subdivision between the rounds list and pairings list.  If you\r
92 drag it all the way to the side of the window it will hide whichever window you\r
93 wish (this might be useful for gauntlets).  Pressing ctrl-S will show all\r
94 windows again.\r
95 \r
96 Controls Tab\r
97 ------------\r
98 First button is to start/pause the tourney.  Tourney will be paused after the\r
99 current game has finished.\r
100 \r
101 Kill Pause forces winboard and the engines to quit and the killed game will be\r
102 replayed when the tourney continues.\r
103 \r
104 Abort stopts the tournament.\r
105 \r
106 Round Pause automatically pauses the tourney every round.\r
107 \r
108 \r
109 \r
110 Winboard Size and Location\r
111 ---------------------------\r
112 \r
113 If you want to change the size and location of winboard when a tournament starts\r
114 up then do this:\r
115 \r
116 1) Open the engine manager\r
117 2) Launch a quick loading engine\r
118 3) Resize/Move or change other options with the Winboard\r
119 4) Close Winboard\r
120 \r
121 It might be useful know that the working directory while running Winboard is the\r
122 working directory that PSWBTM uses.  Therefore if you double-click to open PSWBTM\r
123 under Windows, the working directory is the directory PSWBTM is in.  Under Linux,\r
124 it is whatever directory you run PSWBTM from.\r
125 \r
126 During Tournament\r
127 -----------------\r
128 \r
129 When a tournament is paused, you can close <,shutdown><,restart> and reopen\r
130 PSWBTM and resume the tournament as if nothing happened.\r
131 \r
132 When a game did not start PSWBTM will produce an error message and a prompt\r
133 asking whether you want to pause the game. This allows you to fix any problems\r
134 that occur during a tournament.\r
135 \r
136 Advanced Features\r
137 -----------------\r
138 If you want certain commands run after every game, put them in a file call\r
139 aftergame.txt.  This will run before moving any pgn or debug files.\r
140 \r
141 For instance you could use this to kill misbehaving engines that hang in memory\r
142 after a game. I suggest you call shell scripts or bat files from aftergame.txt\r
143 to also to be able to use system utilities.\r
144 \r
145 For example to kill certain misbehaving engines in Windows you can do this:\r
146 \r
147 Download a utility that will kill engines (pv.exe)\r
148 http://www.teamcti.com/pview/prcview.htm\r
149 Lets say we put this in a folder called utils in the PSWBTM folder.\r
150 \r
151 Now make a batfile (pv.bat) of misbehaving engines that you will kill and lets\r
152 put this in the utils folder too\r
153 \r
154 pv.bat\r
155 =======\r
156 pv \96kf misbehavingengine1.exe\r
157 pv \96kf misbehavingengine2.exe\r
158 pv \96kf misbehavingengine3.exe\r
159 ...\r
160 \r
161 aftergame.txt\r
162 =============\r
163 utils\pv.bat\r
164 \r
165 This should now kill all misbehaving winboard engines.  You can also use\r
166 aftergame.txt to do a number of other things like uploading result tables to a\r
167 server.  The possibilities are endless.  Aftergame is not called after the last\r
168 game of the tourney.  Instead, aftertourney.txt is called.