Include bundled updater and config versioning

Bundle a standalone updater JAR into the client and add config/manifest-driven version handling. Build scripts (build.sh/build.ps1) now create Progressive-Java-Updater.jar and fold it into the client classes; CI stamps release versions from tag refs and pom version bumped to 1.7. ClientConfig now records and exposes a version label (writes/updates config.json, reads manifest), and GLRenderer shows a static version text instead of the old in‑client updater UI. ClientUpdater was refactored to extract/ensure the updater JAR beside the running client, consult the config.json manifest to avoid re-downloading identical releases, and launch the updater in a separate JVM with a reconstructed restart command. Added a new UpdateHelper class (GUI + CLI) that performs the actual replacement/restart logic when invoked by the updater JAR. Various run/build wrappers updated to require/expose the updater artifact and to report build outputs.

Author: gradwahl

.github/workflows/build-jar.yml

@@ -22,6 +22,13 @@ jobs:
           java-version: "17"
           cache: maven
 
+      # For tag builds, stamp the project version from the tag (v1.7 -> 1.7) so the jar's
+      # Implementation-Version matches the release. Without this the manifest keeps the
+      # hardcoded pom version and the updater re-downloads the same release forever.
+      - name: Set release version from tag
+        if: startsWith(github.ref, 'refs/tags/v')
+        run: mvn --batch-mode versions:set -DnewVersion="${GITHUB_REF_NAME#v}" -DgenerateBackupPoms=false
+
       - name: Build
         run: mvn --batch-mode clean package
 

build.ps1

