Merge pull request #4 from ZaparooProject/feat/zaparoo-frontend-rename

Rename Zaparoo launcher UI to Frontend

Author: wizzomafizzo

ZAPAROO_FORK.md

@@ -20,23 +20,23 @@ non-blocking spawn) are intentionally omitted.
 
 | # | Cluster | Purpose | Where it lives |
 |---|---------|---------|----------------|
-| 1 | **External launcher process management** | Spawn `zaparoo/launcher` via `agetty` on tty2; SIGTERM/SIGKILL on shutdown; bounded `waitpid`; respawn timer; 3-strike crash give-up | `support/zaparoo/alt_launcher.cpp` (`spawn`, `kill_launcher`, `alt_launcher_poll`, `return_to_normal_mode`) |
-| 2 | **Process discovery & gating** | `alt_launcher_configured()` = file exists at `zaparoo/launcher` (cached, with sticky escape bit); `alt_launcher_active()` = process running | `support/zaparoo/alt_launcher.cpp:34-43,329-332` |
+| 1 | **External frontend process management** | Spawn `zaparoo/frontend` via `agetty` on tty2; SIGTERM/SIGKILL on shutdown; bounded `waitpid`; respawn timer; 3-strike crash give-up | `support/zaparoo/alt_launcher.cpp` (`spawn`, `kill_launcher`, `alt_launcher_poll`, `return_to_normal_mode`) |
+| 2 | **Process discovery & gating** | `alt_launcher_configured()` = file exists at `zaparoo/frontend` (cached, with sticky escape bit); `alt_launcher_active()` = process running | `support/zaparoo/alt_launcher.cpp:34-43,329-332` |
 | 3 | **Custom menu RBF discovery** | `menu_rbf_name()` / `is_menu_rbf()` so a Zaparoo build can ship its own renamed menu RBF and the file_io / fpga_io / user_io paths still recognize it | `support/zaparoo/menu_rbf.cpp/.h`; consumers in `file_io.cpp`, `fpga_io.cpp`, `user_io.cpp` |
 | 4 | **Forced cfg overrides** | `alt_launcher_cfg_apply()` forces `cfg.fb_terminal = 1; cfg.recents = 1` after INI parse. Original `ALT_LAUNCHER` / `MENU_RBF` INI knobs were dropped in favor of file-existence detection | `cfg.cpp:614`, `support/zaparoo/alt_launcher.cpp:24-30` |
 | 5 | **Polling integration** | `alt_launcher_poll()` driven by main scheduler tick | `scheduler.cpp:36`, `support/zaparoo/alt_launcher.cpp:365` |
-| 6 | **TTY / framebuffer hygiene** | Clear/reset tty2 around launcher lifecycle; toggle `video_fb_enable` and `video_chvt` only on respawn paths; don't touch them on plain shutdown | `support/zaparoo/alt_launcher.cpp` (`clear_launcher_tty`, `reset_launcher_tty`) |
-| 7 | **Joypad routing into launcher** | `alt_launcher_fb_terminal_key()` translates `JOY_L2/R2/OSD` to `KEY_F1/BACKSPACE/MENU`; `joy_digital()` short-circuits to `uinp_send_key` when launcher active | `input.cpp:2475-2484`, `support/zaparoo/alt_launcher.cpp:45-62` |
-| 8 | **Native CRT rendering path** | Launcher running in CRT mode: kernel framebuffer at 320×240 RGBA8888, FPGA scans separate region at `0x3A000000`, `status[9]=1` gates it; pre-spawn blank wipes the prior frame | `support/zaparoo/alt_launcher.cpp` (`enable_native_crt_path`, `disable_native_crt_path`, `blank_native_crt_fb`); paired with `Menu_MiSTer/rtl/native_video_*.sv` |
+| 6 | **TTY / framebuffer hygiene** | Clear/reset tty2 around frontend lifecycle; toggle `video_fb_enable` and `video_chvt` only on respawn paths; don't touch them on plain shutdown | `support/zaparoo/alt_launcher.cpp` (`clear_launcher_tty`, `reset_launcher_tty`) |
+| 7 | **Joypad routing into frontend** | `alt_launcher_fb_terminal_key()` translates `JOY_L2/R2/OSD` to `KEY_F1/BACKSPACE/MENU`; `joy_digital()` short-circuits to `uinp_send_key` when frontend active | `input.cpp:2475-2484`, `support/zaparoo/alt_launcher.cpp:45-62` |
+| 8 | **Native CRT rendering path** | Frontend running in CRT mode: kernel framebuffer at 320×240 RGBA8888, FPGA scans separate region at `0x3A000000`, `status[9]=1` gates it; pre-spawn blank wipes the prior frame | `support/zaparoo/alt_launcher.cpp` (`enable_native_crt_path`, `disable_native_crt_path`, `blank_native_crt_fb`); paired with `Menu_MiSTer/rtl/native_video_*.sv` |
 | 9 | **CRT mode persistence** | 1-byte `zaparoo_launcher_crt.bin` via `FileSaveConfig` / `FileLoadConfig`; loaded at menu init, applied on spawn | `support/zaparoo/alt_launcher.cpp:76-89,344,499` |
 | 10 | **Native-core auto-init** | `zaparoo_is_native_core()` matches core name `"Zaparoo Launcher"`; `zaparoo_alt_launcher_init_for_core()` auto-spawns when the FPGA loads that core | `support/zaparoo/alt_launcher.cpp:480-495`, `user_io.cpp:1543` |
