diff options
| author | Franklin Wei <frankhwei536@gmail.com> | 2016-11-20 15:16:41 -0500 |
|---|---|---|
| committer | Franklin Wei <frankhwei536@gmail.com> | 2016-11-24 16:23:09 -0500 |
| commit | 56c9984511f016eab7e1278ba9e40d88bb59a162 (patch) | |
| tree | 1bfa6d3aeb3bf2a6ffec71387ac073cd0b8b2a51 /apps/plugins/puzzles/CHECKLST.txt | |
| parent | 29648f817677b84c03c2bcfe89eb8cf53653e7db (diff) | |
| download | rockbox-puzzles.zip rockbox-puzzles.tar.gz rockbox-puzzles.tar.bz2 rockbox-puzzles.tar.xz | |
[WIP] Port of Simon Tatham's Puzzle Collectionpuzzles
Original revision: 5123b1bf68777ffa86e651f178046b26a87cf2d9
MIT Licensed. Some games still crash and others are unplayable due to
issues with controls. Still need a "real" polygon filling algorithm.
The following games are at least partially broken for various reasons:
Cube: crash with certain settings
Galaxies: crash
Inertia: crash
Keen: input issues
Loopy: weird stuff happens
Map: crash on input
Mines: weird stuff happens on target
Palisade: input issues
Signpost: crash on input
Solo: input issues
Towers: input and drawing issues
Train Tracks: drawing issues
Twiddle: weird animation on target
Undead: input and drawing issues
Unequal: input and drawing issues
Untangle: input issues
All in all, about 40% of the games are at least partially broken.
Change-Id: I7c69b6860ab115f973c8d76799502e9bb3d52368
Diffstat (limited to 'apps/plugins/puzzles/CHECKLST.txt')
| -rw-r--r-- | apps/plugins/puzzles/CHECKLST.txt | 70 |
1 files changed, 70 insertions, 0 deletions
diff --git a/apps/plugins/puzzles/CHECKLST.txt b/apps/plugins/puzzles/CHECKLST.txt new file mode 100644 index 0000000..2bef909 --- /dev/null +++ b/apps/plugins/puzzles/CHECKLST.txt @@ -0,0 +1,70 @@ +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 <puzzle>_EXTRA symbol for it if it requires auxiliary + object files (make sure that symbol doesn't contain the icon) + - adds it to the `ALL' definition, to ensure it is compiled into + the OS X binary + - adds it as a GTK build target, with the optional GTK icon + - adds it as a Windows build target, with the optional resource + file + - adds auxiliary solver binaries if any + - adds it to $(GAMES) in both the automake and GTK makefiles, for + `make install' + - adds it to list.c for the OS X binary + - adds it to gamedesc.txt, with its Windows executable name, display + name, and slightly longer description. + +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. + +Check that REQUIRE_RBUTTON and/or REQUIRE_NUMPAD are set as +appropriate. + +Add the new Unix binary name, and the names of any auxiliary solver +binaries, to .gitignore. + +Write an instructions fragment for the webified puzzle pages, as +html/<puzzlename>.html . + +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 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 `git add' the new source file, the new .R file and the +save file in `icons', the new .html file, and any other new files that +might have been involved. + +Check in! + +Put the puzzle on the web: + - run puzzlesnap.sh + - adjust the copyright in index-mid.html if the puzzle is by a new + author + - check that the new puzzle has appeared on the staging web page + - test both Windows binary links, the docs link, the Javascript + version and the Java version + - run webupdate + - test all those things once more on the live website |