| 1b470bcf |
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 | |
| 3f98cd5a |
9 | Create a .R file for it which: |
| 10 | - defines a Recipe symbol for it if it requires auxiliary object |
| 11 | files |
| 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 |
| 15 | - adds it as a Windows build target |
| 16 | - adds auxiliary solver binaries if any |
| 17 | - adds it to $(GAMES) in the GTK makefile, for `make install' |
| 18 | - adds it to list.c for the OS X binary. |
| 1b470bcf |
19 | |
| 6193da8d |
20 | If the puzzle is by a new author, modify the copyright notice in |
| 21 | LICENCE and in puzzles.but. (Also in index.html, but that's listed |
| 22 | below under website changes.) |
| 23 | |
| 3f98cd5a |
24 | Double-check that the game structure name in the source file has |
| 25 | been renamed from `nullgame', so that it'll work on OS X. Actually |
| 26 | compiling it on OS X would be a good way to check this, if |
| 27 | convenient. |
| 1b470bcf |
28 | |
| 29 | Add a documentation section in puzzles.but. |
| 30 | |
| 31 | Make sure there's a Windows help topic name defined in puzzles.but, |
| 32 | and that it's referenced by the help topic field in the game |
| 33 | structure in the source file. |
| 34 | |
| 35 | Add the new Unix binary name to the svn:ignore property. |
| 36 | |
| afc306fc |
37 | Make a screenshot: |
| 38 | - create an appropriate save file in `icons' |
| 39 | - add the puzzle name to icons/Makefile |
| 40 | - set up a REDO property in icons/Makefile if desired |
| 41 | |
| 42 | Don't forget to `svn add' the new source file, the new .R file and |
| 43 | the save file in `icons', before checkin! |
| 1b470bcf |
44 | |
| 45 | Put the puzzle on the web: |
| afc306fc |
46 | - make sure the screenshot is actually in the www directory |
| 1b470bcf |
47 | - add an entry in the puzzles list in index.html |
| 6193da8d |
48 | - adjust the copyright in index.html if the puzzle is by a new |
| 49 | author |
| 1b470bcf |
50 | - add a link to the Windows binary |
| 51 | - make sure the Windows binary link points at the right binary, not |
| 52 | the wrong one! |
| 53 | - run puzzlesnap |
| 54 | - test that the binary link and the docs link work |
| 55 | - run webupdate |
| 56 | - test again |
| 57 | - `svn add' the binary symlink and the screenshot |
| 58 | - check in the website changes (screenshot, symlink, index.html) |
~mdw / sgt / puzzles / blame