-| 11 | **In-core "Launcher" OSD entry** | Adds row 31 (`ALT_LAUNCHER_MENUSUB`) to MENU_COMMON1 marked with `reboot_req` when activated | `menu.cpp:2831,2845-2849,3088-3091` |
-| 12 | **OSD/F12 overlay over running launcher** | F12 / `KEY_MENU` reaches the OSD even with launcher running; on menu core opens System Settings directly (skip file picker); F1/F9 disabled when launcher active; `vga_nag` suppressed; auto-open suppressed in CRT mode | `menu.cpp:843-852,1289,1304-1311,1334,1583,1604-1611,6727,6739,6816,6901`, `user_io.cpp:4162-4171` |
+| 11 | **In-core "Frontend" OSD entry** | Adds row 31 (`ALT_LAUNCHER_MENUSUB`) to MENU_COMMON1 marked with `reboot_req` when activated | `menu.cpp:2831,2845-2849,3088-3091` |
+| 12 | **OSD/F12 overlay over running frontend** | F12 / `KEY_MENU` reaches the OSD even with frontend running; on menu core opens System Settings directly (skip file picker); F1/F9 disabled when frontend active; `vga_nag` suppressed; auto-open suppressed in CRT mode | `menu.cpp:843-852,1289,1304-1311,1334,1583,1604-1611,6727,6739,6816,6901`, `user_io.cpp:4162-4171` |
 | 13 | **Trimmed System Settings render** | `alt_launcher_render_system_menu()` overrides MENU_SYSTEM1 body for the alt-launcher path; `alt_launcher_translate_system_select()` maps trimmed menusub indices (Remap, Define joy, Scripts, Reboot, Exit) to upstream dispatch slots | `support/zaparoo/alt_launcher_menu.cpp`, `menu.cpp:6739-6745,6816-6821` |
-| 14 | **Right-side Zaparoo Launcher pages (two-page)** | Right-arrow from System Settings enters `MENU_ZAPAROO_LAUNCHER1/2` (top page: Video, Exit). Selecting Video enters `MENU_ZAPAROO_VIDEO1/2` (sub-page: CRT mode, H Offset, V Offset, Exit) where left/right adjust values and `±` also work. Both pages live in one helper file with split renderers / select handlers per page | `support/zaparoo/launcher_pages.cpp/.h` (`launcher_page_*`, `video_page_*`), `support/zaparoo/alt_launcher.cpp` (offset state + setters), `menu.cpp` `MENU_ZAPAROO_LAUNCHER*` and `MENU_ZAPAROO_VIDEO*` cases |
+| 14 | **Right-side Zaparoo Frontend pages (two-page)** | Right-arrow from System Settings enters `MENU_ZAPAROO_LAUNCHER1/2` (top page: Video, Exit). Selecting Video enters `MENU_ZAPAROO_VIDEO1/2` (sub-page: CRT mode, H Offset, V Offset, Exit) where left/right adjust values and `±` also work. Both pages live in one helper file with split renderers / select handlers per page | `support/zaparoo/launcher_pages.cpp/.h` (`launcher_page_*`, `video_page_*`), `support/zaparoo/alt_launcher.cpp` (offset state + setters), `menu.cpp` `MENU_ZAPAROO_LAUNCHER*` and `MENU_ZAPAROO_VIDEO*` cases |
 | 15 | **H/V offset persistence and push** | 2-byte `zaparoo_video_offsets.bin` via `FileSaveConfig` / `FileLoadConfig`; loaded at menu init alongside the CRT byte; values pushed to FPGA via `user_io_status_set("[13:10]" / "[17:14]")` so the change takes effect immediately | `support/zaparoo/alt_launcher.cpp` (`load_persisted_offsets`, `save_persisted_offsets`, `alt_launcher_set_h_offset`/`_v_offset`, `zaparoo_alt_launcher_init_for_menu`) |
