good stuff

Author: gajop

.gitignore

@@ -15,3 +15,6 @@ env/
 
 # Rust build artifacts
 native/target/
+
+# E2E run artifacts (screenshots, logs, reports)
+tools/e2e/artifacts/

LuaRules/Gadgets/ui_chonsole_load.lua

@@ -3,6 +3,8 @@
 -- Copy this file to both the luaui/widgets and the luarules/gadgets folders
 
 -- Set this line to the Chonsole installation folder
+if Spring.GetGameRulesParam("sb_ui") ~= "chili" then return false end
+
 CHONSOLE_FOLDER = "libs_sb/chonsole"
 
 -- Do NOT modify the following lines

LuaUI/widgets/api_chilifx.lua

@@ -1,3 +1,7 @@
+if Spring.GetGameRulesParam("sb_ui") ~= "chili" then
+    return false
+end
+
 function widget:GetInfo()
     return {
         name      = "ChiliFX",
@@ -17,11 +21,6 @@ LCS = LCS()
 CHILILFX_DIR = "libs_sb/chilifx/chilifx/"
 
 function widget:Initialize()
-    if Spring.GetGameRulesParam("sb_ui") ~= "chili" then
-        widgetHandler:RemoveWidget(widget)
-        return
-    end
-
     ChiliFX = VFS.Include(CHILILFX_DIR .. "core.lua", nil)
 
     WG.ChiliFX = ChiliFX()

LuaUI/widgets/api_chotify.lua

@@ -1,3 +1,7 @@
+if Spring.GetGameRulesParam("sb_ui") ~= "chili" then
+    return false
+end
+
 function widget:GetInfo()
     return {
         name      = "Chotify",
@@ -17,10 +21,6 @@ LCS = LCS()
 CHOTIFY_DIR = "libs_sb/chotify/chotify/"
 
 function widget:Initialize()
-    if Spring.GetGameRulesParam("sb_ui") ~= "chili" then
-        widgetHandler:RemoveWidget(widget)
-        return
-    end
     if not WG.ChiliFX then
         Spring.Log("Chotify", LOG.ERROR, "Missing ChiliFX")
         widgetHandler:RemoveWidget(widget)

LuaUI/widgets/api_sb_chili.lua

@@ -1,6 +1,10 @@
 --------------------------------------------------------------------------------
 --------------------------------------------------------------------------------
 
+if Spring.GetGameRulesParam("sb_ui") ~= "chili" then
+	return false
+end
+
 function widget:GetInfo()
 	return {
 		name      = "Chili Framework (SpringBoard)",
@@ -41,10 +45,6 @@ THEME_DIRNAME = LUA_DIRNAME .. "Configs/chili/themes/"
 --------------------------------------------------------------------------------
 
 function widget:Initialize()
-	if Spring.GetGameRulesParam("sb_ui") ~= "chili" then
-		widgetHandler:RemoveWidget(widget)
-		return
-	end
 	Chili = VFS.Include(CHILI_DIRNAME .. "core.lua", nil, VFS.RAW_FIRST)
 
 	screen0 = Chili.Screen:New{}

LuaUI/widgets/dbg_dev_console.lua

@@ -6,10 +6,14 @@
 -- Put it on a repository, load it like other libs
 -- Fix fontsize changing on select
 -- Pop up on new warning (option)
--- Button to upload log (using the connector)
--- Scrollbar should have a constant height (it can be too small if there's a lot of text)
-
-function widget:GetInfo()
+-- Button to upload log (using the connector)
+-- Scrollbar should have a constant height (it can be too small if there's a lot of text)
+
+if Spring.GetGameRulesParam("sb_ui") ~= "chili" then
+	return false
+end
+
+function widget:GetInfo()
 	return {
 		name    = 'Developer Console',
 		desc    = 'Displays useful information for developers',
@@ -445,11 +449,10 @@ function widget:TextCommand(command)
 end
 
 function widget:Initialize()
-	Spring.SendCommands('console 0')
-	if Spring.GetGameRulesParam("gameMode") == "play"
-		or Spring.GetGameRulesParam("sb_ui") ~= "chili" then
-		widgetHandler:RemoveWidget(self)
-		return
+	Spring.SendCommands('console 0')
+	if Spring.GetGameRulesParam("gameMode") == "play" then
+		widgetHandler:RemoveWidget(self)
+		return
 	end
 	Chili = WG.SBChili or WG.Chili
 	screen = Chili.Screen0
@@ -481,8 +484,8 @@ function widget:GetConfigData()
 	return cfg
 end
 
-function widget:SetConfigData(data)
-	for k, v in pairs(data) do
+function widget:SetConfigData(data)
+	for k, v in pairs(data) do
 		cfg[k] = v
 	end
 

LuaUI/widgets/gui_chili_selections_and_cursortip.lua

@@ -1,5 +1,9 @@
 --TODO investigate Chili-Error in `Chili Selections & CursorTip`:2435 : [string "LuaUI/Widgets/chili/controls/control.lua"]:897: attempt to index field 'parent' (a nil value). (This bug is many months old. This TODO is written on 18 October 2013). See end of file for longer stacktrace.
 --------------------------------------------------------------------------------
+if Spring.GetGameRulesParam("sb_ui") ~= "chili" then
+  return false
+end
+
 function widget:GetInfo()
   return {
     name      = "Chili Selections & CursorTip",
@@ -2397,8 +2401,7 @@ function widget:ViewResize(vsx, vsy)
 end
 
 function widget:Initialize()
-    if Spring.GetGameRulesParam("sb_gameMode") == "play"
-		or Spring.GetGameRulesParam("sb_ui") ~= "chili" then
+    if Spring.GetGameRulesParam("sb_gameMode") == "play" then
 		widgetHandler:RemoveWidget(widget)
 		return
     end

LuaUI/widgets/sb_ui_chonsole_load.lua

@@ -3,11 +3,15 @@
 -- Copy this file to both the luaui/widgets and the luarules/gadgets folders
 
 -- Set this line to the Chonsole installation folder
+if Spring.GetGameRulesParam("sb_ui") ~= "chili" then
+    return false
+end
+
 CHONSOLE_FOLDER = "libs_sb/chonsole"
 
 -- Do NOT modify the following lines
 if Script.GetName() == "LuaUI" then
-	VFS.Include(CHONSOLE_FOLDER .. "/luaui/widgets/ui_chonsole.lua", nil, VFS.DEF_MODE)
+    VFS.Include(CHONSOLE_FOLDER .. "/luaui/widgets/ui_chonsole.lua", nil, VFS.DEF_MODE)
 elseif Script.GetName() == "LuaRules" then
-	VFS.Include(CHONSOLE_FOLDER .. "/luarules/gadgets/ui_chonsole.lua", nil, VFS.DEF_MODE)
+    VFS.Include(CHONSOLE_FOLDER .. "/luarules/gadgets/ui_chonsole.lua", nil, VFS.DEF_MODE)
 end

docs/porting/todo.md

@@ -490,4 +490,30 @@ devconsole does this:
   }
   ```
 
-  realistically, most of it is stuff (at least bottom with selection and copy) that rmlui/engine should be doing, and not per UI components
+  realistically, most of it is stuff (at least bottom with selection and copy) that rmlui/engine should be doing, and not per UI components
+
+# 27. update rust & pthon packages (pyproject is outdated)
+
+do this once we've fully migrated everything from rust-wip here
+
+# 28. (optional) Always-on control server — remove the `SBC_CONTROL_FILE` gate
+
+The control server (`native/src/sbc/control/`) is currently gated behind the `SBC_CONTROL_FILE` env var and wrapped in `Option<ControlServer>`. It only starts when the e2e harness sets that var. But the control server is meant for both e2e testing and programmatic control (Blender-style Python API equivalent), so it should always be running.
+
+**What needs to happen:**
+- Add an engine binding to expose the write dir to native modules (there is no Rust-side `get_write_dir()` — the Lua side gets it from the launcher via the `_sl_write_path` mod option, but the launcher is going away). The engine knows its write dir internally (`dataDirLocater.GetWriteDirPath()` in C++, set via `--write-dir`), it's just not wired into the native plugin API.
+- Default the discovery file to `<write_dir>/control.json` so the server can start without external configuration.
+- `SBC_CONTROL_FILE` becomes an optional override for the discovery path, not a gate.
+- Remove the `Option` wrapper — `ControlServer` is always present.
+
+# 29. Failable callouts
+
+I see a ton of callouts that return result. Is this all senseless?
+My guess is they can only really return Errors for the first moment that they're not initialized.
+This is done at plugin boot so it's a great disservice to 99% of the code to have to test this everywhere.
+
+```rs
+    let direction = camera
+        .get_camera_direction()
+        .map_err(|err| ControlError::failed(format!("get_camera_direction: {err:?}")))?;
+```

justfile

@@ -4,6 +4,7 @@ set dotenv-load
 # Engine paths come from .env (see .env.example) — never hardcode personal paths.
 engine_build_dir := env_var_or_default("SBC_ENGINE_BUILD_DIR", "")
 engine_rust_dir := env_var_or_default("SBC_ENGINE_RUST_DIR", "")
+tool_pythonpath := "build:tools"
 
 # Show available recipes.
 [private]
@@ -91,3 +92,38 @@ verify-native: lint test-unit build-native
 [group('run')]
 run: build-native
     bash tools/dev/launch.sh
+
+# Run black-box UI E2E tests. The native plugin is rebuilt first.
+[group('test')]
+test-e2e target="all" *args: build-native
+    PYTHONPATH="{{tool_pythonpath}}" uv run --locked sbc-e2e run "{{target}}" {{args}}
+
+# List every reference image and whether it is approved or still ai-reviewed.
+[group('test')]
+goldens-status:
+    @PYTHONPATH="{{tool_pythonpath}}" uv run --locked sbc-e2e goldens-status
+
+# Where a case's last captures differ from its goldens, marked in magenta.
+[group('test')]
+goldens-diff case *args:
+    @PYTHONPATH="{{tool_pythonpath}}" uv run --locked sbc-e2e goldens-diff "{{case}}" {{args}}
+
+# Approve a case's reference images (the human OK): `just goldens-approve developer-console`.
+[group('test')]
+goldens-approve case *shots:
+    PYTHONPATH="{{tool_pythonpath}}" uv run --locked sbc-e2e approve-goldens "{{case}}" {{shots}}
+
+# Path of the most recent e2e run, optionally for one target: `just e2e-dir developer-console`.
+[group('test')]
+e2e-dir target="":
+    @ls -dt artifacts/ui-e2e/*{{target}}* | head -1
+
+# Grep the most recent run's engine log.
+[group('test')]
+e2e-log target pattern:
+    @grep -o ".\{0,20\}{{pattern}}.\{0,120\}" "$(ls -dt artifacts/ui-e2e/*{{target}}* | head -1)/infolog.txt" || echo "no match"
+
+# Open the most recent run's screenshots dir.
+[group('test')]
+e2e-shots target="":
+    @ls "$(ls -dt artifacts/ui-e2e/*{{target}}* | head -1)/screens"