v2.0.1: fix Windows installer, move models to userData, installer model picker

Author: Kenshiin13

.github/workflows/release.yml

@@ -28,10 +28,6 @@ jobs:
         working-directory: electron
         run: npm ci --legacy-peer-deps
 
-      - name: Bundle whisper.cpp binary + base model
-        working-directory: electron
-        run: npm run setup:whisper
-
       - name: Build renderer + main
         working-directory: electron
         run: npm run build

electron/build-resources/installer.nsh

@@ -1,23 +1,96 @@
-; Custom NSIS uninstall hook — asks the user whether to keep downloaded
-; Whisper models. If they choose No, models are copied to %APPDATA%\Echo\
-; models-preserved\ before the installation directory is wiped; the app
-; restores them to the install dir on next launch.
+; Custom install + uninstall UI for Echo.
+;
+; Install: user picks which Whisper model the app should download on first
+; launch. The choice is written to %APPDATA%\Echo\install-choice.json and
+; consumed + deleted by the app on its first boot.
+;
+; Uninstall: user chooses whether to also wipe %APPDATA%\Echo\ (downloaded
+; whisper.cpp binary + models + saved settings) or keep it in place for a
+; future reinstall.
 
-!macro customUnInstall
-  ; Only prompt if there's at least one .bin model on disk
-  IfFileExists "$INSTDIR\resources\app.asar.unpacked\node_modules\nodejs-whisper\cpp\whisper.cpp\models\ggml-*.bin" 0 skip_model_prompt
+!include "nsDialogs.nsh"
+!include "LogicLib.nsh"
+
+; ─── Install-time model-choice page ─────────────────────────────────────────
+
+Var ModelChoice
+Var MC_Dialog
+Var MC_RbTiny
+Var MC_RbBase
+Var MC_RbSmall
+Var MC_RbMedium
+Var MC_RbLargeTurbo
+
+Function ModelChoicePage
+  !insertmacro MUI_HEADER_TEXT "Choose a Whisper model" "Echo downloads this model the first time it runs. You can switch or download others later from Settings."
+  nsDialogs::Create 1018
+  Pop $MC_Dialog
+  ${If} $MC_Dialog == error
+    Abort
+  ${EndIf}
+
+  ${NSD_CreateRadioButton} 0 0u 100% 12u "Tiny – 75 MB (fastest)"
+  Pop $MC_RbTiny
+  ${NSD_CreateRadioButton} 0 15u 100% 12u "Base – 142 MB (recommended)"
+  Pop $MC_RbBase
+  ${NSD_CreateRadioButton} 0 30u 100% 12u "Small – 488 MB (better accuracy)"
+  Pop $MC_RbSmall
+  ${NSD_CreateRadioButton} 0 45u 100% 12u "Medium – 1.5 GB (great accuracy)"
+  Pop $MC_RbMedium
+  ${NSD_CreateRadioButton} 0 60u 100% 12u "Large v3 Turbo – 1.6 GB (best accuracy)"
+  Pop $MC_RbLargeTurbo
+
+  ${NSD_Check} $MC_RbBase
+
+  nsDialogs::Show
+FunctionEnd
 
+Function ModelChoicePageLeave
+  ${NSD_GetState} $MC_RbTiny $0
+  ${If} $0 == ${BST_CHECKED}
+    StrCpy $ModelChoice "tiny"
+    Return
+  ${EndIf}
+  ${NSD_GetState} $MC_RbSmall $0
+  ${If} $0 == ${BST_CHECKED}
+    StrCpy $ModelChoice "small"
+    Return
+  ${EndIf}
+  ${NSD_GetState} $MC_RbMedium $0
+  ${If} $0 == ${BST_CHECKED}
+    StrCpy $ModelChoice "medium"
+    Return
+  ${EndIf}
+  ${NSD_GetState} $MC_RbLargeTurbo $0
+  ${If} $0 == ${BST_CHECKED}
+    StrCpy $ModelChoice "large-v3-turbo"
+    Return
+  ${EndIf}
+  ; Anything else → base
+  StrCpy $ModelChoice "base"
+FunctionEnd
+
+!macro customPageAfterChangeDir
+  Page custom ModelChoicePage ModelChoicePageLeave
+!macroend
+
+!macro customInstall
+  CreateDirectory "$APPDATA\Echo"
+  FileOpen $0 "$APPDATA\Echo\install-choice.json" w
+  FileWrite $0 '{"initialModelSize":"$ModelChoice"}'
+  FileClose $0
+!macroend
+
+; ─── Uninstall prompt ───────────────────────────────────────────────────────
+
+!macro customUnInstall
+  ; Default to "No" — keep models/settings unless the user explicitly opts in
+  ; to wiping them.
   MessageBox MB_YESNO|MB_ICONQUESTION \
