Initial Windows packaging

Author: gcclinux

.github/workflows/windows-installer.yml

@@ -0,0 +1,49 @@
+name: Build Windows installer
+
+on:
+  push:
+    branches: [ main ]
+  workflow_dispatch:
+
+jobs:
+  build-installer:
+    runs-on: windows-latest
+    steps:
+      - name: Checkout repository
+        uses: actions/checkout@v4
+
+      - name: Set up JDK 21
+        uses: actions/setup-java@v4
+        with:
+          distribution: temurin
+          java-version: '21'
+
+      - name: Install WiX Toolset (Chocolatey)
+        shell: pwsh
+        run: |
+          choco install wixtoolset -y
+
+      - name: Allow PowerShell scripts
+        shell: pwsh
+        run: Set-ExecutionPolicy Bypass -Scope Process -Force
+
+      - name: Run packaging script (creates installer or app-image)
+        shell: pwsh
+        run: |
+          # Run jpackage script that builds jar and creates installer (requires WiX for exe)
+          .\packaging\jpackage.ps1
+
+      - name: Show produced files
+        shell: pwsh
+        run: |
+          Write-Host 'dist contents:'
+          Get-ChildItem -Recurse -Force dist || true
+
+      - name: Upload installer artifact
+        if: always()
+        uses: actions/upload-artifact@v4
+        with:
+          name: smalltextpad-windows-installers
+          path: |
+            dist/installer/**
+            dist/*-windows-appimage.zip

.gitignore

@@ -4,6 +4,7 @@
 # Build directories
 /bin/
 /out/
+/dist/
 /target/
 /build/
 /classes/

SmallTextPad.iml

@@ -0,0 +1,40 @@
+# Windows PowerShell packaging script for SmallTextPad
+$ErrorActionPreference = "Stop"
+
+# Run from the repository root
+Set-Location $PSScriptRoot
+
+# Clean previous build artifacts
+Write-Host "[package] Cleaning previous build artifacts..."
+Remove-Item -Recurse -Force bin, dist -ErrorAction SilentlyContinue
+New-Item -ItemType Directory -Path bin | Out-Null
+New-Item -ItemType Directory -Path dist | Out-Null
+
+# Compile Java sources
+Write-Host "[package] Compiling Java sources..."
+Get-ChildItem -Path src -Filter *.java -Recurse | Select-Object -ExpandProperty FullName | Set-Content sources.txt
+javac -d bin @(Get-Content sources.txt)
+
+# Copy resource files (.properties)
+Write-Host "[package] Copying resource files..."
+$propDest = "bin/wagemaker/co/uk/lang"
+if (-not (Test-Path $propDest)) { New-Item -ItemType Directory -Path $propDest -Force | Out-Null }
+Copy-Item -Path src/wagemaker/co/uk/lang/*.properties -Destination $propDest -Force
+
+# Copy images and other resources
+Write-Host "[package] Copying image resources..."
+# Copy the contents of res/ into bin root so resources are accessible as '/printer.png' etc.
+if (Test-Path res) {
+	Copy-Item -Path (Join-Path $PSScriptRoot 'res\*') -Destination (Join-Path $PSScriptRoot 'bin') -Recurse -Force
+}
+
+# Create JAR file
+Write-Host "[package] Creating JAR file..."
+$metaDest = "bin/META-INF"
+if (-not (Test-Path $metaDest)) { New-Item -ItemType Directory -Path $metaDest -Force | Out-Null }
+Copy-Item -Path src/META-INF/* -Destination $metaDest -Force
+$manifest = "bin/META-INF/MANIFEST.MF"
+$jarPath = "dist/SmallTextPad.jar"
+jar cfm $jarPath $manifest -C bin .
+
+Write-Host "[package] Packaging complete. JAR created at $jarPath"

package.ps1

@@ -0,0 +1,24 @@
+Windows packaging
+
+This repository contains `packaging/jpackage.ps1` which will produce either:
+
+- a Windows installer (EXE) if the WiX toolset is installed on the system, or
+- an app-image ZIP (no installer) if WiX is not available.
+
+Requirements (to build an EXE installer locally):
+- JDK 21+ with `jpackage` on PATH
+- WiX toolset (install via Chocolatey: `choco install wixtoolset -y` or download from https://wixtoolset.org)
+- PowerShell (run as Administrator for WiX installation)
+
+Build locally:
+
+1. From repo root run (PowerShell):
+
+   .\packaging\jpackage.ps1
+
+2. If WiX is installed the installer will be in `dist/installer/`.
+   Otherwise an app-image ZIP will be created at `dist/SmallTextPad-windows-appimage.zip`.
+
+CI:
+
+A GitHub Actions workflow `.github/workflows/windows-installer.yml` is provided to build the installer on a Windows runner and upload the produced artifacts.

packaging/package.sh package.shpackaging/package.sh renamed to package.sh

@@ -0,0 +1,109 @@
+# Create a Windows installer EXE using jpackage
+# Usage: .\jpackage.ps1
+# Requires a JDK 14+ with jpackage on PATH
+# Requires choco install wixtoolset -y
+
+$ErrorActionPreference = 'Stop'
+Set-Location $PSScriptRoot
+
+# Ensure jpackage exists
+$jp = Get-Command jpackage -ErrorAction SilentlyContinue
+if (-not $jp) { Write-Error 'jpackage not found on PATH. Please install a JDK with jpackage (JDK 14+).' ; exit 1 }
+
+# Build the jar first
+Write-Host '[jpackage] Building jar using package.ps1'
+try { & "$PSScriptRoot\..\package.ps1" } catch { Write-Error "package.ps1 failed: $_"; exit 1 }
+
+# Read metadata from Details.java
+$detailsFile = Join-Path $PSScriptRoot '..\src\wagemaker\co\uk\utility\Details.java'
+if (-not (Test-Path $detailsFile)) { Write-Error 'Details.java not found'; exit 1 }
+$content = Get-Content $detailsFile -Raw
+$version = ([regex]::Match($content, 'public\s+static\s+String\s+Version\s*=\s*"([^\"]+)"')).Groups[1].Value
+$appName = ([regex]::Match($content, 'public\s+static\s+String\s+Title\s*=\s*"([^\"]+)"')).Groups[1].Value
+$vendor = ([regex]::Match($content, 'public\s+static\s+String\s+Developer\s*=\s*"([^\"]+)"')).Groups[1].Value
+$homepage = ([regex]::Match($content, 'public\s+static\s+String\s+remoteLicense\s*=\s*"([^\"]+)"')).Groups[1].Value
+
+$jarPath = Join-Path $PSScriptRoot '..\dist\SmallTextPad.jar'
+if (-not (Test-Path $jarPath)) { Write-Error "Jar not found at $jarPath"; exit 1 }
+
+# Prefer packaging/SmallTextPad.ico
+$iconIco = Join-Path $PSScriptRoot 'SmallTextPad.ico'
+if (Test-Path $iconIco) { Write-Host "[jpackage] Using icon: $iconIco" } else { Write-Host '[jpackage] packaging/SmallTextPad.ico not found; continuing without custom icon' ; $iconIco = $null }
+
+# Destination folders
+$installerOut = Join-Path $PSScriptRoot '..\dist\installer'
+$appImageOut = Join-Path $PSScriptRoot '..\dist\appimage'
+if (-not (Test-Path $installerOut)) { New-Item -ItemType Directory -Path $installerOut | Out-Null }
+if (-not (Test-Path $appImageOut)) { New-Item -ItemType Directory -Path $appImageOut | Out-Null }
+
+# Detect WiX (needed for exe/msi packaging on Windows)
+$wixFound = $false
+foreach ($tool in @('candle.exe','light.exe','wix.exe')) {
+    if (Get-Command $tool -ErrorAction SilentlyContinue) { $wixFound = $true; break }
+}
+
+if ($wixFound) {
+    Write-Host '[jpackage] WiX toolset detected — creating Windows installer (exe)'
+    $pkgType = 'exe'
+} else {
+    Write-Host '[jpackage] WiX not detected — will create app-image (no installer). To produce an EXE installer install WiX and re-run this script.'
+    $pkgType = 'app-image'
+}
+
+# Build jpackage arguments depending on chosen type
+$inputDir = (Join-Path $PSScriptRoot '..\dist')
+$jpackageCmd = (Get-Command jpackage -ErrorAction SilentlyContinue).Source
+
+try {
+    if ($pkgType -eq 'exe') {
+        $jpackArgs = @(
+            '--type','exe',
+            '--input', $inputDir,
+            '--name', $appName,
+            '--main-jar','SmallTextPad.jar',
+            '--main-class','wagemaker.co.uk.main.Launcher',
+            '--app-version',$version,
+            '--vendor',$vendor,
+            '--dest',$installerOut,
+            '--win-menu','--win-shortcut'
+        )
+        if ($iconIco) { $jpackArgs += @('--icon',$iconIco) }
+        if ($homepage) { $jpackArgs += @('--copyright',$homepage) }
+        Write-Host "[jpackage] Running jpackage (installer)"
+        & $jpackageCmd @jpackArgs
+        Write-Host '[jpackage] Installer created. Contents of installer folder:'
+        Get-ChildItem -Path $installerOut -Recurse | Select-Object FullName
+    } else {
+        $jpackArgs = @(
+            '--type','app-image',
+            '--input', $inputDir,
+            '--name', $appName,
+            '--main-jar','SmallTextPad.jar',
+            '--main-class','wagemaker.co.uk.main.Launcher',
+            '--app-version',$version,
+            '--vendor',$vendor,
+            '--dest',$appImageOut
+        )
+        if ($iconIco) { $jpackArgs += @('--icon',$iconIco) }
+        if ($homepage) { $jpackArgs += @('--copyright',$homepage) }
+        Write-Host "[jpackage] Running jpackage (app-image)"
+        & $jpackageCmd @jpackArgs
+
+        # Zip the produced app-image for distribution
+        $producedFolder = Join-Path $appImageOut $appName
+        if (Test-Path $producedFolder) {
+            $zipPath = Join-Path (Join-Path $PSScriptRoot '..\dist') "$appName-windows-appimage.zip"
+            if (Test-Path $zipPath) { Remove-Item $zipPath -Force }
+            Write-Host "[jpackage] Zipping app-image to $zipPath"
+            Compress-Archive -Path (Join-Path $producedFolder '*') -DestinationPath $zipPath -Force
+            Write-Host "[jpackage] App-image zip created: $zipPath"
+        } else {
+            Write-Warning "Expected app-image folder not found: $producedFolder"
+        }
+    }
+} catch {
+    Write-Error "jpackage failed: $_"
+    exit 1
+}
+
+Write-Host '[jpackage] Packaging finished.'

packaging/README-windows.md

@@ -0,0 +1,33 @@
+# Quick test-run helper for SmallTextPad (Windows PowerShell)
+# Exits on any error
+$ErrorActionPreference = "Stop"
+
+# Run from the repository root
+Set-Location $PSScriptRoot
+
+# Ensure required tools exist
+if (-not (Get-Command javac -ErrorAction SilentlyContinue)) { Write-Error "javac not found in PATH"; exit 1 }
+if (-not (Get-Command java -ErrorAction SilentlyContinue)) { Write-Error "java not found in PATH"; exit 1 }
+
+Write-Host "[run] Deleting compiled class files under bin/"
+Get-ChildItem -Path bin -Filter *.class -Recurse | Remove-Item
+
+Write-Host "[run] Rebuilding sources.txt from src/"
+Get-ChildItem -Path src -Filter *.java -Recurse | Select-Object -ExpandProperty FullName | Set-Content sources.txt
+
+Write-Host "[run] Compiling Java sources to bin/"
+javac -d bin @(Get-Content sources.txt)
+
+Write-Host "[run] Copying resource files to bin/"
+# Ensure language properties are available in the classpath
+$propDest = "bin/wagemaker/co/uk/lang"
+if (-not (Test-Path $propDest)) { New-Item -ItemType Directory -Path $propDest -Force | Out-Null }
+Copy-Item -Path src/wagemaker/co/uk/lang/*.properties -Destination $propDest -Force
+
+# Copy image resources into bin root so getResource("/name.png") works
+if (Test-Path res) {
+	Copy-Item -Path (Join-Path $PSScriptRoot 'res\*') -Destination (Join-Path $PSScriptRoot 'bin') -Recurse -Force
+}
+
+Write-Host "[run] Launching SmallTextPad (this will run until you close the GUI)"
+java -cp bin wagemaker.co.uk.main.Launcher