summaryrefslogtreecommitdiff
diff options
context:
space:
mode:
authorFranklin Wei <franklin@rockbox.org>2024-07-23 20:53:07 -0400
committerFranklin Wei <franklin@rockbox.org>2024-07-23 20:56:05 -0400
commitcd1922fe74916c909ff568437c5f71f7d08c0b2b (patch)
treec2bcdf8aec32c43a6f083a042cb14ea55c6aa979
parent96f564fe646b5efc2e67a3c15b619f4e2451286a (diff)
downloadrockbox-cd1922fe74916c909ff568437c5f71f7d08c0b2b.tar.gz
rockbox-cd1922fe74916c909ff568437c5f71f7d08c0b2b.zip
puzzles: update documentation and copyright year.
Change-Id: I50731664f278f76946f96529f4ec696c9c115589
-rw-r--r--apps/plugins/puzzles/README.rockbox3
-rw-r--r--apps/plugins/puzzles/rockbox.c24
2 files changed, 16 insertions, 11 deletions
diff --git a/apps/plugins/puzzles/README.rockbox b/apps/plugins/puzzles/README.rockbox
index e497c9794f..b64b60f694 100644
--- a/apps/plugins/puzzles/README.rockbox
+++ b/apps/plugins/puzzles/README.rockbox
@@ -64,3 +64,6 @@ May 2019: Resync to e2135d5.
64 64
65June 2020: Resync to 9aa7b7c. Fixed really embarrassing bug in loading 65June 2020: Resync to 9aa7b7c. Fixed really embarrassing bug in loading
66saved games. 66saved games.
67
68July 2024: Resync to 1c62dac (branched from Simon's fd304c5).
69Implement user preferences menu. Introduced "Mosaic".
diff --git a/apps/plugins/puzzles/rockbox.c b/apps/plugins/puzzles/rockbox.c
index c95e8a8356..a3fe1c6e96 100644
--- a/apps/plugins/puzzles/rockbox.c
+++ b/apps/plugins/puzzles/rockbox.c
@@ -7,7 +7,7 @@
7 * \/ \/ \/ \/ \/ 7 * \/ \/ \/ \/ \/
8 * $Id$ 8 * $Id$
9 * 9 *
10 * Copyright (C) 2016-2020 Franklin Wei 10 * Copyright (C) 2016-2024 Franklin Wei
11 * 11 *
12 * This program is free software; you can redistribute it and/or 12 * This program is free software; you can redistribute it and/or
13 * modify it under the terms of the GNU General Public License 13 * modify it under the terms of the GNU General Public License
@@ -24,10 +24,9 @@
24 * ================================ 24 * ================================
25 * 25 *
26 * This file contains the majority of the rockbox-specific code for 26 * This file contains the majority of the rockbox-specific code for
27 * the sgt-puzzles port. It implements a set of functions for the 27 * the sgt-puzzles port. It implements an API for the backend to call
28 * backend to call to actually run the games, as well as rockbox UI 28 * to run the games, as well as the rockbox UI code (menus, input,
29 * code (menus, input, etc). For a good overview of the rest of the 29 * etc). For a good overview of the rest of the puzzles code, see:
30 * puzzles code, see:
31 * 30 *
32 * <https://www.chiark.greenend.org.uk/~sgtatham/puzzles/devel/>. 31 * <https://www.chiark.greenend.org.uk/~sgtatham/puzzles/devel/>.
33 * 32 *
@@ -37,7 +36,7 @@
37 * Contents of this file 36 * Contents of this file
38 * --------------------- 37 * ---------------------
39 * 38 *
40 * By rough order of appearnce in this file: 39 * By rough order of appearance in this file:
41 * 40 *
42 * 1) "Zoom" feature 41 * 1) "Zoom" feature
43 * 42 *
@@ -62,8 +61,7 @@
62 * mode switching. In commit 5094aaa, this behavior was changed so 61 * mode switching. In commit 5094aaa, this behavior was changed so
63 * that the frontend can now query the backend for the on-screen 62 * that the frontend can now query the backend for the on-screen
64 * cursor location and move the viewport accordingly through the 63 * cursor location and move the viewport accordingly through the
65 * new midend_get_cursor_location() API (which is not yet merged 64 * new midend_get_cursor_location() API.
66 * into Simon's tree as of October 2020).
67 * 65 *
68 * 2) Font management 66 * 2) Font management
69 * 67 *
@@ -82,8 +80,8 @@
82 * 80 *
83 * 3) Drawing API 81 * 3) Drawing API
84 * 82 *
85 * The sgt-puzzles backend wants a set of function pointers to the 83 * The sgt-puzzles backend wants a set of function pointers to
86 * usual drawing primitives. [1] If the `zoom_enabled' switch is 84 * typical drawing primitives. [1] If the `zoom_enabled' switch is
87 * on, these call upon the "zoomed" drawing routines in (1). 85 * on, these call upon the "zoomed" drawing routines in (1).
88 * 86 *
89 * In the normal un-zoomed case, these functions generally rely on 87 * In the normal un-zoomed case, these functions generally rely on
@@ -108,7 +106,7 @@
108 * a) Mouse mode 106 * a) Mouse mode
109 * 107 *
110 * This mode is designed to accommodate puzzles without a 108 * This mode is designed to accommodate puzzles without a
111 * keyboard or cursor interface (currently only "Loopy"). We 109 * keyboard or cursor interface (currently only Loopyx). We
112 * remap the cursor keys to move an on-screen cursor rather 110 * remap the cursor keys to move an on-screen cursor rather
113 * than sending arrow keys to the game. 111 * than sending arrow keys to the game.
114 * 112 *
@@ -175,6 +173,10 @@
175 * generation, etc. Also supplied are a set of "presets" that 173 * generation, etc. Also supplied are a set of "presets" that
176 * specify a predetermined set of configuration parameters. 174 * specify a predetermined set of configuration parameters.
177 * 175 *
176 * In 2023, Simon introduced a User Preferences system that allows
177 * further customization of the game UI (e.g., "snap to grid" in
178 * Untangle). Rockbox support for this was added in July 2024.
179 *
178 * 6) In-game help 180 * 6) In-game help
179 * 181 *
180 * The sgt-puzzles manual (src/puzzles.but) contains a chapter 182 * The sgt-puzzles manual (src/puzzles.but) contains a chapter