dist: use CMD instead of PS script for potential Win7 compatibility

Author: caspervg

.github/workflows/build.yml

@@ -69,7 +69,7 @@ jobs:
           cp cmake-build-release-visual-studio-x64/src/app/Release/SC4PlopAndPaintCli.exe dist-package/_SC4PlopAndPaintCacheBuilder.exe
 
           cp dist/README.txt dist-package/
-          cp dist/RUN_CACHE_BUILDER.ps1 dist-package/
+          cp dist/RUN_CACHE_BUILDER.cmd dist-package/
           cp LICENSE.txt dist-package/
           cp dist/THIRD_PARTY_NOTICES.txt dist-package/
           cp dist/SC4PlopAndPaintInstaller.nsi dist-package/

README.md

@@ -24,18 +24,19 @@ Dependencies:
 - SC4RenderServices (required): GitHub project `https://github.com/caspervg/sc4-render-services`
 - SC4RenderServices download page: `https://community.simtropolis.com/files/file/37372-sc4-render-services/`
 - Visual C++ 2015-2022 Redistributable (x86, required for SimCity 4 / 32-bit): `https://aka.ms/vs/17/release/vc_redist.x86.exe`
-- Visual C++ 2015-2022 Redistributable (x64): `https://aka.ms/vs/17/release/vc_redist.x64.exe`
+- Visual C++ 2015-2022 Redistributable (x64, required for the cache builder): `https://aka.ms/vs/17/release/vc_redist.x64.exe`
+- The bundled cache builder is x64-only and requires 64-bit Windows.
 
 The installer will:
 
 1. Ask for your game root and Plugins directory.
 2. Verify that `SC4RenderServices.dll` is already present in your Plugins folder. If it is missing, the installer will stop and direct you to the SC4RenderServices download page.
 3. Place `SC4PlopAndPaint.dll` and `SC4PlopAndPaint.dat` in your Plugins folder.
 4. Let you choose the thumbnail size used for cache generation and apply the same size to `ThumbnailDisplaySize` in `SC4PlopAndPaint.ini`.
