feat(launcher): add bug tab and native device reporting

src/core/IssueReport.lua

@@ -6,6 +6,49 @@ local IssueReport = {}
 local FORM_URL = "https://github.com/bryanthaboi/gen1recomp/issues/new"
 local TEMPLATE = "bug_report.yml"
 
+local APPLE_MODELS = {
+  ["iPhone14,2"] = "iPhone 13 Pro",
+  ["iPhone14,3"] = "iPhone 13 Pro Max",
+  ["iPhone14,4"] = "iPhone 13 mini",
+  ["iPhone14,5"] = "iPhone 13",
+  ["iPhone14,7"] = "iPhone 14",
+  ["iPhone14,8"] = "iPhone 14 Plus",
+  ["iPhone15,2"] = "iPhone 14 Pro",
+  ["iPhone15,3"] = "iPhone 14 Pro Max",
+  ["iPhone15,4"] = "iPhone 15",
+  ["iPhone15,5"] = "iPhone 15 Plus",
+  ["iPhone16,1"] = "iPhone 15 Pro",
+  ["iPhone16,2"] = "iPhone 15 Pro Max",
+  ["iPhone17,1"] = "iPhone 16 Pro",
+  ["iPhone17,2"] = "iPhone 16 Pro Max",
+  ["iPhone17,3"] = "iPhone 16",
+  ["iPhone17,4"] = "iPhone 16 Plus",
+  ["iPhone17,5"] = "iPhone 16e",
+  ["Mac14,2"] = "MacBook Air (13-inch, M2)",
+  ["Mac14,3"] = "Mac mini (M2)",
+  ["Mac14,5"] = "MacBook Pro (14-inch, M2 Max)",
+  ["Mac14,6"] = "MacBook Pro (16-inch, M2 Max)",
+  ["Mac14,7"] = "MacBook Pro (13-inch, M2)",
+  ["Mac14,9"] = "MacBook Pro (14-inch, M2 Pro)",
+  ["Mac14,10"] = "MacBook Pro (16-inch, M2 Pro)",
+  ["Mac14,12"] = "Mac mini (M2 Pro)",
+  ["Mac14,13"] = "Mac Studio (M2 Max)",
+  ["Mac14,14"] = "Mac Studio (M2 Ultra)",
+  ["Mac14,15"] = "MacBook Air (15-inch, M2)",
+  ["Mac15,3"] = "MacBook Pro (14-inch, M3)",
+  ["Mac15,6"] = "MacBook Pro (14-inch, M3 Pro)",
+  ["Mac15,7"] = "MacBook Pro (16-inch, M3 Pro)",
+  ["Mac15,12"] = "MacBook Air (13-inch, M3)",
+  ["Mac15,13"] = "MacBook Air (15-inch, M3)",
+  ["Mac16,1"] = "MacBook Pro (14-inch, M4)",
+  ["Mac16,5"] = "MacBook Pro (16-inch, M4 Max)",
+  ["Mac16,6"] = "MacBook Pro (14-inch, M4 Max)",
+  ["Mac16,7"] = "MacBook Pro (16-inch, M4 Pro)",
+  ["Mac16,8"] = "MacBook Pro (14-inch, M4 Pro)",
+  ["Mac16,10"] = "Mac mini (M4)",
+  ["Mac16,11"] = "Mac mini (M4 Pro)",
+}
+
 local function clean(value)
   if value == nil then return nil end
   local text = tostring(value):gsub("^%s+", ""):gsub("%s+$", "")
@@ -36,6 +79,16 @@ local function commandValue(command)
   return clean(value)
 end
 
