home *** CD-ROM | disk | FTP | other *** search
/ vsiftp.vmssoftware.com / VSIPUBLIC@vsiftp.vmssoftware.com.tar / FREEWARE / FREEWARE40.ZIP / xsokoban-31 / xsokoban.hlp < prev    next >
Text File  |  1997-06-17  |  7KB  |  278 lines
  1. 1 XSOKOBAN
  2. Pushing objects around...
  3.  
  4. SYNOPSIS
  5.  
  6.  $ xsokoban [-s -r -c -m -nn -display <disp> {-w |-walls} {-rv | -reverse}
  7.             {-f | -font} <fn> {-b | -bitdir} <path> {-fg | -foregound} <color>
  8.             {-bg | -backgound} <color> {-bd | -border} <color> 
  9.             {-pr | -pointer} <color> -xrm <arg> ] 
  10.  
  11. 2 DESCRIPTION
  12. The goal of  xsokoban
  13. is to push all the round objects into the score area of each level
  14. using the mouse or the arrow keys. The arrow keys move the player in
  15. the corresponding direction, pushing an object if it is in the way and
  16. there is a clear space on the other side. The mouse buttons each have a
  17. distinct function.
  18.  
  19. If the left mouse button is pressed on a clear square, the player will
  20. move to that location via the optimal path if such a path exists;
  21. otherwise, the game will beep.
  22.  
  23. If the middle button is pressed on an object that is adjacent to the
  24. player, the object will be pushed one step.  If the middle mouse button
  25. is pressed on an empty space, the player will move the closest object
  26. that is on a straight line with the destination, such that the object
  27. can be pushed in that direction, and the player is not directly between
  28. the destination and the object.  Before pushing the object, the player
  29. is moved optimally to start the push.
  30.  
  31. Either the left or middle mouse buttons may be used to "drag" an object
  32. from an initial to a final position. If a straightforward way exists
  33. for the man to push the object without moving any other objects, the
  34. man will execute appropriate moves and pushes to get the object to
  35. the desired destination.
  36.  
  37. The right button mouse undoes the last user action, and may be used any
  38. number of times.
  39.  
  40.  
  41. The rest of the functions are bound to the keyboard:
  42.  
  43.    ?
  44. Display a help screen.
  45.     8
  46.    q
  47. Quit the game.
  48.      
  49.    s
  50. Save and quit.
  51.      
  52.    u
  53. Undo the last action. Same as right mouse button.
  54.      
  55.    U
  56. Restart a level.
  57.       
  58.    ^R
  59. Redraw the screen.
  60.       
  61.    h,j,k,l
  62. Move the man just like the arrow keys, as in vi (1).
  63.  
  64.    S
  65. View the score file.
  66.  
  67. Scores in xsokoban
  68. are saved in the score file if they are of high
  69. enough rank. A score is ranked according to how many scores are better
  70. than it; there are no scores superior to a rank 1 score, only one score
  71. superior to a rank 2 score, and so on. If two scores are identical, the
  72. first one entered is ranked higher.
  73.  
  74. 2 OPTIONS
  75.        
  76.     -s [level]
  77. Print the scores on standard output. The optional level will restrict
  78. the printout to scores on just that level.
  79.       
  80.     -c 
  81. Create a new score file (can be ran only by the owner of the game).
  82.        
  83.     -m
  84. Merge score files.
  85.        
  86.     -r
  87. Restore a saved game.
  88.       
  89.     -nn
  90. Start at level nn, 
  91. provided that levels below it are completed. 
  92.  
  93.     -display <display>
  94. Run the game on the named display.
  95.  
  96.    {-w | -walls}
  97. Use fancy walls. (This is the default unless an option bitmap set is used)
  98.  
  99.    {-rv | -reverse}
  100. Use reverse video.
  101.  
  102.    {-f | -font} <fontname>
  103. Use the named font instead of the default 9x15 font.
  104.  
  105.    {-b | -bitdir} <path>
  106. Use the bitmaps found in <path> instead of the defaults.
  107.  
  108.    {-fg | -foreground} <color>
  109. Use the named color as the foreground color. (default is BlackPixel())
  110.  
  111.    {-bg | -background} <color>
  112. Use the named color as the background color. (default is WhitePixel())
  113.  
  114.    {-bd | -border} <color>
  115. Use the named color as the border color. (default is foreground color)
  116.  
  117.    {-pr | -pointer} <color>
  118. Use the named color as the mouse pointer foreground. (default is foreground)
  119.  
  120.    -xrm <arg>
  121. <arg> is an X Resource specification.
  122.  
  123. 2 AUTHORS
  124. Unknown Hacker - Original curses(1) implementation.
  125.  
  126. Joseph L. Traub - X windows interface.
  127.  
  128. Kevin Solie - simultaneously developed X implementation (merged in).
  129.  
  130. Mark Linderman, Christos Zoulas - Mouse code (added to Solie's version).
  131.  
  132. Andrew Myers - Improved mouse UI, score ranking, and color support
  133.  
  134. Code has also been donated by many  xsokoban
  135. users. Thanks for all your contributions and suggestions!
  136.  
  137. 2 RESOURCES
  138. xsokoban understands the following resources.
  139.  
  140.    fancyWalls : boolean
  141. Use fancy walls.
  142.  
  143.    fontName : font
  144. Use named font.
  145.      
  146.    reverseVideo : boolean
  147. Reverse foreground and background pixels.
  148.      
  149.    foreground : color
  150. Use color as foreground color.
  151.      
  152.    background : color
  153. Use color as background color.
  154.      
  155.    borderColor : color
  156. Use color as border color.
  157.      
  158.    pointerColor : color
  159. Use color as pointer color.
  160.      
  161.    bitmapDir : string
  162. Look for bitmaps in path specified by string.
  163.      
  164.    border.color: color
  165. Color of borders in the score display
  166.      
  167.    text.font: font
  168. Font of text in the score display
  169.      
  170.    text.color: color
  171. Color of text in the score display
  172.      
  173.    text.highlight: color
  174. Color of highlighted text in the score display
  175.      
  176.    text.indent: int
  177. Indenting of text in the score display
  178.      
  179.    scrollbar.width: int
  180. Width of the scrollbar in the score display
  181.      
  182.    scrollbar.background: color
  183. Color of the scrollbar background
  184.      
  185.    scrollbar.thumb.height: int, scrollbar.thumb.width: int
  186. Size of the scrollbar thumb
  187.      
  188.    scrollbar.thumb.color: color
  189. Color of the scrollbar thumb
  190.      
  191.    panel.height: int
  192. Height of the help panel in the score display
  193.      
  194.    panel.font: font
  195. Font of the help panel in the score display
  196.      
  197.    bevel.width
  198. Width of the Motif-like bevels
  199.      
  200.    sep.color: color
  201. Color of the lines separating different score levels
  202.  
  203. 2 SPECIAL_BITMAPS
  204. In order to define your own bitmaps for xsokoban
  205. you only need to know the names of which files it is looking for.
  206. The standard bitmap files are:
  207.  
  208.    man.xbm
  209. -- The player bitmap.
  210.  
  211.    goal.xbm
  212. -- The goal area bitmap.
  213.  
  214.    wall.xbm
  215. -- The standard wall bitmap.
  216.  
  217.    object.xbm
  218. -- The object that gets pushed.
  219.  
  220.    treasure.xbm
  221. -- The bitmap for the object when it is on the goal.
  222.  
  223.    saveman.xbm
  224. -- The bitmap for the player when it is on the goal.
  225.  
  226. To use the fancy walls option, you need the following additional files.
  227.  
  228.    lonewall.xbm
  229. -- a wall with connections on no sides.
  230.  
  231.    southwall.xbm
  232. -- a wall with only northern connections
  233.  
  234.    northwall.xbm
  235. -- a wall with only southern connections
  236.  
  237.    eastwall.xbm
  238. -- a wall with only western connections
  239.  
  240.    westwall.xbm
  241. -- a wall with only eastern connections
  242.  
  243.    llcornerwall.xbm
  244. -- a wall with northern and eastern connections
  245.  
  246.    ulcornerwall.xbm
  247. -- a wall with southern and eastern connections
  248.  
  249.    lrcornerwall.xbm
  250. -- a wall with northern and western connections
  251.  
  252.    urcornerwall.xbm
  253. -- a wall with southern and western connections
  254.  
  255.    north_twall.xbm
  256. -- a wall with connections on all BUT northern side
  257.  
  258.    south_twall.xbm
  259. -- a wall with connections on all BUT southern side
  260.  
  261.    east_twall.xbm
  262. -- a wall with connections on all BUT eastern side
  263.  
  264.    west_twall.xbm
  265. -- a wall with connections on all BUT western side
  266.  
  267.    centerwall.xbm
  268. -- A wall will connections on all four sides.
  269.  
  270. 2 BUGS
  271. Auto bitmap resizing code doesn't take into account font sizes.
  272.  
  273. Feedback on user error is poor (only beeps).
  274.  
  275. 2 VMS_PORT
  276.  
  277. Patrick MOREAU , CENA/Athis-Mons,  FRANCE  (pmoreau@cena.dgac.fr)
  278.