Updates to the new-puzzle checklist, since the world has moved on.

[originally from svn r8865]
This commit is contained in:
Simon Tatham
2010-02-15 21:31:58 +00:00
parent 7e4f870f6d
commit 1fa6d1b7f1

View File

@ -7,9 +7,8 @@ Things to remember when adding a new puzzle
Write the source file for the new puzzle (duhh). Write the source file for the new puzzle (duhh).
Create a .R file for it which: Create a .R file for it which:
- defines a Recipe symbol for it if it requires auxiliary object - defines a <puzzle>_EXTRA symbol for it if it requires auxiliary
files (make sure the general Recipe symbol doesn't contain the object files (make sure that symbol doesn't contain the icon)
icon)
- adds it to the `ALL' definition, to ensure it is compiled into - adds it to the `ALL' definition, to ensure it is compiled into
the OS X binary the OS X binary
- adds it as a GTK build target, with the optional GTK icon - adds it as a GTK build target, with the optional GTK icon
@ -36,9 +35,8 @@ Make sure there's a Windows help topic name defined in puzzles.but,
and that it's referenced by the help topic field in the game and that it's referenced by the help topic field in the game
structure in the source file. structure in the source file.
Make sure the puzzle works on PocketPC. At the very least, check Check that REQUIRE_RBUTTON and/or REQUIRE_NUMPAD are set as
that it specifies REQUIRE_RBUTTON and/or REQUIRE_NUMPAD as appropriate.
appropriate; but better, actually test it on the emulator.
Add the new Unix binary name, and the names of any auxiliary solver Add the new Unix binary name, and the names of any auxiliary solver
binaries, to the svn:ignore property. binaries, to the svn:ignore property.
@ -46,7 +44,10 @@ binaries, to the svn:ignore property.
Make a screenshot: Make a screenshot:
- create an appropriate save file in `icons' - create an appropriate save file in `icons'
- add the puzzle name to icons/Makefile - add the puzzle name to icons/Makefile
- set up a REDO property in icons/Makefile if desired - set up a REDO property in icons/Makefile if the screenshot wants
to display a move halfway through an animation
- set up a CROP property in icons/Makefile if the icon wants to be
a sub-rectangle of the whole screenshot
Don't forget to `svn add' the new source file, the new .R file and Don't forget to `svn add' the new source file, the new .R file and
the save file in `icons', and any other new files that might have the save file in `icons', and any other new files that might have
@ -59,6 +60,8 @@ Put the puzzle on the web:
- make sure the screenshot and Windows binary have arrived in the - make sure the screenshot and Windows binary have arrived in the
www directory, and the .jar file in the java subdirectory www directory, and the .jar file in the java subdirectory
- add an entry in the puzzles list in index.html - add an entry in the puzzles list in index.html
- add the Windows executable name to the list further down
index.html
- add a web page in the java subdirectory - add a web page in the java subdirectory
- adjust the copyright in index.html if the puzzle is by a new - adjust the copyright in index.html if the puzzle is by a new
author author