diff options
Diffstat (limited to 'apps/plugins/puzzles/README.rockbox')
-rw-r--r-- | apps/plugins/puzzles/README.rockbox | 53 |
1 files changed, 53 insertions, 0 deletions
diff --git a/apps/plugins/puzzles/README.rockbox b/apps/plugins/puzzles/README.rockbox index b64b60f694..117383eacb 100644 --- a/apps/plugins/puzzles/README.rockbox +++ b/apps/plugins/puzzles/README.rockbox | |||
@@ -31,6 +31,56 @@ distribution. The compression is LZ4, implemented in lz4tiny.c (for | |||
31 | decompression on target), and compress.c (for generation). genhelp.sh | 31 | decompression on target), and compress.c (for generation). genhelp.sh |
32 | should be run whenever the documentation is changed. | 32 | should be run whenever the documentation is changed. |
33 | 33 | ||
34 | Upstreams | ||
35 | ========= | ||
36 | |||
37 | As of 2024, Simon's tree is located at: | ||
38 | |||
39 | https://git.tartarus.org/?p=simon/puzzles.git | ||
40 | |||
41 | For a long time (i.e. 2017-2024), our version of the puzzles tree | ||
42 | contained several modifications by myself (notably cursor interfaces | ||
43 | to Untangle and Palisade). These divergent changes complicated | ||
44 | maintenance of this port, as merge conflicts often arose when upstream | ||
45 | changes to these games conflicted with our changes. To remedy this, I | ||
46 | sent most of these patches back upstream in summer 2024, and since | ||
47 | then, Simon has merged the majority of them into his tree. | ||
48 | |||
49 | This leaves us with a very small set of places where our branch of the | ||
50 | puzzles source diverges from Simon's. That branch lives here: | ||
51 | |||
52 | https://github.com/built1n/puzzles/tree/rockbox-devel | ||
53 | |||
54 | Notably, there are several hacks which work around Rockbox's lack of a | ||
55 | proper polygon filling algorithm. Eliminating this deficiency would | ||
56 | enable us to use a totally unmodified upstream source tree. | ||
57 | |||
58 | Maintenance | ||
59 | =========== | ||
60 | |||
61 | Simon's upstream tree sees continued development. The port is | ||
62 | structured so that integrating new upstream versions is | ||
63 | straightforward: all the upstream sources live in the src/ | ||
64 | subdirectory; all of the Rockbox frontend lives in the root | ||
65 | apps/pluginspuzzles/ directory. | ||
66 | |||
67 | The `resync.sh' shell script automates the resyncing process. It | ||
68 | copies the upstream sources (point it to a local copy of the | ||
69 | rockbox-devel branch above) into src/ and performs auto-generation of | ||
70 | the help content. Note that a modified version of "halibut" (Simon's | ||
71 | homegrown documentation processor) must be compiled from this source: | ||
72 | |||
73 | https://github.com/built1n/halibut | ||
74 | |||
75 | The LZ4 library and GCC are necessary as well. | ||
76 | |||
77 | Wishlist | ||
78 | ======== | ||
79 | |||
80 | - Proper polygon filling algorithm. The current algorithm is a hack | ||
81 | that uses overdrawn triangles. This will enable us to eliminate the | ||
82 | last of the Rockbox-specific modifications. | ||
83 | |||
34 | Kudos to Simon (duh), and Frank, for telling me about it. | 84 | Kudos to Simon (duh), and Frank, for telling me about it. |
35 | 85 | ||
36 | Franklin Wei (__builtin) | 86 | Franklin Wei (__builtin) |
@@ -67,3 +117,6 @@ saved games. | |||
67 | 117 | ||
68 | July 2024: Resync to 1c62dac (branched from Simon's fd304c5). | 118 | July 2024: Resync to 1c62dac (branched from Simon's fd304c5). |
69 | Implement user preferences menu. Introduced "Mosaic". | 119 | Implement user preferences menu. Introduced "Mosaic". |
120 | |||
121 | August 2024: Resync to ee5e327 (branched from Simon's | ||
122 | 1c1899e). Changes default Map stipple size to "Small". | ||