Index: config.doc ================================================================== --- config.doc +++ config.doc @@ -23,11 +23,11 @@ .autoSave If true, saves changes to the level and solution files when the program terminates. If false (default), they are only saved to the user cache database; to copy the changes to the level and solution files, you must - use the .u command in SQL mode (-x). + use the .u command in SQL mode (-x), or use the -f switch. .codepage The path to the code page file. If not specified, then code pages other than 437 are not available (code page 437 is built-in). Index: edit.doc ================================================================== --- edit.doc +++ edit.doc @@ -46,14 +46,31 @@ * Objects: The level contains objects, each of which is at a specific position in either of the two worlds; see below for more about objects. Of the above, the level title, order number, ID number, and version number have no effect on the game rules; class codes cannot access them. + +After making the level, push CTRL+S to save and then CTRL+P to play; if +you solve the level, you can then save the solution. If you want to modify +the level, you can then push CTRL+E to edit it again, but if a solution +was saved, the solution is now considered invalid, so you must play it +again; if the sequence of moves that has been recorded is still a valid +solution, then you can just push F4 to replay the same moves automatically +(the move list will still be available, but not the solution). + +Solutions should be recorded before publishing the puzzle set, and you +should test them with the -a switch (which can also be used for regression +testing, in case you modified the class definitions and will need to +ensure that it doesn't make any of the existing solutions invalid). A +puzzle catalog server may also verify that the solutions are valid, and +might reject the puzzle set if they aren't valid. IMPORTANT NOTE: Saving the levels here will only save them in the user cache database, not to the puzzle set file. To save them to the puzzle -set file, you must invoke heromesh -f to flush the user cache. +set file, you must invoke heromesh -f to flush the user cache. If the +.autoSave resource is true, then it will do this automatically, and then +you do not need to worry about this. === Object placement/MRU === On the left side of the screen is the MRU list. Each MRU consists of a Index: game.doc ================================================================== --- game.doc +++ game.doc @@ -21,10 +21,13 @@ There are two features for helping you: If you click on any object with the middle button, help text is displayed with a description of that object. If you click with the right button, a list of objects at that location is displayed, and you can then view all variables of that object. + +Different puzzle sets may have different game rules; you can read the +class definition file to learn more precisely the rules of the game. You can push the ESC key to restart a level. You can also push the plus and minus on the number pad to skip levels, or CTRL+G allows you to access a specific level directly by its order number. Push CTRL+T to display the level title. @@ -80,17 +83,20 @@ can push ALT+P for slow replay. During the slow replay, you can pause it by pushing ALT+P again, and you can push ALT+[ and ALT+] to adjust speed. If you solve a level yourself, you can push CTRL+S to record the solution. The solution will be recorded in the puzzle set once the user cache is -flushed as described below. +flushed as described below. If the .saveSolution resource is true, then +it will automatically save the solution (although not necessarily to the +puzzle set files). IMPORTANT NOTE: Saving the solutions here will only save them in the user cache database, not to the puzzle set file. To save them to the puzzle set file, you must invoke heromesh -f to flush the user cache. The local replay list and mark will not be saved in the puzzle set though; they are -local to the user account. +local to the user account. If the .autoSave resource is true, then it will +do this automatically. === Summary of default key/mouse bindings === (Below, "KP" means the "key pad" or "number pad".)