1 2 3 4XMRED(6) Games and Demos XMRED(6) 5 6 7 8NNNNAAAAMMMMEEEE 9 xmred - garden editor for xmris 10 11SSSSYYYYNNNNOOOOPPPPSSSSIIIISSSS 12 xxxxmmmmrrrreeeedddd [-option ...] [-toolkitoption ...] 13 14DDDDEEEESSSSCCCCRRRRIIIIPPPPTTTTIIIIOOOONNNN 15 Mr Ed is a tool for creating and editing alternate gardens 16 for Mr Is. Hopefully its user interface is intuitive enough 17 that most of this manual page need not be read by a casual 18 user. 19 20 In the default configuration, the main window presents a 21 garden image on the left, a control panel on the right and a 22 list of gardens underneath. Gardens can be loaded and saved 23 using the menu, these then appear in the list below. The 24 insert option loads a file into the copy buffer. It can then 25 be dragged to the desired place in the garden list. 26 27 To edit a garden (or comment, or include), either select it 28 with a button press and release, or with a drag and drop 29 into the edit box at the lower right. The drag and drop will 30 remove it from the garden list, selection will copy it, and 31 the source garden will be updated too. To delete gardens, 32 drag them to the copy buffer. The main garden display will 33 be updated, if it was a garden being moved to the edit box. 34 The box on the lower right is a copy buffer. You can drag 35 and drop into and out of this to the garden list or one of 36 the edit boxes. Similarly you can drag and drop from the 37 edit boxes to the garden list, and within the garden list 38 itself. Note that drag and drop always removes the source, 39 if it is within the garden list, whereas selection does not 40 delete the source. 41 42 The control panel shows a set of options, which can be bound 43 to buttons. This can be done either by press and release 44 with the required button, or drag and drop onto the required 45 button's icon. You can bind an option to more than one but- 46 ton. However, press and release on the apples option will 47 simply change the currently selected explicit apple, not 48 necessarily bind that option to a new button. The fill pat- 49 tern and color can be select by pressing on them. The 50 current garden will be updated. The list of buttons shows 51 which options are bound to which buttons. You can also 52 change button bindings by pressing the destination button 53 with the pointer over the button with the required option's 54 icon, or by drag and drop from button to button. 55 56 The six options are, 57 58 AAAApppppppplllleeee 59 This selects where apples from one of the four sets of 60 61 62 63X Version 11 Last change: 20 December 1993 1 64 65 66 67 68 69 70XMRED(6) Games and Demos XMRED(6) 71 72 73 74 explicit apple locations are placed. To select which 75 set is being controlled, press on the relevant quadrant 76 of the icon. One of these sets is used when Mr Is is 77 used with the +random option. You can place apples any- 78 where there isn't a path, even in an unstable location, 79 which will immediately fall. Placing an explicit apple 80 on a path, will fill the path. 81 82 RRRRaaaannnnddddoooommmm 83 This controls where apples may be placed randomly, if 84 Mr Is is started with the -random option. Apples will 85 only be placed on the specified locations, or where 86 ever an explicit apple could be located. Unless you 87 specify otherwise, random apples may be located any- 88 where there isn't a path, even unstable locations which 89 will immediately fall. Placing a random apple on a 90 path, will fill the path. 91 92 CCCChhhheeeerrrrrrrryyyy 93 This controls where cherries are located. There must be 94 at least one cherry on a garden. Cherries may be 95 located anywhere on the board. 96 97 PPPPaaaatttthhhh This controls where the initial path is. Each location 98 on the board consists of a centre and four edges. 99 Depending on the exact location of the pointer, you 100 will select either the centre, or an edge. Filling a 101 path will place a random apple in the filled location. 102 The four locations immediately below the 103 104 PPPPllllaaaayyyyeeeerrrr 105 This controls where the player starts from. There must 106 be exactly one such location. 107 108 DDDDeeeennnn This controls where the monsters start from. There must 109 be at least one den. 110 111 The list of totals show the counts for the explicit apples, 112 cherries, random apples required, apple spaces, unstable 113 apple positions, dens and player positions. A warning is 114 shown on the left of any which are inconsistant, or out of 115 range. The number of apples for a garden can be set by mov- 116 ing the scroll bar at the left of the apple icon. Note that 117 when you change the number of apples, or add or remove 118 explicit apples, a warning will change on on some or all of 119 the explicit apple counts. This is just to remind you that 120 you must do some more work on the garden, before it is con- 121 sistant. There are two types of random apple spaces, stable 122 and unstable. The unstable space count is shown with an 123 arrow in it, the other apple space count shows the total 124 number of apple spaces. The hazzard warning on the unstable 125 count, just shows that you have some unstable apple 126 127 128 129X Version 11 Last change: 20 December 1993 2 130 131 132 133 134 135 136XMRED(6) Games and Demos XMRED(6) 137 138 139 140 positions (this may be intentional on your part). The haz- 141 zard on the total apple space count indicates that there are 142 less spaces than the number of apples you specified for the 143 garden. 144 145 Below this is a comment box for the garden. Selecting this 146 will pop up a dialog which you can enter information about 147 the garden. 148 149 At the lower right of the control panel is a display mode 150 selector. There are three display modes. The first shows all 151 the explicit apple positions, 4 to a cell when required. The 152 second shows only one set of explicit apples, the set 153 selected using the apples option quadrant. The final mode 154 shows none of the explicit apples, just the random apple 155 spaces. 156 157 The garden display is on the left of this. It shows the 158 currently edited garden. Clicking or dragging a mouse button 159 on this area will perform the option currently bound to that 160 button. You will notice the totals change when you do this. 161 162 Mr Ed will use colour sprites, if the visual permits it (has 163 a colour map size of more than 15, and you haven't forced 164 monochrome). All the colours bar black and white are user 165 definable. There are four sets, one for each of the four 166 combinations of gender and swap flag. The colours are allo- 167 cated in reverse order of their distance in colour space, 168 from currently allocated colours (the most distant colours 169 are allocated first). That way, if allocation fails because 170 the colour map is full, an allocated substitute colour, 171 which is nearest the desired colour, can be used and the 172 allocated colours are kept maximally distant. You can limit 173 the number of distinct colours with the -distinct option. A 174 warning message is sent to stderr, if a colour allocation 175 fails. The -colours argument shows how these are allocated, 176 and -help -colours can be used to get the colour resource 177 names. 178 179OOOOPPPPTTTTIIIIOOOONNNNSSSS 180 Mr Ed accepts the standard X Toolkit options, as well as 181 these. 182 183 ----hhhheeeellllpppp 184 Lists the command options, application resource fields 185 and some other information to stderr. Does not start 186 the game. If the -colours option is supplied too, then 187 the colour resource classes are listed instead, with 188 their default values. The format of this list is suit- 189 able for inclusion in a resource file. Note, this does 190 not list out the colour values that you would get if 191 you ran the game, as it does not read the color 192 193 194 195X Version 11 Last change: 20 December 1993 3 196 197 198 199 200 201 202XMRED(6) Games and Demos XMRED(6) 203 204 205 206 resources. 207 208 ----sssswwwwaaaapppp 209 ----rrrrvvvv 210 ----rrrreeeevvvveeeerrrrsssseeee 211 Normally the foreground is black and the background 212 white, this swaps them round. On colour systems, this 213 may also alter other colours. 214 215 ++++sssswwwwaaaapppp 216 ----nnnnoooosssswwwwaaaapppp 217 Override a swap resource in your resources, to force 218 unswapped colours. 219 220 ----mmmmoooonnnnoooo 221 Use black and white, even on colour displays. (Unfor- 222 tunately, the obvious option, '-bw', is already nabbed 223 by the toolkit as borderwidth.) 224 225 ----mmmmrrrriiiissss 226 ----mmmmssssiiiitttt 227 ----ggggeeeennnnddddeeeerrrr _g_e_n_d_e_r 228 Mr Ed has two sets of sprites. Mris selects the classic 229 sprites, while msit selects a more modern set. Valid 230 genders are 'he', 'she', 'female', 'male', 'msit', 231 'mris', 'boy', 'girl'. 232 233 ----ddddeeeepppptttthhhh _d_e_p_t_h 234 Mr Ed will use the default depth of the screen. You may 235 wish to override that by using this option. Selecting a 236 different depth may affect the visual selected. 237 238 ----vvvviiiissssuuuuaaaallll _v_i_s_u_a_l-_c_l_a_s_s 239 Mr Ed will pick the default visual, but you can over- 240 ride that by specifying a particular visual class. 241 Valid visuals are 'PseudoColor', 'DirectColor', 242 'TrueColor', 'StaticColor', 'GrayScale', and 'Sta- 243 ticGray'. To see which one is picked, you can use the 244 -colours option. If you do select a non-default visual, 245 you may have to specify a private colour map too, due 246 to limitations of the server or display. 247 248 ----pppprrrriiiivvvvaaaatttteeee 249 This forces Mr Ed to allocate a private colour map. 250 Normally Mr Ed will share the default colour map of the 251 selected visual, but if that does not have enough free 252 colour cells then some colours will have to be shared. 253 254 ----ccccoooolllloooouuuurrrrssss 255 ----ccccoooolllloooorrrrssss 256 Show how the colours are allocated, and which visual 257 has been selected. The allocation is listed to stdout. 258 259 260 261X Version 11 Last change: 20 December 1993 4 262 263 264 265 266 267 268XMRED(6) Games and Demos XMRED(6) 269 270 271 272 When allocating each colour, its resource name and rgb 273 values are listed together with the nearest already 274 allocated colour and the distance between them in 275 colour space. The allocated pixel number is printed 276 last. If given with the -help option, the colour 277 resource classes are listed, and the game does not 278 start. 279 280 ----ddddiiiissssttttiiiinnnncccctttt _n 281 Sets the number of distinct colours used. This can be 282 used to limit the number of colours used from the 283 colour map. Black and white are not included, and nei- 284 ther are the two writable colours used for the garden 285 backgrounds on dynamic visuals. Note that -distinct 0 286 is different from -mono, even though both will only use 287 black and white. 288 289RRRREEEESSSSOOOOUUUURRRRCCCCEEEESSSS 290 Mr Ed uses the X toolkit application resource mechanism for 291 setting up the environment. Application resource items start 292 with 'Xmris', so that Mr Ed will pick up your defaults for 293 Mr Is. The resource name can be derived from the given 294 resource class by decapitalizing it. For example 'cherryS- 295 talk' is the resource name for the class 'cherryStalk'. The 296 following classes are used (choices in '{}' and defaults in 297 '[]'.) 298 299 XXXXmmmmrrrriiiissss....RRRReeeevvvveeeerrrrsssseeeeVVVViiiiddddeeeeoooo:::: {_y_e_s, _n_o} [[[[nnnnoooo]]]] 300 Specifies whether to use swapped colours or not. 301 302 XXXXmmmmrrrriiiissss....MMMMoooonnnnoooo:::: {_y_e_s, _n_o} [[[[nnnnoooo]]]] 303 Whether the default is for monochrome on colour 304 displays. 305 306 XXXXmmmmrrrriiiissss....GGGGeeeennnnddddeeeerrrr:::: _g_e_n_d_e_r [[[[hhhheeee]]]] 307 Sets the default game gender. Valid genders are 'mris', 308 'msit', 'she', 'he', 'female', 'male', 'boy', 'girl'. 309 310 XXXXmmmmrrrriiiissss....DDDDeeeepppptttthhhh:::: _d_e_p_t_h 311 Set the required screen depth to use. 312 313 XXXXmmmmrrrriiiissss....VVVViiiissssuuuuaaaallll:::: _v_i_s_u_a_l-_c_l_a_s_s 314 Set the required visual class to use. Valid visuals are 315 'PseudoColor', 'DirectColor', 'TrueColor', 'Sta- 316 ticColor', 'GrayScale', and 'StaticGray'. 317 318 XXXXmmmmrrrriiiissss....PPPPrrrriiiivvvvaaaatttteeee:::: {_y_e_s, _n_o} [[[[nnnnoooo]]]] 319 Set whether or not to use a private colour map. 320 321 XXXXmmmmrrrriiiissss....DDDDiiiissssttttiiiinnnncccctttt:::: _n 322 Set the number of distinct colours allocated from the 323 colour map. 324 325 326 327X Version 11 Last change: 20 December 1993 5 328 329 330 331 332 333 334XMRED(6) Games and Demos XMRED(6) 335 336 337 338 In addition, you have the normal resources such as '*Font'. 339 340CCCCOOOOLLLLOOOOUUUURRRR RRRREEEESSSSOOOOUUUURRRRCCCCEEEESSSS 341 There are many colour name defaults. For a full description 342 see the xmris(6) manual page, but note that not all the 343 colors are used for Mr Ed. Provided that you specified the 344 colour resources for Mr Is loosely enough, Mr Ed will pick 345 up the same overrides. The foreground color for the Icon 346 widgets is copied from the apple faint color on color visu- 347 als (this is important for the noswap color scheme). 348 349WWWWIIIIDDDDGGGGEEEETTTT RRRREEEESSSSOOOOUUUURRRRCCCCEEEESSSS 350 There are a few resources which are picked up from widgets 351 within the widget tree. They are the initial button bind- 352 ings, colors, fills and mode. The bindings are attached to 353 the individual button displays. The options are 'apple', 354 'random', 'cherry', 'path', 'player' and 'den'. The colors, 355 fills and mode are attached to the color, fill and mode form 356 widgets. The value must be an integer in the correct range. 357 358 There is an additional composite resource for children of 359 composite widgets (Paned and SimpleMenu), called 'attach'. 360 This allows you to change the ordering of sibling widgets. 361 Mr Ed uses this resource to determine the correct order to 362 create the sibling widgets. For instance, to get the control 363 panel on the left of the garden widget, use the constraint 364 '*one.garden.attach:panel'. In addition, the widgets are 365 created in such an order that Form constraints 'fromHoriz' 366 and 'fromVert' can be specified in any order. 367 368 There are four new widgets used for Mr Ed, 'Icon', 'Drag', 369 'Garden' and 'PixmapList'. 370 371 The Icon widget is a subclass of Simple. It displays a pix- 372 map and allows its selection with any button press. If a 373 button is dragged on it, it may invoke a drag widget to per- 374 form a drag operation. It has the following new resources 375 of interest. 376 377 ddddrrrraaaaggggSSSSeeeennnnssssiiiittttiiiivvvviiiittttyyyy:::: _p_i_x_e_l_s [[[[4444]]]] 378 Sets the minimum drag which must occur, before a drag 379 widget is popped up, to take over the dragging. When 380 set to zero, dragging is disabled. 381 382 ffffllllaaaasssshhhhDDDDeeeellllaaaayyyy:::: _d_e_l_a_y [[[[111100000000]]]] 383 Sets the time for which the widget is highlit after 384 selection. This time is in milliseconds. 385 386 hhhhiiiigggghhhhlllliiiigggghhhhttttTTTThhhhiiiicccckkkknnnneeeessssssss:::: _p_i_x_e_l_s [[[[1111]]]] 387 Sets the thickness of the highlight box. 388 389 390 391 392 393X Version 11 Last change: 20 December 1993 6 394 395 396 397 398 399 400XMRED(6) Games and Demos XMRED(6) 401 402 403 404 ffffoooorrrreeeeggggrrrroooouuuunnnndddd:::: _c_o_l_o_r [[[[ddddeeeeffffaaaauuuulllltttt ffffoooorrrreeeeggggrrrroooouuuunnnndddd]]]] 405 Sets the color of the highlight box and block. 406 407 The Drag widget is a subclass of OverrideShell. It displays 408 a pixmap, and follows the pointer until a button is 409 released. Its use is for drag and drop. It has no additional 410 resources of user interest. 411 412 The Garden widget is a subclass of Simple. It performs the 413 garden editing. It has no additional resources of user 414 interest. 415 416 The PixmapList widget is a subclass of Simple. It displays a 417 list of pixmaps, and permits them to be scrolled. Each pix- 418 map may be selected by a button press on it, or a drag 419 widget invoked by dragging on a pixmap. In addition to the 420 Icon widget additional resources, it has the following addi- 421 tional resources of user interest. 422 423 ddddiiiissssttttaaaannnncccceeee:::: _p_i_x_e_l_s [[[[4444]]]] 424 The distance between each pixmap. 425 426 ppppiiiixxxxmmmmaaaappppBBBBoooorrrrddddeeeerrrrWWWWiiiiddddtttthhhh:::: _p_i_x_e_l_s [[[[1111]]]] 427 The border width for each pixmap. 428 429 ppppiiiixxxxmmmmaaaappppBBBBoooorrrrddddeeeerrrrCCCCoooolllloooorrrr:::: _c_o_l_o_r [[[[ddddeeeeffffaaaauuuulllltttt ffffoooorrrreeeeggggrrrroooouuuunnnndddd]]]] 430 The border color for each pixmap. 431 432EEEENNNNVVVVIIIIRRRROOOONNNNMMMMEEEENNNNTTTT 433 A few environment variables are used to locate resources. 434 435 DDDDIIIISSSSPPPPLLLLAAAAYYYY 436 The default display to connect to. May be overridden 437 with the -display option. 438 439FFFFIIIILLLLEEEESSSS 440 ~~~~////....XXXXddddeeeeffffaaaauuuullllttttssss 441 ............////aaaapppppppp----ddddeeeeffffaaaauuuullllttttssss////XXXXmmmmrrrriiiissss....aaaadddd 442 ............////aaaapppppppp----ddddeeeeffffaaaauuuullllttttssss////XXXXmmmmrrrriiiissss----ccccoooolllloooorrrr....aaaadddd 443 You can place you favourite key bindings and stuff in 444 an application resource file, and Mr Ed will use them, 445 rather than its compiled defaults. See X for informa- 446 tion about how these are searched. 447 448 ............////aaaapppppppp----ddddeeeeffffaaaauuuullllttttssss////xxxxmmmmrrrriiiissss////<<<<ggggaaaarrrrddddeeeennnnssss>>>> 449 Search path for loadable gardens used by Mr Is. 450 451SSSSEEEEEEEE AAAALLLLSSSSOOOO 452 xxxxmmmmrrrriiiissss(6) 453 454EEEERRRRRRRROOOORRRRSSSS 455 456 457 458 459X Version 11 Last change: 20 December 1993 7 460 461 462 463 464 465 466XMRED(6) Games and Demos XMRED(6) 467 468 469 470 If a loaded garden is incorrect, an error dialog is 471 displayed, enabling you to locate the offending garden and 472 lines. 473 474BBBBUUUUGGGGSSSS 475 The visual class name conversion is performed by a standard 476 toolkit routine. It accepts only American spelling, the 477 English spelling of 'grey' and 'colour' are not allowed. 478 479 The Drag widget should perhaps just be a shell, having a 480 single child of Icon, to do the rendering. 481 482 The PixmapList widget should perhaps be a composite widget 483 with Icon children. However when I tried this using a Box 484 widget, it didn't work with the insert function. 485 486CCCCOOOOPPPPYYYYRRRRIIIIGGGGHHHHTTTT 487 Copyright (C) 1993 Nathan Sidwell. 488 489AAAAUUUUTTTTHHHHOOOORRRR 490 Nathan Sidwell <nathan@pact.srf.ac.uk> 491 <http://www.pact.srf.ac.uk/~nathan/> 492 493 Additional sprites by Stefan Gustavson <stefang@isy.liu.se> 494 495 496 497 498 499 500 501 502 503 504 505 506 507 508 509 510 511 512 513 514 515 516 517 518 519 520 521 522 523 524 525X Version 11 Last change: 20 December 1993 8 526 527 528 529