-    "Remove downloaded Whisper models as well?$\r$\n$\r$\n\
-Choose No to keep them — they'll be restored automatically the next time you install Echo." \
-    /SD IDYES \
-    IDYES skip_model_prompt
-
-  ; User chose No — preserve the models outside the install dir
-  CreateDirectory "$APPDATA\Echo\models-preserved"
-  CopyFiles /SILENT \
-    "$INSTDIR\resources\app.asar.unpacked\node_modules\nodejs-whisper\cpp\whisper.cpp\models\*.bin" \
-    "$APPDATA\Echo\models-preserved\"
-
-  skip_model_prompt:
+    "Also delete Echo's downloaded models and saved settings?$\r$\n$\r$\n\
+Choose No to keep them for a future reinstall." \
+    /SD IDNO \
+    IDNO skip_appdata_wipe
+  RMDir /r "$APPDATA\Echo"
+  skip_appdata_wipe:
 !macroend

electron/electron-builder.config.js

@@ -19,13 +19,29 @@ module.exports = {
   files: [
     "dist/**",
     "!dist/renderer/**/*.map",
+    // electron-builder's default patterns are replaced when `files` is set
+    // explicitly, so spell out node_modules ourselves. Without this the asar
+    // ships with no runtime deps and the app crashes on launch with
+    // `Cannot find module 'electron-store'`.
+    "node_modules/**/*",
+    "package.json",
     "!node_modules/uiohook-napi/**",
+    // Trim dev noise without touching directories we need (avoid `*.cpp`
+    // because it matches `whisper.cpp/` as a path).
+    "!node_modules/**/*.{md,map,ts,tsx}",
+    "!node_modules/**/{test,tests,__tests__,example,examples,docs,.github}/**",
+    "!node_modules/**/{LICENSE,license,LICENCE,licence,CHANGELOG,changelog,README,readme}{,.md,.txt,.markdown}",
   ],
   asarUnpack: [
     "node_modules/nodejs-whisper/**",
     "node_modules/koffi/**",
     "node_modules/@nut-tree-fork/**",
   ],
+  // koffi ships pre-built Electron binaries — no native compilation needed.
+  // With npmRebuild left at its default (`true`) electron-builder's rebuild
+  // step mangles the dep tree on Windows, leaving electron-store and others
+  // out of the asar. This was the v2.0.0 regression.
+  npmRebuild: false,
   beforeBuild: async (context) => {
     // uiohook-napi is non-Windows only; scrub it before Electron's build step
     // so its MSVC-requiring gyp scripts don't even try to run.

electron/package.json

@@ -1,6 +1,6 @@
 {
   "name": "echo",
-  "version": "2.0.0",
+  "version": "2.0.1",
   "description": "Local push-to-talk voice-to-text for Windows",
   "main": "dist/main/main/index.js",
   "author": "Kenshiin13",
@@ -17,8 +17,7 @@
     "build:main": "tsc --project tsconfig.main.json",
     "dist": "npm run build && electron-builder --win",
     "dist:win": "npm run build && electron-builder --win",
-    "rebuild": "electron-builder install-app-deps",
-    "setup:whisper": "node scripts/setup-whisper.mjs"
+    "rebuild": "electron-builder install-app-deps"
   },
   "dependencies": {
     "@mantine/core": "^7.17.0",

electron/scripts/setup-whisper.mjs

@@ -62,6 +62,11 @@ async function main() {
   const config = new ConfigStore();
   const sysInfo = await getSystemInfo();
 
+  // The NSIS installer writes <userData>/install-choice.json with the
+  // user's chosen model size. Apply it to config on first launch, then
+  // delete the file so later runs don't reset the setting.
+  applyInstallChoice(config);
+
   // On first run, default the backend to whatever the hardware recommends
   if (config.isFirstRun() && sysInfo.recommendedBackend !== "cpu") {
     config.save({ ...config.get(), backend: sysInfo.recommendedBackend });
@@ -204,6 +209,23 @@ async function main() {
   log.info(`Echo started (v${app.getVersion()}, ${sysInfo.platform}, backend=${config.get().backend})`);
 }
 
+function applyInstallChoice(config: ConfigStore): void {
+  const choicePath = path.join(app.getPath("userData"), "install-choice.json");
+  if (!fs.existsSync(choicePath)) return;
+  try {
+    const raw = fs.readFileSync(choicePath, "utf8");
+    const parsed = JSON.parse(raw) as { initialModelSize?: string };
+    const validSizes = ["tiny", "base", "small", "medium", "large-v3-turbo"] as const;
+    if (parsed.initialModelSize && (validSizes as readonly string[]).includes(parsed.initialModelSize)) {
+      config.save({ ...config.get(), modelSize: parsed.initialModelSize as (typeof validSizes)[number] });
+      log.info(`Applied installer choice: modelSize=${parsed.initialModelSize}`);
+    }
+  } catch (err) {
+    log.error(`Failed to parse install-choice.json: ${err}`);
+  }
+  try { fs.unlinkSync(choicePath); } catch { /* non-fatal */ }
+}
+
 function mimeFor(filePath: string): string {
   const ext = path.extname(filePath).toLowerCase();
   switch (ext) {