@@ -44,21 +44,38 @@ Remove-Item target/classes/META-INF/*.SF -Force -ErrorAction SilentlyContinue
 Remove-Item target/classes/META-INF/*.DSA -Force -ErrorAction SilentlyContinue
 Remove-Item target/classes/META-INF/*.RSA -Force -ErrorAction SilentlyContinue
 
-$clientVersion = if ($env:CLIENT_VERSION) { $env:CLIENT_VERSION.TrimStart("v") } else { "1.6" }
+$clientVersion = if ($env:CLIENT_VERSION) { $env:CLIENT_VERSION.TrimStart("v") } else { "1.7" }
+@"
+{
+  "version": "$clientVersion",
+  "web_host": "localhost",
+  "web_port": 80,
+  "game_port": 43594
+}
+"@ | Set-Content -Encoding UTF8 target/config.json
 @"
 Manifest-Version: 1.0
 Implementation-Version: $clientVersion
 Build-Time: $((Get-Date).ToUniversalTime().ToString("yyyy-MM-ddTHH:mm:ssZ"))
 
 "@ | Set-Content -Encoding ascii target/manifest.mf
 
+# Build the updater jar first, then fold it into the client classes so it ships
+# *inside* the client jar. At runtime the client extracts it back beside itself.
+jar --create --file target/Progressive-Java-Updater.jar --main-class com.gradwahl.rs254.update.UpdateHelper -C target/classes com/gradwahl/rs254/update
+if ($LASTEXITCODE -ne 0) {
+    throw "updater jar failed with exit code $LASTEXITCODE"
+}
+Copy-Item target/Progressive-Java-Updater.jar target/classes/Progressive-Java-Updater.jar -Force
+
 jar --create --file target/Progressive-Java-Client.jar --main-class com.gradwahl.rs254.Main --manifest target/manifest.mf -C target/classes .
 if ($LASTEXITCODE -ne 0) {
     throw "jar failed with exit code $LASTEXITCODE. Close any running client and rebuild."
 }
 Remove-Item target/manifest.mf
 
 Write-Host "Build complete: target/Progressive-Java-Client.jar"
+Write-Host "Build complete: target/Progressive-Java-Updater.jar"
 
 # Wrap the JAR in a single .exe with the custom icon using Launch4j.
 $launch4jc = "C:\Program Files (x86)\Launch4j\launch4jc.exe"

build.sh

@@ -35,10 +35,26 @@ rm -f target/classes/META-INF/MANIFEST.MF
 rm -f target/classes/META-INF/*.SF target/classes/META-INF/*.DSA target/classes/META-INF/*.RSA
 
 BUILD_TIME="$(date -u +"%Y-%m-%dT%H:%M:%SZ")"
-CLIENT_VERSION="${CLIENT_VERSION:-1.6}"
+CLIENT_VERSION="${CLIENT_VERSION:-1.7}"
 CLIENT_VERSION="${CLIENT_VERSION#v}"
+cat > target/config.json <<EOF
+{
+  "version": "$CLIENT_VERSION",
+  "web_host": "localhost",
+  "web_port": 80,
+  "game_port": 43594
+}
+EOF
 printf 'Manifest-Version: 1.0\nImplementation-Version: %s\nBuild-Time: %s\n\n' "$CLIENT_VERSION" "$BUILD_TIME" > target/manifest.mf
 
+# Build the updater jar first, then fold it into the client classes so it ships
+# *inside* the client jar. At runtime the client extracts it back beside itself.
+jar --create --file target/Progressive-Java-Updater.jar \
+    --main-class com.gradwahl.rs254.update.UpdateHelper \
+    -C target/classes com/gradwahl/rs254/update
+
+cp target/Progressive-Java-Updater.jar target/classes/Progressive-Java-Updater.jar
+
 jar --create --file target/Progressive-Java-Client.jar \
     --main-class com.gradwahl.rs254.Main \
     --manifest target/manifest.mf \
@@ -47,4 +63,5 @@ jar --create --file target/Progressive-Java-Client.jar \
 rm target/manifest.mf
 
 echo "Build complete: target/Progressive-Java-Client.jar"
+echo "Build complete: target/Progressive-Java-Updater.jar"
 echo "Run with: ./run.sh"

pom.xml

@@ -5,7 +5,7 @@
 
     <groupId>com.gradwahl</groupId>
     <artifactId>Progressive-Java-Client</artifactId>
-    <version>1.6</version>
+    <version>1.7</version>
     <name>Progressive Java Client</name>
 
     <properties>

run.bat

@@ -4,6 +4,7 @@ cd /d "%~dp0"
 set "SCRIPT_DIR=%~dp0"
 set "SCRIPT_DIR=%SCRIPT_DIR:~0,-1%"
 if not exist target\Progressive-Java-Client.jar call build.bat
+if not exist target\Progressive-Java-Updater.jar call build.bat
 
 if not exist "%SCRIPT_DIR%\logs" mkdir "%SCRIPT_DIR%\logs"
 

run.sh

@@ -58,7 +58,7 @@ if [ "$MISSING" -eq 1 ]; then
     REBUILD=1
 fi
 
-if [ ! -f target/Progressive-Java-Client.jar ] || [ "$REBUILD" -eq 1 ]; then
+if [ ! -f target/Progressive-Java-Client.jar ] || [ ! -f target/Progressive-Java-Updater.jar ] || [ "$REBUILD" -eq 1 ]; then
     bash build.sh
 fi
 

src/main/java/com/gradwahl/rs254/ClientConfig.java

@@ -3,20 +3,25 @@
 import java.io.*;
 import java.nio.charset.StandardCharsets;
 import java.nio.file.Files;
+import java.util.jar.Attributes;
+import java.util.jar.Manifest;
 import java.util.regex.Matcher;
 import java.util.regex.Pattern;
 
-public record ClientConfig(String host, int httpPort, int gamePort, boolean secure, int revision, String cacheDir, String dbPath) {
+public record ClientConfig(String host, int httpPort, int gamePort, boolean secure, int revision,
+                           String cacheDir, String dbPath, String version) {
 
     private static final String CONFIG_FILE = "config.json";
 
     public static ClientConfig load() {
         File configFile = resolveConfigFile();
         boolean firstRun = !configFile.exists();
+        String version = currentVersionLabel();
 
         if (firstRun) {
             String defaultConfig =
                 "{\n" +
+                "  \"version\": \"" + escapeJson(version) + "\",\n" +
                 "  \"web_host\": \"localhost\",\n" +
                 "  \"web_port\": 80,\n" +
                 "  \"game_port\": 43594\n" +
@@ -30,11 +35,33 @@ public static ClientConfig load() {
             }
         } else {
             System.out.println("[Config] Loaded config from: " + configFile.getAbsolutePath());
+            updateVersionField(configFile, version);
         }
 
         return parseFile(configFile);
     }
 
+    public static String currentVersionLabel() {
+        try {
+            String version = ClientConfig.class.getPackage().getImplementationVersion();
+            if (version != null && !version.isBlank()) {
+                return version;
+            }
+            var manifestUrl = ClientConfig.class.getResource("/META-INF/MANIFEST.MF");
+            if (manifestUrl != null) {
+                try (InputStream in = manifestUrl.openStream()) {
+                    Attributes attrs = new Manifest(in).getMainAttributes();
+                    version = attrs.getValue("Implementation-Version");
+                    if (version != null && !version.isBlank()) {
+                        return version;
+                    }
+                }
+            }
+        } catch (Exception ignored) {
+        }
+        return "dev";
+    }
+
     private static File resolveConfigFile() {
         // Place config next to the JAR, falling back to the working directory
         try {
@@ -54,10 +81,12 @@ private static ClientConfig parseFile(File file) {
         int revision = 254;
         String cacheDir = "cache";
         String dbPath = "";
+        String version = currentVersionLabel();
 
         if (file.exists()) {
             try {
                 String json = Files.readString(file.toPath(), StandardCharsets.UTF_8);
+                version = readString(json, "version", version);
                 host = readString(json, "web_host", host);
                 httpPort = readInt(json, "web_port", httpPort);
                 gamePort = readInt(json, "game_port", gamePort);
@@ -76,7 +105,30 @@ private static ClientConfig parseFile(File file) {
         cacheDir = System.getProperty("rs254.cacheDir", cacheDir);
         dbPath = System.getProperty("rs254.dbPath", dbPath);
 
-        return new ClientConfig(host, httpPort, gamePort, secure, revision, cacheDir, dbPath);
+        return new ClientConfig(host, httpPort, gamePort, secure, revision, cacheDir, dbPath, version);
+    }
+
+    private static void updateVersionField(File file, String version) {
+        try {
+            String json = Files.readString(file.toPath(), StandardCharsets.UTF_8);
+            String escaped = escapeJson(version);
+            String updated;
+            if (Pattern.compile("\"version\"\\s*:").matcher(json).find()) {
+                updated = json.replaceFirst("\"version\"\\s*:\\s*\"((?:[^\\\\\"]|\\\\.)*)\"",
+                        "\"version\": \"" + Matcher.quoteReplacement(escaped) + "\"");
+            } else {
+                int objectStart = json.indexOf('{');
+                if (objectStart < 0) return;
+                updated = json.substring(0, objectStart + 1)
+                        + "\n  \"version\": \"" + escaped + "\","
+                        + json.substring(objectStart + 1);
+            }
+            if (!updated.equals(json)) {
+                Files.writeString(file.toPath(), updated, StandardCharsets.UTF_8);
+            }
+        } catch (IOException e) {
+            System.err.println("[Config] Warning: could not update version in " + file + ": " + e.getMessage());
+        }
     }
 
     private static String readString(String json, String key, String defaultValue) {
@@ -96,6 +148,10 @@ private static int readInt(String json, String key, int defaultValue) {
         return defaultValue;
     }
 
+    private static String escapeJson(String value) {
+        return value.replace("\\", "\\\\").replace("\"", "\\\"");
+    }
+
     /** @deprecated Use {@link #load()} instead. */
     @Deprecated
     public static ClientConfig fromSystemProperties() {

src/main/java/com/gradwahl/rs254/Main.java

@@ -17,6 +17,7 @@ public static void main(String[] args) throws Exception {
         setupErrorLogging();
         applyEarlyGraphicsProperties();
         relaunchJarWithOneGbHeapIfNeeded(args);
+        com.gradwahl.rs254.update.ClientUpdater.ensureUpdaterExtracted();
         ClientDebugger.enable();
 
         ClientConfig config = ClientConfig.load();

src/main/java/com/gradwahl/rs254/gl/GLRenderer.java

@@ -44,8 +44,8 @@
 import javax.swing.text.html.HTMLDocument;
 import javax.swing.text.html.HTMLEditorKit;
 
+import com.gradwahl.rs254.ClientConfig;
 import com.gradwahl.rs254.discord.DiscordRichPresence;
-import com.gradwahl.rs254.update.ClientUpdater;
 
 import static org.lwjgl.glfw.Callbacks.glfwFreeCallbacks;
 import static org.lwjgl.glfw.GLFW.*;
@@ -507,16 +507,7 @@ void main() {
     private boolean settingsFullscreen  = false;
     private boolean settingsAfkDropdownOpen;
     private int     settingsAfkIndex    = SETTINGS_PREFS.getInt("afkIndex", 0);
-    private enum UpdateButtonState { OUTDATED, CHECKING, READY, UPDATED, APPLYING }
-    private volatile UpdateButtonState updateButtonState = UpdateButtonState.OUTDATED;
-    private volatile String updateStatusText = "Current: " + ClientUpdater.currentVersionLabel();
-    private volatile ClientUpdater.UpdateInfo updateInfo;
-    private final java.util.concurrent.ExecutorService updateExecutor =
-            java.util.concurrent.Executors.newSingleThreadExecutor(r -> {
-                Thread t = new Thread(r, "client-updater");
-                t.setDaemon(true);
-                return t;
-            });
+    private final String clientVersionText = "Version: " + ClientConfig.currentVersionLabel();
 
     // XP session tracking — updated by Client when XP packets arrive
     public static final long[] xpSessionGains = new long[25];
@@ -896,7 +887,6 @@ public void destroy() {
         if (sidebarNativeDirect != null) MemoryUtil.memFree(sidebarNativeDirect);
         hiscoresFetcher.shutdownNow();
         DISCORD_RPC.disconnect();
-        updateExecutor.shutdownNow();
         glfwFreeCallbacks(window);
         glfwDestroyWindow(window);
         glfwTerminate();
@@ -2805,7 +2795,7 @@ private void drawSettingsPanel(int x) {
         y = drawSettingsToggleRow(x, y, "60 Fps Mode", sidebarFpsEnabled);
         y = drawSettingsToggleRow(x, y, "Fullscreen Mode", settingsFullscreen);
         y += 4;
-        drawUpdateButton(x, y);
+        drawClientVersionText(x, y);
     }
 
     private void loadSettings() {
@@ -2838,36 +2828,9 @@ private int drawSettingsToggleRow(int x, int y, String text, boolean enabled) {
         return y + 20;
     }
 
-    private void drawUpdateButton(int x, int y) {
+    private void drawClientVersionText(int x, int y) {
         int panelW = sidebarPanelW();
-        int buttonX = x + 16;
-        int buttonW = panelW - 32;
-        int color = updateButtonColor();
-        fillUiRect(buttonX, y, buttonW, 18, 0xFF202020);
-        fillUiRect(buttonX, y, buttonW, 1, color);
-        fillUiRect(buttonX, y + 17, buttonW, 1, 0xFF111111);
-        fillUiRect(buttonX, y, 1, 18, 0xFF4A4A4A);
-        fillUiRect(buttonX + buttonW - 1, y, 1, 18, 0xFF111111);
-        drawUiTextCentered(updateButtonText(), buttonX, y, buttonW, 18, 0, color);
-        drawUiTextFittedFull(updateStatusText, buttonX, y + 23, buttonW, 0, 0xFF999999);
-    }
-
-    private int updateButtonColor() {
-        return switch (updateButtonState) {
-            case READY, CHECKING, APPLYING -> 0xFF4AA3FF;
-            case UPDATED -> 0xFF43D36B;
-            case OUTDATED -> 0xFFE05252;
-        };
-    }
-
-    private String updateButtonText() {
-        return switch (updateButtonState) {
-            case CHECKING -> "CHECKING...";
-            case READY -> "READY TO UPDATE";
-            case UPDATED -> "UPDATED TO LATEST";
-            case APPLYING -> "APPLYING UPDATE...";
-            case OUTDATED -> "CHECK FOR UPDATES";
-        };
+        drawUiTextFittedFull(clientVersionText, x + 16, y + 5, panelW - 32, 0, 0xFF999999);
     }
 
     private void drawSelectBox(int x, int y, int w, String text, boolean open) {
@@ -3768,73 +3731,13 @@ private void clickSettingsPanel(int x, int y) {
         if (toggleHit(px, rowY, x, y)) { setFps60(!sidebarFpsEnabled); return; }
         rowY += 20;
         if (toggleHit(px, rowY, x, y)) { toggleFullscreen(); return; }
-        rowY += 24;
-        if (updateButtonHit(px, rowY, x, y)) clickUpdateButton();
     }
 
     private boolean toggleHit(int px, int rowY, int mouseX, int mouseY) {
         return mouseX >= px + 8 && mouseX < px + sidebarPanelW() - 8
                 && mouseY >= rowY && mouseY < rowY + 20;
     }
 
-    private boolean updateButtonHit(int px, int rowY, int mouseX, int mouseY) {
-        return mouseX >= px + 16 && mouseX < px + sidebarPanelW() - 16
-                && mouseY >= rowY && mouseY < rowY + 18;
-    }
-
-    private void clickUpdateButton() {
-        if (updateButtonState == UpdateButtonState.CHECKING
-                || updateButtonState == UpdateButtonState.APPLYING) {
-            return;
-        }
-        if (updateButtonState == UpdateButtonState.READY && updateInfo != null) {
-            applyUpdate();
-        } else {
-            checkForUpdates();
-        }
-    }
-
-    private void checkForUpdates() {
-        updateButtonState = UpdateButtonState.CHECKING;
-        updateStatusText = "Contacting GitHub releases...";
-        updateExecutor.execute(() -> {
-            try {
-                ClientUpdater.UpdateInfo latest = ClientUpdater.checkLatest();
-                updateInfo = latest;
-                if (latest.updateAvailable()) {
-                    updateButtonState = UpdateButtonState.READY;
-                    updateStatusText = "Latest: " + latest.tagName() + " (" + latest.assetName() + ")";
-                } else {
-                    updateButtonState = UpdateButtonState.UPDATED;
-                    updateStatusText = "Latest: " + latest.tagName();
-                }
-            } catch (Exception e) {
-                updateInfo = null;
-                updateButtonState = UpdateButtonState.OUTDATED;
-                updateStatusText = "Update check failed";
-                System.err.println("[Updater] Check failed: " + e);
-                e.printStackTrace(System.err);
-            }
-        });
-    }
-
-    private void applyUpdate() {
-        ClientUpdater.UpdateInfo info = updateInfo;
-        if (info == null) return;
-        updateButtonState = UpdateButtonState.APPLYING;
-        updateStatusText = "Downloading " + info.assetName();
-        updateExecutor.execute(() -> {
-            try {
-                ClientUpdater.apply(info);
-            } catch (Exception e) {
-                updateButtonState = UpdateButtonState.READY;
-                updateStatusText = "Update failed";
-                System.err.println("[Updater] Apply failed: " + e);
-                e.printStackTrace(System.err);
-            }
-        });
-    }
-
     private void setAfkIndex(int index) {
         settingsAfkIndex = Math.max(0, Math.min(AFK_LABELS.length - 1, index));
         afkTimeoutCycles = AFK_CYCLES[settingsAfkIndex];