-| 16 | **OSD auto-dismiss on launcher spawn** | `spawn()` calls `MenuHide()` after fork so an OSD still up from CRT toggle / Reboot doesn't trap input once the launcher grabs the input device | `support/zaparoo/alt_launcher.cpp` (end of `spawn`) |
-| 17 | **CRT-mode-on-exit safety** | If the launcher exits while in CRT mode (clean or crashed), drop back to HDMI / normal mode for the rest of this session instead of respawning into CRT — avoids a UX trap where the user just left CRT but the launcher would respawn into it. Persisted preference is left untouched so next reboot honors it | `support/zaparoo/alt_launcher.cpp` `alt_launcher_poll()` post-`waitpid` branch |
+| 16 | **OSD auto-dismiss on frontend spawn** | `spawn()` calls `MenuHide()` after fork so an OSD still up from CRT toggle / Reboot doesn't trap input once the frontend grabs the input device | `support/zaparoo/alt_launcher.cpp` (end of `spawn`) |
+| 17 | **CRT-mode-on-exit safety** | If the frontend exits while in CRT mode (clean or crashed), drop back to HDMI / normal mode for the rest of this session instead of respawning into CRT — avoids a UX trap where the user just left CRT but the frontend would respawn into it. Persisted preference is left untouched so next reboot honors it | `support/zaparoo/alt_launcher.cpp` `alt_launcher_poll()` post-`waitpid` branch |
 | 18 | **Escape-to-stock semantics** | Sticky `s_escaped` flag makes `alt_launcher_configured()` return `false` after a clean exit, so the rest of the session reverts to stock OSD; reboot resets it | `support/zaparoo/alt_launcher.cpp:32,38-43,229-241` |
 | 19 | **CI / build infrastructure** | Docker container build; binary named `MiSTer_Zaparoo`; "Z"-suffixed version; release / unstable CI; sync-upstream workflow; deploy script | `docker-build.sh`, `stable-build.sh`, `unstable-build.sh`, `deploy-zaparoo.sh`, `.github/build_*.sh`, `.github/workflows/*.yml` |
 | 20 | **Build-time defaults flipped** | `cfg.recents` and `LOG_FILE_ENTRY` default to enabled in Zaparoo builds | `cfg.cpp` (defaults) |
@@ -66,13 +66,13 @@ interchangeably without a documented rule. Current de-facto convention:
 
 | Predicate | Meaning | Used to gate |
 |-----------|---------|--------------|
-| `_configured` | binary file exists, sticky off after escape | **render paths** (System Settings body, MENU_SYSTEM1 entry, vga_nag, file-picker entry, "Launcher" row visibility, right-arrow gate) |
-| `_active` | PID alive | **input handling** (F1/F9 disable, joypad-to-launcher routing, OSD overlay, menu auto-open suppression) |
+| `_configured` | binary file exists, sticky off after escape | **render paths** (System Settings body, MENU_SYSTEM1 entry, vga_nag, file-picker entry, "Frontend" row visibility, right-arrow gate) |
+| `_active` | PID alive | **input handling** (F1/F9 disable, joypad-to-frontend routing, OSD overlay, menu auto-open suppression) |
 | `_native_crt` | PID alive AND CRT mode on | **internal video state machine** (`disable_native_crt_path`, status timer) |
 
 The split is mostly principled but leaks at `MENU_SYSTEM1`, which uses
 `_configured` for both the gate AND the body delegation while `MENU_NONE2`
-auto-open uses `_active`. A user with the launcher binary present but not yet
+auto-open uses `_active`. A user with the frontend binary present but not yet
 running sees different OSD behavior than a user without the binary at all —
 worth either a comment or a unified helper.
 
@@ -103,7 +103,7 @@ Cost: a one-shot migration on existing installs (read legacy `crt.bin` if
 new file is missing; never write the legacy file again).
 
 ### 2.4 Hardcoded paths scattered across modules
-- Launcher path: `zaparoo/launcher` in `alt_launcher.cpp:22`
+- Frontend path: `zaparoo/frontend` in `alt_launcher.cpp:22`
 - Menu RBF name(s): hardcoded in `support/zaparoo/menu_rbf.cpp`
 - Persistence files: hardcoded in `alt_launcher.cpp`
 
@@ -132,7 +132,7 @@ It can shrink to one line:
 
 ```c
 // F12/KEY_MENU bypasses alt_launcher_active() so the user can open
-// the OSD on top of a running launcher.
+// the OSD on top of a running frontend.
 ```
 
 ### 2.7 Trimmed-menu dispatcher has a dead branch
