Files
puzzles/CHECKLST.txt
Simon Tatham d55ad9fc42 New mechanism for automatic generation of the puzzle screenshots on
the web, which I hope will also end up being extended to generate
both Windows and X icons for each individual puzzle. The mechanism
is: for each puzzle there's a save file in the `icons' subdirectory
showing a game state which I think is a decent illustration of the
puzzle, and then there's a nasty set of scripts which runs each
puzzle binary, loads that save file, grabs a screenshot using xwd,
and munges it into shape.

In order to support this I've added two new options (--redo and
--windowid) to all the GTK puzzles, which I don't expect ever to be
used outside the icons makefile. I've also added two more options
(--load and --id) which force a GTK puzzle to treat its command-line
option as a save file or as a game ID respectively (the previous
behaviour was always to guess, and sometimes it guessed wrong).

[originally from svn r7014]
2006-12-26 16:47:28 +00:00

59 lines
2.0 KiB
Plaintext

Useful checklists
=================
Things to remember when adding a new puzzle
-------------------------------------------
Write the source file for the new puzzle (duhh).
Create a .R file for it which:
- defines a Recipe symbol for it if it requires auxiliary object
files
- adds it to the `ALL' definition, to ensure it is compiled into
the OS X binary
- adds it as a GTK build target
- adds it as a Windows build target
- adds auxiliary solver binaries if any
- adds it to $(GAMES) in the GTK makefile, for `make install'
- adds it to list.c for the OS X binary.
If the puzzle is by a new author, modify the copyright notice in
LICENCE and in puzzles.but. (Also in index.html, but that's listed
below under website changes.)
Double-check that the game structure name in the source file has
been renamed from `nullgame', so that it'll work on OS X. Actually
compiling it on OS X would be a good way to check this, if
convenient.
Add a documentation section in puzzles.but.
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
structure in the source file.
Add the new Unix binary name to the svn:ignore property.
Make a screenshot:
- create an appropriate save file in `icons'
- add the puzzle name to icons/Makefile
- set up a REDO property in icons/Makefile if desired
Don't forget to `svn add' the new source file, the new .R file and
the save file in `icons', before checkin!
Put the puzzle on the web:
- make sure the screenshot is actually in the www directory
- add an entry in the puzzles list in index.html
- adjust the copyright in index.html if the puzzle is by a new
author
- add a link to the Windows binary
- make sure the Windows binary link points at the right binary, not
the wrong one!
- run puzzlesnap
- test that the binary link and the docs link work
- run webupdate
- test again
- `svn add' the binary symlink and the screenshot
- check in the website changes (screenshot, symlink, index.html)