-5. Place `_SC4PlopAndPaintCacheBuilder.exe` and a generated `Rebuild-Cache.ps1` in `Documents\SimCity 4\SC4PlopAndPaint\`.
+5. Place `_SC4PlopAndPaintCacheBuilder.exe` and a generated `Rebuild-Cache.cmd` in `Documents\SimCity 4\SC4PlopAndPaint\`.
 6. Optionally run the cache builder immediately.
 
-To rebuild the cache later, for example after adding or removing plugins, run `Rebuild-Cache.ps1`.
+To rebuild the cache later, for example after adding or removing plugins, run `Rebuild-Cache.cmd`.
 
 If something looks wrong in game, check the separate services plugin's log output in `Documents\SimCity 4\`.
 

dist/README.txt

@@ -11,11 +11,12 @@ Installation instructions:
 - SC4RenderServices download page: https://community.simtropolis.com/files/file/37372-sc4-render-services/
 - Install the Microsoft Visual C++ 2015-2022 Redistributables:
 - x86 (required for SimCity 4 / 32-bit): https://aka.ms/vs/17/release/vc_redist.x86.exe
-- x64 (also installed): https://aka.ms/vs/17/release/vc_redist.x64.exe
+- x64 (required for the cache builder): https://aka.ms/vs/17/release/vc_redist.x64.exe
+- The bundled cache builder is x64-only and requires 64-bit Windows.
 - Run the included SC4 Plop and Paint installer.
 - The installer will ask for your SimCity 4 game root and Plugins folder, verify the SC4RenderServices dependency, and install the plugin files. If SC4RenderServices is missing, the installer will stop and tell you where to download it.
 - The installer also lets you choose the thumbnail size used for cache generation and sets the same size in SC4PlopAndPaint.ini for the in-game UI.
-- The installer can also run the cache builder for you. If you skip that step, run Rebuild-Cache.ps1 later from Documents\SimCity 4\SC4PlopAndPaint\.
+- The installer can also run the cache builder for you. If you skip that step, run Rebuild-Cache.cmd later from Documents\SimCity 4\SC4PlopAndPaint\.
 - The cache builder scans your game and Plugins folders and writes lots.cbor, props.cbor and flora.cbor into your Plugins folder.
 - If thumbnail rendering is enabled, it also writes lot_thumbnails.bin, prop_thumbnails.bin and flora_thumbnails.bin into your Plugins folder.
 

dist/RUN_CACHE_BUILDER.cmd

@@ -0,0 +1,71 @@
+@echo off
+setlocal EnableExtensions
+
+set "SCRIPT_DIR=%~dp0"
+set "EXE=%SCRIPT_DIR%_SC4PlopAndPaintCacheBuilder.exe"
+
+if not exist "%EXE%" (
+  echo Could not find "%EXE%"
+  echo Build the CLI first or update this path in RUN_CACHE_BUILDER.cmd.
+  pause
+  exit /b 1
+)
+
+if /I "%PROCESSOR_ARCHITECTURE%"=="x86" if not defined PROCESSOR_ARCHITEW6432 (
+  echo This cache builder requires 64-bit Windows.
+  pause
+  exit /b 1
+)
+
+echo === SC4 Plop and Paint Cache Builder ===
+echo.
+
+set "DO_SCAN="
+set /p "DO_SCAN=Run cache building scan now? (y/N): "
+if /I not "%DO_SCAN%"=="Y" (
+  echo.
+  echo Skipping scan.
+  pause
+  exit /b 0
+)
+
+echo.
+set "DEFAULT_GAME_ROOT=%ProgramFiles(x86)%\SimCity 4 Deluxe Edition"
+if not defined ProgramFiles(x86) set "DEFAULT_GAME_ROOT=%ProgramFiles%\SimCity 4 Deluxe Edition"
+set "DEFAULT_PLUGINS=%USERPROFILE%\Documents\SimCity 4\Plugins"
+set "DEFAULT_LOCALE=English"
+set "DEFAULT_THUMBNAIL_SIZE=44"
+
+set "GAME_ROOT="
+set "PLUGINS_DIR="
+set "LOCALE_DIR="
+set "RENDER_THUMBS="
+set "THUMBNAIL_SIZE="
+
+set /p "GAME_ROOT=Game root directory [default: %DEFAULT_GAME_ROOT%]: "
+if not defined GAME_ROOT set "GAME_ROOT=%DEFAULT_GAME_ROOT%"
+
+set /p "PLUGINS_DIR=User Plugins directory [default: %DEFAULT_PLUGINS%]: "
+if not defined PLUGINS_DIR set "PLUGINS_DIR=%DEFAULT_PLUGINS%"
+
+set /p "LOCALE_DIR=Locale under game root [default: %DEFAULT_LOCALE%]: "
+if not defined LOCALE_DIR set "LOCALE_DIR=%DEFAULT_LOCALE%"
+
+set /p "RENDER_THUMBS=Render 3D thumbnails? (y/N): "
+
+set /p "THUMBNAIL_SIZE=Thumbnail size in pixels (22-176) [default: %DEFAULT_THUMBNAIL_SIZE%]: "
+if not defined THUMBNAIL_SIZE set "THUMBNAIL_SIZE=%DEFAULT_THUMBNAIL_SIZE%"
+
+echo.
+echo Running:
+echo "%EXE%" --scan --game "%GAME_ROOT%" --plugins "%PLUGINS_DIR%" --locale "%LOCALE_DIR%" --thumbnail-size "%THUMBNAIL_SIZE%"
+if /I "%RENDER_THUMBS%"=="Y" echo   --render-thumbnails
+
+if /I "%RENDER_THUMBS%"=="Y" (
+  "%EXE%" --scan --game "%GAME_ROOT%" --plugins "%PLUGINS_DIR%" --locale "%LOCALE_DIR%" --thumbnail-size "%THUMBNAIL_SIZE%" --render-thumbnails
+) else (
+  "%EXE%" --scan --game "%GAME_ROOT%" --plugins "%PLUGINS_DIR%" --locale "%LOCALE_DIR%" --thumbnail-size "%THUMBNAIL_SIZE%"
+)
+
+echo.
+pause

dist/SC4PlopAndPaintInstaller.nsi

@@ -388,6 +388,12 @@ Function ConfigureCachePage
     ${NSD_Check} $HCacheBuildNow
   ${EndIf}
 
+  ${IfNot} ${RunningX64}
+    StrCpy $CacheBuildNow "0"
+    ${NSD_Uncheck} $HCacheBuildNow
+    ${NSD_CreateLabel} 0u 140u 100% 18u "Cache building is unavailable on this machine. The bundled cache builder requires 64-bit Windows."
+  ${EndIf}
+
   nsDialogs::Show
 FunctionEnd
 
@@ -428,6 +434,13 @@ Function ConfigureCachePageLeave
   ${Else}
     StrCpy $CacheBuildNow "0"
   ${EndIf}
+
+  ${If} $CacheBuildNow == "1"
+    ${IfNot} ${RunningX64}
+      MessageBox MB_OK|MB_ICONEXCLAMATION "Cache building is unavailable on this machine.$\r$\n$\r$\nThe bundled cache builder is 64-bit and requires a 64-bit version of Windows."
+      StrCpy $CacheBuildNow "0"
+    ${EndIf}
+  ${EndIf}
 FunctionEnd
 
 Function PopulateLocaleDropDown
@@ -526,52 +539,69 @@ Section "Install"
   WriteRegDWORD HKCU "${UNINSTALL_KEY}" "NoRepair" 1
 
   ; Generate a reusable cache rebuild script with the exact installation settings.
-  StrCpy $2 "$SC4ToolsDir\Rebuild-Cache.ps1"
+  Delete "$SC4ToolsDir\Rebuild-Cache.ps1"
+  StrCpy $2 "$SC4ToolsDir\Rebuild-Cache.cmd"
   FileOpen $3 $2 w
-  FileWrite $3 "# Auto-generated by ${APP_NAME} installer.$\r$\n"
-  FileWrite $3 "$$ErrorActionPreference = 'Stop'$\r$\n"
-  FileWrite $3 "$$exe = Join-Path $$PSScriptRoot '_SC4PlopAndPaintCacheBuilder.exe'$\r$\n"
-  FileWrite $3 "$$game = '$GameRoot'.TrimEnd('\')$\r$\n"
-  FileWrite $3 "$$plugins = '$SC4PluginsDir'.TrimEnd('\')$\r$\n"
-  FileWrite $3 "$$locale = '$CacheLocale'.TrimEnd('\')$\r$\n"
-  FileWrite $3 "$$thumbnailSize = '$CacheThumbnailSize'$\r$\n"
-  FileWrite $3 "$$cacheArgs = @('--scan', '--game', $$game, '--plugins', $$plugins, '--locale', $$locale, '--thumbnail-size', $$thumbnailSize)$\r$\n"
+  FileWrite $3 '@echo off$\r$\n'
+  FileWrite $3 'setlocal EnableExtensions$\r$\n'
+  FileWrite $3 'set "SCRIPT_DIR=%~dp0"$\r$\n'
+  FileWrite $3 'set "EXE=%SCRIPT_DIR%_SC4PlopAndPaintCacheBuilder.exe"$\r$\n'
+  FileWrite $3 'set "LOG_FILE=%SCRIPT_DIR%cache_build.log"$\r$\n'
+  FileWrite $3 'if not exist "%EXE%" ($\r$\n'
+  FileWrite $3 '  echo Could not find "%EXE%".$\r$\n'
+  FileWrite $3 '  exit /b 1$\r$\n'
+  FileWrite $3 ')$\r$\n'
+  FileWrite $3 'if /I "%PROCESSOR_ARCHITECTURE%"=="x86" if not defined PROCESSOR_ARCHITEW6432 ($\r$\n'
+  FileWrite $3 '  echo The bundled cache builder requires 64-bit Windows.$\r$\n'
+  FileWrite $3 '  echo This installation includes an x64-only cache builder executable.$\r$\n'
+  FileWrite $3 '  exit /b 1$\r$\n'
+  FileWrite $3 ')$\r$\n'
+  FileWrite $3 'echo Writing cache build log to "%LOG_FILE%".$\r$\n'
+  FileWrite $3 '> "%LOG_FILE%" echo SC4 Plop and Paint Cache Build Log$\r$\n'
+  FileWrite $3 '>> "%LOG_FILE%" echo Installer version: ${APP_VERSION}$\r$\n'
+  FileWrite $3 '>> "%LOG_FILE%" echo Game root: "$GameRoot"$\r$\n'
+  FileWrite $3 '>> "%LOG_FILE%" echo Plugins dir: "$SC4PluginsDir"$\r$\n'
+  FileWrite $3 '>> "%LOG_FILE%" echo Locale: "$CacheLocale"$\r$\n'
+  FileWrite $3 '>> "%LOG_FILE%" echo Render thumbnails: $CacheRenderThumbs$\r$\n'
+  FileWrite $3 '>> "%LOG_FILE%" echo Thumbnail size: $CacheThumbnailSize px$\r$\n'
+  FileWrite $3 '>> "%LOG_FILE%" echo Command: "%EXE%" --scan --game "$GameRoot" --plugins "$SC4PluginsDir" --locale "$CacheLocale" --thumbnail-size "$CacheThumbnailSize"'
+  ${If} $CacheRenderThumbs == "1"
+    FileWrite $3 ' --render-thumbnails'
+  ${EndIf}
+  FileWrite $3 '$\r$\n'
+  FileWrite $3 '>> "%LOG_FILE%" echo.$\r$\n'
+  FileWrite $3 '"%EXE%" --scan --game "$GameRoot" --plugins "$SC4PluginsDir" --locale "$CacheLocale" --thumbnail-size "$CacheThumbnailSize"'
   ${If} $CacheRenderThumbs == "1"
-    FileWrite $3 "$$cacheArgs += '--render-thumbnails'$\r$\n"
-  ${EndIf}
-  FileWrite $3 "$$logFile = Join-Path $$PSScriptRoot 'cache_build.log'$\r$\n"
-  FileWrite $3 "$$renderThumbs = '$CacheRenderThumbs'$\r$\n"
-  FileWrite $3 "$$header = @($\r$\n"
-  FileWrite $3 "  'SC4 Plop and Paint Cache Build Log',$\r$\n"
-  FileWrite $3 "  'Installer version: ${APP_VERSION}',$\r$\n"
-  FileWrite $3 "  ('Timestamp (local): ' + (Get-Date -Format 'yyyy-MM-dd HH:mm:ss zzz')),$\r$\n"
-  FileWrite $3 "  ('Game root: ' + $$game),$\r$\n"
-  FileWrite $3 "  ('Plugins dir: ' + $$plugins),$\r$\n"
-  FileWrite $3 "  ('Locale: ' + $$locale),$\r$\n"
-  FileWrite $3 "  ('Render thumbnails: ' + $$renderThumbs),$\r$\n"
-  FileWrite $3 "  ('Thumbnail size: ' + $$thumbnailSize + ' px'),$\r$\n"
-  FileWrite $3 "  ('Command: ' + $$exe + ' ' + ($$cacheArgs -join ' ')),$\r$\n"
-  FileWrite $3 "  ''$\r$\n"
-  FileWrite $3 ")$\r$\n"
-  FileWrite $3 "$$header | Set-Content -Path $$logFile -Encoding UTF8$\r$\n"
-  FileWrite $3 "$$header | ForEach-Object { Write-Host $$_ }$\r$\n"
-  FileWrite $3 "& $$exe @cacheArgs 2>&1 | ForEach-Object { $$line = [string]$$_; Write-Host $$line; Add-Content -Path $$logFile -Value $$line -Encoding UTF8 }$\r$\n"
-  FileWrite $3 "$$exitCode = $$LASTEXITCODE$\r$\n"
-  FileWrite $3 "$$exitLine = 'Exit code: ' + $$exitCode$\r$\n"
-  FileWrite $3 "Write-Host $$exitLine$\r$\n"
-  FileWrite $3 "Add-Content -Path $$logFile -Value $$exitLine -Encoding UTF8$\r$\n"
-  FileWrite $3 "exit $$exitCode$\r$\n"
+    FileWrite $3 ' --render-thumbnails'
+  ${EndIf}
+  FileWrite $3 ' >> "%LOG_FILE%" 2>&1$\r$\n'
+  FileWrite $3 'set "EXITCODE=%ERRORLEVEL%"$\r$\n'
+  FileWrite $3 '>> "%LOG_FILE%" echo Exit code: %EXITCODE%$\r$\n'
+  FileWrite $3 'if "%EXITCODE%"=="0" ($\r$\n'
+  FileWrite $3 '  echo Cache build completed successfully.$\r$\n'
+  FileWrite $3 ') else ($\r$\n'
+  FileWrite $3 '  echo Cache build failed with exit code %EXITCODE%.$\r$\n'
+  FileWrite $3 ')$\r$\n'
+  FileWrite $3 'echo See "%LOG_FILE%" for details.$\r$\n'
+  FileWrite $3 'exit /b %EXITCODE%$\r$\n'
   FileClose $3
 
   ${If} $CacheBuildNow == "1"
-    DetailPrint "Building SC4 Plop and Paint cache..."
-    DetailPrint "Using script: $SC4ToolsDir\Rebuild-Cache.ps1"
-    StrCpy $0 'powershell.exe -NoProfile -ExecutionPolicy Bypass -File "$SC4ToolsDir\Rebuild-Cache.ps1"'
-    nsExec::ExecToLog $0
-    Pop $1
-    ${If} $1 != "0"
-      MessageBox MB_ICONEXCLAMATION|MB_YESNO "Cache build failed (exit code: $1). Continue installation anyway?" IDYES +2
-      Abort
+    ${IfNot} ${RunningX64}
+      MessageBox MB_OK|MB_ICONEXCLAMATION "Cache build was skipped because the bundled cache builder requires 64-bit Windows.$\r$\n$\r$\nYou can still finish installing ${APP_NAME}, but you'll need to build the cache on a 64-bit machine and copy the generated files into your Plugins folder."
+    ${Else}
+      DetailPrint "Building SC4 Plop and Paint cache..."
+      DetailPrint "Manual rebuild script: $SC4ToolsDir\Rebuild-Cache.cmd"
+      StrCpy $0 '"$SC4ToolsDir\_SC4PlopAndPaintCacheBuilder.exe" --scan --game "$GameRoot" --plugins "$SC4PluginsDir" --locale "$CacheLocale" --thumbnail-size "$CacheThumbnailSize"'
+      ${If} $CacheRenderThumbs == "1"
+        StrCpy $0 '$0 --render-thumbnails'
+      ${EndIf}
+      nsExec::ExecToLog $0
+      Pop $1
+      ${If} $1 != "0"
+        MessageBox MB_ICONEXCLAMATION|MB_YESNO "Cache build failed (exit code: $1). Continue installation anyway?$\r$\n$\r$\nYou can retry later with Rebuild-Cache.cmd in $SC4ToolsDir." IDYES +2
+        Abort
+      ${EndIf}
     ${EndIf}
   ${EndIf}
 SectionEnd
@@ -615,6 +645,7 @@ Section "Uninstall"
   Delete "$SC4ToolsDir\_SC4PlopAndPaintCacheBuilder.exe"
   Delete "$SC4ToolsDir\LICENSE.txt"
   Delete "$SC4ToolsDir\THIRD_PARTY_NOTICES.txt"
+  Delete "$SC4ToolsDir\Rebuild-Cache.cmd"
   Delete "$SC4ToolsDir\Rebuild-Cache.ps1"
   Delete "$SC4ToolsDir\cache_build.log"
   Delete "$SC4ToolsDir\Uninstall-SC4PlopAndPaint.exe"