| 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 <puzzle>_EXTRA symbol for it if it requires auxiliary |
| 11 | object files (make sure that symbol doesn't contain the icon) |
| 12 | - adds it to the `ALL' definition, to ensure it is compiled into |
| 13 | the OS X binary |
| 14 | - adds it as a GTK build target, with the optional GTK icon |
| 15 | - adds it as a Windows build target, with the optional resource |
| 16 | file |
| 17 | - adds auxiliary solver binaries if any |
| 18 | - adds it to $(GAMES) in the GTK makefile, for `make install' |
| 19 | - adds it to list.c for the OS X binary |
| 20 | - adds it to wingames.lst along with a textual name, for the build |
| 21 | system and Windows installer. |
| 22 | |
| 23 | If the puzzle is by a new author, modify the copyright notice in |
| 24 | LICENCE and in puzzles.but. (Also in index.html, but that's listed |
| 25 | below under website changes.) |
| 26 | |
| 27 | Double-check that the game structure name in the source file has |
| 28 | been renamed from `nullgame', so that it'll work on OS X. Actually |
| 29 | compiling it on OS X would be a good way to check this, if |
| 30 | convenient. |
| 31 | |
| 32 | Add a documentation section in puzzles.but. |
| 33 | |
| 34 | Make sure there's a Windows help topic name defined in puzzles.but, |
| 35 | and that it's referenced by the help topic field in the game |
| 36 | structure in the source file. |
| 37 | |
| 38 | Check that REQUIRE_RBUTTON and/or REQUIRE_NUMPAD are set as |
| 39 | appropriate. |
| 40 | |
| 41 | Add the new Unix binary name, and the names of any auxiliary solver |
| 42 | binaries, to the svn:ignore property. |
| 43 | |
| 44 | Make a screenshot: |
| 45 | - create an appropriate save file in `icons' |
| 46 | - add the puzzle name to icons/Makefile |
| 47 | - set up a REDO property in icons/Makefile if the screenshot wants |
| 48 | to display a move halfway through an animation |
| 49 | - set up a CROP property in icons/Makefile if the icon wants to be |
| 50 | a sub-rectangle of the whole screenshot |
| 51 | |
| 52 | Don't forget to `svn add' the new source file, the new .R file and |
| 53 | the save file in `icons', and any other new files that might have |
| 54 | been involved. |
| 55 | |
| 56 | Check in! |
| 57 | |
| 58 | Put the puzzle on the web: |
| 59 | - run puzzlesnap first |
| 60 | - make sure the screenshot and Windows binary have arrived in the |
| 61 | www directory, and the .jar file in the java subdirectory |
| 62 | - add an entry in the puzzles list in index.html |
| 63 | - add the Windows executable name to the list further down |
| 64 | index.html |
| 65 | - add a web page in the java subdirectory |
| 66 | - adjust the copyright in index.html if the puzzle is by a new |
| 67 | author |
| 68 | - test that the binary link and the docs link work |
| 69 | - test that the Java version works |
| 70 | - run webupdate |
| 71 | - test again |
| 72 | - `svn add' the new Java applet web page |
| 73 | - check in the change to index.html and the new web page |