@@ -172,21 +172,21 @@ the right-side surface is now two pages, `MENU_ZAPAROO_LAUNCHER*` (top) and
 `video_page_*` both living in `support/zaparoo/launcher_pages.{cpp,h}`.
 File name and symbols agree. ✅
 
-### 2.11 Two ways to dismiss the OSD on launcher spawn
-The launcher's `spawn()` calls `MenuHide()` to drop a still-open OSD before
-the launcher grabs input, which is the new safety net (entry 16 in the
+### 2.11 Two ways to dismiss the OSD on frontend spawn
+The frontend's `spawn()` calls `MenuHide()` to drop a still-open OSD before
+the frontend grabs input, which is the new safety net (entry 16 in the
 table). Independently, `MENU_SYSTEM2`'s F12 handler also forces
 `MENU_NONE1` when `alt_launcher_configured()` is true. Both are needed —
 spawn-side handles the "Reboot from System Settings" path, F12-side
 handles the "user opens and closes OSD without spawning" path — but the
 overlap is implicit. Worth a code comment naming each owner.
 
-### 2.12 CRT-mode-on-exit drops launcher entirely
-Entry 17 in the table: if the launcher exits while in CRT mode, the fork
+### 2.12 CRT-mode-on-exit drops frontend entirely
+Entry 17 in the table: if the frontend exits while in CRT mode, the fork
 permanently drops back to HDMI for the session, even on a clean exit (not
 just crashes). That's intentional UX to avoid a trap, but it means a user
-who exits the launcher in CRT mode and wants to come back has to reboot.
-Worth documenting in the launcher's own README, or relaxing the rule for
+who exits the frontend in CRT mode and wants to come back has to reboot.
+Worth documenting in the frontend's own README, or relaxing the rule for
 clean exits if respawn-into-CRT turns out to be valuable.
 
 ---

menu.cpp

@@ -87,7 +87,7 @@ enum MENU
 	MENU_MISC2,
 
 	// Right-side companion to System Settings on the alt-launcher menu core.
-	// Top "Zaparoo Launcher" page lists sub-pages (Video) and an exit row;
+	// Top "Zaparoo Frontend" page lists sub-pages (Video) and an exit row;
 	// the Video sub-page hosts CRT mode + H/V centering offsets and binds
 	// left/right arrows to value adjustment.
 	MENU_ZAPAROO_LAUNCHER1,
@@ -858,7 +858,7 @@ static void vga_nag()
 {
 	// With an alt launcher configured the user has fb_terminal on by design
 	// and the CRT is fed directly by the menu core (snow pattern when status[9]=0,
-	// or the launcher's framebuffer when status[9]=1). The "fix MiSTer.ini"
+	// or the frontend's framebuffer when status[9]=1). The "fix MiSTer.ini"
 	// nag is not appropriate — just leave the OSD off without the warning.
 	if (video_fb_state() && !alt_launcher_configured())
 	{
@@ -1589,7 +1589,7 @@ void HandleUI(void)
 		}
 		// On the menu core without an alt launcher, the menu *is* the screen —
 		// keep auto-opening the OSD whenever fb_terminal is off. With an alt
-		// launcher running, that rule would re-open System Settings the moment
+		// frontend running, that rule would re-open System Settings the moment
 		// the user closes it (in CRT mode video_fb_state is false), so the OSD
 		// could never actually close. Suppress the auto-open in that case;
 		// explicit F12/MENU presses still open and close it normally.
@@ -2858,7 +2858,7 @@ void HandleUI(void)
 				if (alt_launcher_configured())
 				{
 					menumask |= (1ULL << ALT_LAUNCHER_MENUSUB);
-					MenuWrite(n++, " Launcher", menusub == ALT_LAUNCHER_MENUSUB, 0);
+					MenuWrite(n++, " Frontend", menusub == ALT_LAUNCHER_MENUSUB, 0);
 				}
 
 				MenuWrite(n++, " Core                      \x16", menusub == 0, 0);
@@ -6738,7 +6738,7 @@ void HandleUI(void)
 		// Without an alt launcher, the wallpaper / fb_terminal flow can't coexist
 		// with this menu — bail out so vga_nag can show the MiSTer.ini warning.
 		// With an alt launcher the OSD overlay is exactly what we want on top of
-		// the running launcher, so let it render through.
+		// the running frontend, so let it render through.
 		if (video_fb_state() && !alt_launcher_configured())
 		{
 			menustate = MENU_NONE1;
@@ -6923,7 +6923,7 @@ void HandleUI(void)
 		break;
 
 		/******************************************************************/
-		/* zaparoo launcher pages (right-side sibling of System)          */
+		/* zaparoo frontend pages (right-side sibling of System)          */
 		/******************************************************************/
 	case MENU_ZAPAROO_LAUNCHER1:
 		if (!alt_launcher_configured())

support/zaparoo/alt_launcher.cpp

@@ -20,12 +20,12 @@
 #include "user_io.h"
 #include "video.h"
 
-static const char s_launcher_path[] = "zaparoo/launcher";
+static const char s_launcher_path[] = "zaparoo/frontend";
 
 void alt_launcher_cfg_apply(void)
 {
 	// Override any user ini values: this fork is single-purpose and the
-	// launcher needs both flags on to render.
+	// frontend needs both flags on to render.
 	cfg.fb_terminal = 1;
 	cfg.recents = 1;
 }
@@ -136,12 +136,12 @@ static void set_native_crt_fb_mode(bool log = true)
 
 static void blank_native_crt_fb(void)
 {
-	// CRT path doesn't read /dev/fb0 (kernel FB at 0x22000000). The launcher
+	// CRT path doesn't read /dev/fb0 (kernel FB at 0x22000000). The frontend
 	// runs a worker that copies the top-left 320x240 from /dev/fb0 into a
 	// separate FPGA-mapped region at 0x3A000000 (control word + two 320x240
 	// RGBA buffers). The FPGA scans out from that region. Nothing zeros it
-	// across launcher restarts or software reboots, so the previous session's
-	// last frame ghosts in until the launcher's writer thread starts.
+	// across frontend restarts or software reboots, so the previous session's
+	// last frame ghosts in until the frontend's writer thread starts.
 	const uint32_t native_addr = 0x3A000000u;
 	const uint32_t native_size = 0x000A0000u;
 	void *p = shmem_map(native_addr, native_size);
@@ -226,7 +226,7 @@ static void enable_native_crt_path(void)
 	video_fb_enable(0);
 
 	// Double-write with a settle window so the kernel module's 320x240 layout
-	// is live before status[9] flips. Without this, the launcher renders for
+	// is live before status[9] flips. Without this, the frontend renders for
 	// up to a second under stale dims (the post-fork retry timer used to be
 	// what eventually fixed the picture).
 	set_native_crt_fb_mode(false);
@@ -351,7 +351,7 @@ static void spawn(void)
 		user_io_status_set("[9]", 1);
 	}
 
-	// The launcher grabs input as soon as it starts. If the OSD is still
+	// The frontend grabs input as soon as it starts. If the OSD is still
 	// up (e.g. user toggled CRT mode or hit Reboot from System Settings),
 	// it would trap input with no way to dismiss it — drop it now.
 	if (menu_present()) MenuHide();
@@ -402,8 +402,8 @@ void alt_launcher_toggle_crt(void)
 	printf("alt_launcher: toggle CRT path %d -> %d\n", current_crt, target_crt);
 
 	// Shutdown drops status[9], releases the FB mode and restores HPS framebuffer
-	// state regardless of whether the launcher was running. After it returns we
-	// always have a clean slate to spawn the next launcher invocation.
+	// state regardless of whether the frontend was running. After it returns we
+	// always have a clean slate to spawn the next frontend invocation.
 	alt_launcher_shutdown();
 	alt_launcher_init(target_crt);
 }
@@ -445,7 +445,7 @@ void alt_launcher_poll(void)
 			int sig = WIFSIGNALED(status) ? WTERMSIG(status) : 0;
 			bool escaped = (exited && exit_status == 0) || sig == SIGTERM || sig == SIGINT;
 			bool crashed = !escaped && (sig != 0 || (exited && exit_status != 0));
-			// Any exit while in CRT mode drops back to HDMI / no launcher
+			// Any exit while in CRT mode drops back to HDMI / no frontend
 			// for the rest of this session — respawning into CRT after the
 			// user already left it is a UX trap. The persisted CRT
 			// preference is intentionally untouched (return_to_normal_mode
@@ -566,7 +566,7 @@ void zaparoo_alt_launcher_init_for_menu(void)
 {
 	bool crt = load_persisted_native_crt();
 	load_persisted_offsets();
-	printf("alt_launcher: initializing menu launcher (persisted crt=%d, h=%d, v=%d)\n",
+	printf("alt_launcher: initializing menu frontend (persisted crt=%d, h=%d, v=%d)\n",
 	       crt, s_h_offset, s_v_offset);
 	// Push the persisted offsets to the FPGA now that the menu RBF is loaded.
 	user_io_status_set("[13:10]", (uint32_t)((uint8_t)s_h_offset & 0xF));