| | 1 | Useful checklists |
| | 2 | ================= |
| | 3 | |
| | 4 | Things to remember when adding a new puzzle |
| | 5 | ------------------------------------------- |
| | 6 | |
| | 7 | Write the source file for the new puzzle (duhh). |
| | 8 | |
| | 9 | Create a .R file for it which: |
| | 10 | - defines a Recipe symbol for it if it requires auxiliary object |
| | 11 | files (make sure the general Recipe symbol doesn't contain the |
| | 12 | icon) |
| | 13 | - adds it to the `ALL' definition, to ensure it is compiled into |
| | 14 | the OS X binary |
| | 15 | - adds it as a GTK build target, with the optional GTK icon |
| | 16 | - adds it as a Windows build target, with the optional resource |
| | 17 | file |
| | 18 | - adds auxiliary solver binaries if any |
| | 19 | - adds it to $(GAMES) in the GTK makefile, for `make install' |
| | 20 | - adds it to list.c for the OS X binary |
| | 21 | - adds it to wingames.lst along with a textual name, for the build |
| | 22 | system and Windows installer. |
| | 23 | |
| | 24 | If the puzzle is by a new author, modify the copyright notice in |
| | 25 | LICENCE and in puzzles.but. (Also in index.html, but that's listed |
| | 26 | below under website changes.) |
| | 27 | |
| | 28 | Double-check that the game structure name in the source file has |
| | 29 | been renamed from `nullgame', so that it'll work on OS X. Actually |
| | 30 | compiling it on OS X would be a good way to check this, if |
| | 31 | convenient. |
| | 32 | |
| | 33 | Add a documentation section in puzzles.but. |
| | 34 | |
| | 35 | Make sure there's a Windows help topic name defined in puzzles.but, |
| | 36 | and that it's referenced by the help topic field in the game |
| | 37 | structure in the source file. |
| | 38 | |
| | 39 | Make sure the puzzle works on PocketPC. At the very least, check |
| | 40 | that it specifies REQUIRE_RBUTTON and/or REQUIRE_NUMPAD as |
| | 41 | appropriate; but better, actually test it on the emulator. |
| | 42 | |
| | 43 | Add the new Unix binary name, and the names of any auxiliary solver |
| | 44 | binaries, to the svn:ignore property. |
| | 45 | |
| | 46 | Make a screenshot: |
| | 47 | - create an appropriate save file in `icons' |
| | 48 | - add the puzzle name to icons/Makefile |
| | 49 | - set up a REDO property in icons/Makefile if desired |
| | 50 | |
| | 51 | Don't forget to `svn add' the new source file, the new .R file and |
| | 52 | the save file in `icons', and any other new files that might have |
| | 53 | been involved. |
| | 54 | |
| | 55 | Check in! |
| | 56 | |
| | 57 | Put the puzzle on the web: |
| | 58 | - run puzzlesnap first |
| | 59 | - make sure the screenshot and Windows binary have arrived in the |
| | 60 | www directory, and the .jar file in the java subdirectory |
| | 61 | - add an entry in the puzzles list in index.html |
| | 62 | - add a web page in the java subdirectory |
| | 63 | - adjust the copyright in index.html if the puzzle is by a new |
| | 64 | author |
| | 65 | - test that the binary link and the docs link work |
| | 66 | - test that the Java version works |
| | 67 | - run webupdate |
| | 68 | - test again |
| | 69 | - `svn add' the new Java applet web page |
| | 70 | - check in the change to index.html and the new web page |
~mdw / sgt / puzzles / blame_incremental