+local function commandText(command)
+  if not io or type(io.popen) ~= "function" then return nil end
+  local ok, pipe = pcall(io.popen, command, "r")
+  if not ok or not pipe then return nil end
+  local readOK, value = pcall(pipe.read, pipe, "*a")
+  pcall(pipe.close, pipe)
+  if not readOK then return nil end
+  return clean(value)
+end
+
 local function percentEncode(value)
   local text = tostring(value or "")
   return (text:gsub("([^%w%-_%.~])", function(char)
@@ -66,6 +119,25 @@ local function loveVersion()
   return result
 end
 
+local function friendlyModel(identifier)
+  identifier = clean(identifier)
+  if not identifier then return nil end
+  return APPLE_MODELS[identifier] or identifier
+end
+
+local function macModel()
+  local details = commandText("system_profiler SPHardwareDataType 2>/dev/null")
+  if details then
+    local name = clean(details:match("Model Name:%s*([^\r\n]+)"))
+    local chip = clean(details:match("Chip:%s*([^\r\n]+)"))
+    if name and chip and not name:find(chip, 1, true) then
+      return name .. " (" .. chip .. ")"
+    end
+    if name then return name end
+  end
+  return friendlyModel(commandValue("sysctl -n hw.model 2>/dev/null"))
+end
+
 local function appVersion()
   local version = clean(Version.engine)
   if not version or version == "0.0.0" or version == "0.0.0-dev" then return "" end
@@ -73,20 +145,25 @@ local function appVersion()
 end
 
 local function deviceModel(rawOS, system)
-  local model = clean(call(system.getModel))
-  if model then return model end
+  local nativeModel = clean(call(system.getDeviceModel))
+  if nativeModel then return friendlyModel(nativeModel) end
   if rawOS == "OS X" or rawOS == "macOS" then
-    return commandValue("sysctl -n hw.model 2>/dev/null")
+    return macModel()
+  end
+  local model = clean(call(system.getModel))
+  if model and not model:lower():find("gpu", 1, true)
+      and not model:lower():find("renderer", 1, true) then
+    return friendlyModel(model)
   end
   if rawOS == "Windows" then
-    return commandValue("powershell.exe -NoProfile -NonInteractive -Command \"(Get-CimInstance Win32_ComputerSystem).Model\" 2>NUL")
+    return friendlyModel(commandValue("powershell.exe -NoProfile -NonInteractive -Command \"(Get-CimInstance Win32_ComputerSystem).Model\" 2>NUL"))
   end
   if rawOS == "Linux" then
-    return commandValue("cat /sys/devices/virtual/dmi/id/product_name 2>/dev/null")
-      or commandValue("cat /sys/devices/virtual/dmi/id/model 2>/dev/null")
+    return friendlyModel(commandValue("cat /sys/devices/virtual/dmi/id/product_name 2>/dev/null")
+      or commandValue("cat /sys/devices/virtual/dmi/id/model 2>/dev/null"))
   end
   if rawOS == "Android" then
-    return commandValue("getprop ro.product.model 2>/dev/null")
+    return friendlyModel(commandValue("getprop ro.product.model 2>/dev/null"))
   end
   return nil
 end
@@ -121,7 +198,7 @@ local function metadata(options, context)
   local window = love and love.window or {}
   local rawOS = clean(call(system.getOS))
   local model = deviceModel(rawOS, system)
-  local renderer, rendererVersion, _, rendererDevice = call(graphics.getRendererInfo)
+  local renderer, rendererVersion = call(graphics.getRendererInfo)
   local width, height = call(graphics.getDimensions)
   local pixelWidth, pixelHeight = call(graphics.getPixelDimensions)
   local modeWidth, modeHeight, flags = call(window.getMode)
@@ -134,11 +211,7 @@ local function metadata(options, context)
     if value then lines[#lines + 1] = "- " .. label .. ": " .. value end
   end
   add("Platform", formOS(rawOS))
-  local hardware = model
-  if rendererDevice and rendererDevice ~= model then
-    hardware = hardware and (hardware .. " (" .. rendererDevice .. ")") or rendererDevice
-  end
-  add("Device", hardware)
+  add("Device", model)
   local rendererDetails = clean(renderer)
   if rendererDetails and clean(rendererVersion) then
     rendererDetails = rendererDetails .. " " .. clean(rendererVersion)

src/import/LauncherSettings.lua

@@ -541,29 +541,6 @@ local function modRows(opts, mod)
   return rows
 end
 
-local function troubleshootingRows(opts, hooks)
-  return {
-    {
-      label = Strings("SAFE MODE"),
-      actionLabel = function()
-        return SaveData.isSafeMode(opts) and Strings("Turn off") or Strings("Turn on")
-      end,
-      action = function()
-        SaveData.setSafeMode(opts, not SaveData.isSafeMode(opts))
-        return true
-      end,
-    },
-    {
-      label = Strings("REPORT ISSUE"),
-      actionLabel = Strings("Report bug"),
-      action = function()
-        if hooks and hooks.reportIssue then hooks.reportIssue(opts) end
-        return false
-      end,
-    },
-  }
-end
-
 -- ------- Gen 2 (Gold)
 --
 -- Gold reads NONE of the rows above.  Its OPTION screen writes a different
@@ -744,10 +721,6 @@ function LauncherSettings.open(hooks, version)
       sections[#sections + 1] = { title = mod.name, rows = rows }
     end
   end
-  sections[#sections + 1] = {
-    title = Strings("TROUBLESHOOTING"),
-    rows = troubleshootingRows(opts, hooks),
-  }
   return {
     opts = opts,
     version = version,

src/import/LauncherView.lua

@@ -875,6 +875,35 @@ local function drawSyncGlyph(x, y, w, h, hot)
       byy + head)
     love.graphics.pop()
   end
+
+local function drawBugGlyph(x, y, w, h, hot)
+  local box = math.min(w, h)
+  local bx = x + (w - box) / 2
+  local by = y + (h - box) / 2
+  local ink = hot and PAL.inverse or PAL.ink
+  local bodyW = box * 0.28
+  local bodyH = box * 0.46
+  local bodyX = bx + (box - bodyW) / 2
+  local bodyY = by + box * 0.30
+  local radius = math.max(1, box * 0.12)
+  Theme.fillRounded(bodyX, bodyY, bodyW, bodyH, ink, 1, radius)
+  Theme.fillRounded(bx + box * 0.38, by + box * 0.17,
+    box * 0.24, box * 0.24, ink, 1, box * 0.12)
+  love.graphics.push("all")
+  love.graphics.setColor(ink)
+  love.graphics.setLineWidth(math.max(1, box * 0.07))
+  love.graphics.setLineJoin("bevel")
+  for _, offset in ipairs({ 0.35, 0.50, 0.65 }) do
+    love.graphics.line(bodyX, by + box * offset,
+      bx + box * 0.12, by + box * (offset - 0.07))
+    love.graphics.line(bodyX + bodyW, by + box * offset,
+      bx + box * 0.88, by + box * (offset - 0.07))
+  end
+  love.graphics.line(bx + box * 0.44, by + box * 0.18,
+    bx + box * 0.30, by + box * 0.08)
+  love.graphics.line(bx + box * 0.56, by + box * 0.18,
+    bx + box * 0.70, by + box * 0.08)
+  love.graphics.pop()
 end
 
 local function drawCross(x, y, size, color)
@@ -926,10 +955,13 @@ local HEADER_TABS = {
   { id = "mods",   key = "tab-mods" },
   { id = "find",   key = "tab-find" },
   { id = "skins",  key = "tab-skins", glyph = true },
+  { id = "bug",    key = "tab-bug", glyph = true },
 }
 for _, t in ipairs(HEADER_TABS) do
   t.opts = { face = "tab", font = "tab", color = t.color, letter = t.letter }
-  if t.glyph then t.opts.drawFn = drawSkinGlyph end
+  if t.glyph then
+    t.opts.drawFn = t.id == "bug" and drawBugGlyph or drawSkinGlyph
+  end
 end
 
 -- Which cartridge the dropdown is showing: the open game tab, else the last
@@ -1923,7 +1955,7 @@ local function buildModsPanel(imp, x, y, w, availH, m)
   -- notice line
   local noticeText, noticeCol
   if safeMode then
-    noticeText, noticeCol = "Safe mode is on. All mods are disabled. Turn it off in Settings to change mod toggles.", PAL.yellow
+    noticeText, noticeCol = "Safe mode is on. All mods are disabled. Turn it off in the Bug tab to change mod toggles.", PAL.yellow
   elseif imp.modNotice then
     noticeText = imp.modNotice.text
     noticeCol = imp.modNotice.ok and PAL.green or PAL.red
@@ -2322,6 +2354,69 @@ local function buildSkinsPanel(imp, x, y, w, availH, m)
   return cy + hintH - y
 end
 
+local function buildBugPanel(imp, x, y, w, availH, m)
+  local SaveData = require("src.core.SaveData")
+  local gap = m.gap
+  local pad = math.floor(16 * m.s)
+  local cy = y
+  local safeMode = imp:_safeModeEnabled()
+
+  Kit.text("button", Strings("Bug reports"), x, cy, PAL.heading)
+  cy = cy + Kit.textHeight("button") + gap
+
+  if imp.issueNotice then
+    cy = cy + Kit.textWrapped("small", imp.issueNotice.text, x, cy, w,
+      imp.issueNotice.ok and PAL.green or PAL.red, 2) + gap
+  end
+
+  local switchW = math.floor(92 * m.s)
+  local switchH = math.max(m.btnH, Kit.tapMin())
+  local detail = safeMode
+    and Strings("All mods are disabled and their toggles are locked until safe mode is turned off.")
+    or Strings("Temporarily disable every mod while you reproduce a bug.")
+  local textW = math.max(0, w - 2 * pad - switchW - gap)
+  local detailH = Kit.wrapHeight("small", detail, textW, 3)
+  local safeH = math.max(switchH, Kit.textHeight("small") + math.floor(4 * m.s) + detailH)
+    + 2 * pad
+  Kit.card(x, cy, w, safeH)
+  local textX = x + pad
+  local textY = cy + pad
+  Kit.text("small", Strings("Safe mode"), textX, textY, PAL.heading)
+  Kit.textWrapped("small", detail, textX,
+    textY + Kit.textHeight("small") + math.floor(4 * m.s), textW,
+    PAL.muted, 3)
+  local toggleX = x + w - pad - switchW
+  local toggleY = cy + math.floor((safeH - switchH) / 2)
+  local _, changed = Kit.toggle(toggleX, toggleY, switchW, switchH, safeMode,
+    "bug-safe-mode")
+  if changed then
+    queueAction(imp, "bug-safe-mode", function() imp:_toggleSafeMode() end)
+  end
+  cy = cy + safeH + gap
+
+  local reportLabel = Strings("Report a bug")
+  local reportW = math.min(w - 2 * pad,
+    Kit.textWidth("small", reportLabel) + math.floor(32 * m.s))
+  local reportDetail = Strings("Open GitHub with the bug form and the available system information filled in.")
+  local reportTextW = math.max(0, w - 2 * pad - reportW - gap)
+  local reportDetailH = Kit.wrapHeight("small", reportDetail, reportTextW, 3)
+  local reportH = math.max(m.btnH, Kit.textHeight("small") + math.floor(4 * m.s) + reportDetailH)
+    + 2 * pad
+  Kit.card(x, cy, w, reportH)
+  Kit.text("small", Strings("Report an issue"), textX, cy + pad, PAL.heading)
+  Kit.textWrapped("small", reportDetail, textX,
+    cy + pad + Kit.textHeight("small") + math.floor(4 * m.s), reportTextW,
+    PAL.muted, 3)
+  btn(imp, x + w - pad - reportW,
+    cy + math.floor((reportH - m.btnH) / 2), reportW, m.btnH,
+    "bug-report", reportLabel, {
+      kind = "accent", font = "small",
+      action = function()
+        imp:_ensureMods()
+        imp:_reportIssue(SaveData.loadOptions(), nil)
+      end })
+end
+
 local function buildFindPanel(imp, x, y, w, availH, m)
   imp:_ensureFind()
   imp:_ensureMods()
@@ -4822,6 +4917,8 @@ function LauncherView.draw(imp)
     contentH = buildFindPanel(imp, x, py, panelW, budgetH, m)
   elseif imp.tab == "skins" then
     contentH = buildSkinsPanel(imp, x, py, panelW, budgetH, m)
+  elseif imp.tab == "bug" then
+    contentH = buildBugPanel(imp, x, py, panelW, budgetH, m)
   else
     contentH = buildGamePanel(imp, x, py, panelW, availH, m, imp.tab, budgetH)
   end

src/import/RomImporter.lua

@@ -1266,6 +1266,7 @@ end
 function RomImporter:_applyLastVersionTab()
   local okLO, LO = pcall(require, "src.core.LaunchOptions")
   if okLO and LO.pendingTab then return end
+  if os.getenv("POKEPORT_LAUNCHER_TAB") then return end
   local okOpt, opts = pcall(function()
     return require("src.core.SaveData").loadOptions()
   end)
@@ -1337,7 +1338,7 @@ function RomImporter.new(onComplete, opts)
     -- player at least arrives on the tab they asked for (src/core/LaunchOptions).
     tab = (function()
       local okLO, LO = pcall(require, "src.core.LaunchOptions")
-      return (okLO and LO.pendingTab) or "red"
+      return (okLO and LO.pendingTab) or os.getenv("POKEPORT_LAUNCHER_TAB") or "red"
     end)(),
     logo = love.graphics.newImage("assets/logo/logo.png"),
     bcg = love.graphics.newImage("assets/logo/bcg.png"),
@@ -1364,7 +1365,8 @@ function RomImporter.new(onComplete, opts)
     -- in draw); modNotice is the last install/delete result { ok, text }.
     -- requiredImportNotice stays inside the imported-files modal so validation
     -- failures are visible beside the file picker that caused them.
-    mods = nil, modScroll = 0, modNotice = nil, requiredImportNotice = nil,
+    mods = nil, modScroll = 0, modNotice = nil, issueNotice = nil,
+    requiredImportNotice = nil,
     -- Which game the MODS panel is answering for (a GameVersion id, nil =
     -- every game).  Rows resolve their enable-state and their "runs here"
     -- verdict against it (src/mods/ModTargets.lua).
@@ -2755,7 +2757,7 @@ function RomImporter:resumeAfterOverlay()
 end
 
 function RomImporter:_cycleTab(delta)
-  local order = { "red", "blue", "yellow", "gold", "mods", "find", "skins" }
+  local order = { "red", "blue", "yellow", "gold", "mods", "find", "skins", "bug" }
   local idx = 1
   for i, id in ipairs(order) do
     if id == self.tab then idx = i; break end
@@ -3630,9 +3632,6 @@ function RomImporter:_openSettings()
   -- option block, and Gold's is not the flat Gen 1 one (#1100).
   local hooks = {}
   local version = self.tab
-  hooks.reportIssue = function(opts)
-    return self:_reportIssue(opts, version)
-  end
   if self.onEditTouchControls then
     local version = self.tab
     hooks.editTouchControls = function()
@@ -3655,7 +3654,6 @@ function RomImporter:_openSettings()
   end)
   if ok and model then
     self._settings = model
-    self._settingsSafeModeAtOpen = require("src.core.SaveData").isSafeMode(model.opts)
   end
 end
 
@@ -3670,22 +3668,36 @@ function RomImporter:_closeSettings()
   local model = self._settings
   if model then
     model.save()
-    local safeMode = require("src.core.SaveData").isSafeMode(model.opts)
-    if safeMode ~= self._settingsSafeModeAtOpen then
-      self.mods = nil
-      self.safeMode = safeMode
-      self._modSortCache = nil
-      self._modInfoFetch = nil
-    end
   end
   self._settings = nil
-  self._settingsSafeModeAtOpen = nil
+end
+
+function RomImporter:_safeModeEnabled()
+  if self.safeMode == nil then
+    local SaveData = require("src.core.SaveData")
+    self.safeMode = SaveData.isSafeMode(SaveData.loadOptions())
+  end
+  return self.safeMode == true
+end
+
+function RomImporter:_toggleSafeMode()
+  local SaveData = require("src.core.SaveData")
+  local options = SaveData.loadOptions()
+  local enabled = not SaveData.isSafeMode(options)
+  SaveData.setSafeMode(options, enabled)
+  SaveData.saveOptions(options)
+  self.safeMode = enabled
+  self.mods = nil
+  self._modSortCache = nil
+  self._modInfoFetch = nil
+  self.modNotice = nil
 end
 
 function RomImporter:_reportIssue(options, version)
+  self.issueNotice = nil
   local ok, IssueReport = pcall(require, "src.core.IssueReport")
   if not ok then
-    self.modNotice = { ok = false, text = "Could not prepare the issue report." }
+    self.issueNotice = { ok = false, text = "Could not prepare the issue report." }
     return false
   end
   local opened, url, reason = IssueReport.open(options, {
@@ -3693,11 +3705,11 @@ function RomImporter:_reportIssue(options, version)
     mods = self.mods,
   })
   if not opened then
-    self.modNotice = { ok = false, text = reason or "Could not open the issue report." }
+    self.issueNotice = { ok = false, text = reason or "Could not open the issue report." }
     return false
   end
   self._lastIssueReportURL = url
-  if reason then self.modNotice = { ok = true, text = reason } end
+  if reason then self.issueNotice = { ok = true, text = reason } end
   return true
 end
 
@@ -4180,7 +4192,7 @@ end
 -- Enabling an experimental mod arms a confirmation for that same game.
 function RomImporter:_toggleMod(id, confirmed, version)
   if self.safeMode then
-    self.modNotice = { ok = false, text = "Safe mode is active. Turn it off in Settings to change mods." }
+    self.modNotice = { ok = false, text = "Safe mode is active. Turn it off in the Bug tab to change mods." }
     return
   end
   local LauncherMods = require("src.mods.LauncherMods")
@@ -4224,7 +4236,7 @@ end
 -- recovery action, and Delete is the only destructive one on this panel.
 function RomImporter:_setAllMods(want, confirmed)
   if self.safeMode then
-    self.modNotice = { ok = false, text = "Safe mode is active. Turn it off in Settings to change mods." }
+    self.modNotice = { ok = false, text = "Safe mode is active. Turn it off in the Bug tab to change mods." }
     return
   end
   local LauncherMods = require("src.mods.LauncherMods")