Uninstaller should remove `\_retail_\webui`

[francislavoie]

Apparently \_retail_\webui doesn't get wiped out when uninstalling, which can break the WC3 client, resulting in a W3Champions Ladder Error: You are not yet authorized on the W3Champions server. Try again in a few minutes. error message.

Just did a quick bit of research, I think this requires setting up an NSIS macro to wipe out that directory.

To do this, I think vue.config.js needs to be edited, add this after win: {:

    nsis: {
      include: "build/installer.nsh"
    }

And then a new file build/installer.nsh would have:

!macro customUnInstall
    RMDir /r "$PROGRAMFILES\Warcraft III\_retail_\webui"
!macro

See https://www.electron.build/nsis

[BogdanW3]

A version of this should be found for Mac as well

[francislavoie]

Looks like with a DMG installer (drag the app to install) there's no such thing as uninstallers. I think the app would be to have a self-uninstall built in, or some shell script users can run to clean up (but obviously a significant portion of the users aren't technical enough for that).

Switching to .pkg installation should allow for it though. ChatGPT explanation:

To use .pkg installers with electron-builder, you can configure the pkg target in your electron-builder configuration. This allows you to create a .pkg installer instead of the default .dmg. Here's how you can do it:


---

1. Modify electron-builder Configuration

In your package.json, update the build section to include the pkg target for macOS:

{
  "build": {
    "mac": {
      "target": "pkg",
      "category": "public.app-category.games"
    },
    "pkg": {
      "scripts": "build/pkg-scripts"
    }
  }
}

The mac.target specifies pkg as the build target.

The pkg.scripts property points to a directory where you can define custom installation and uninstallation scripts.



---

2. Create Custom Pre- and Post-Installation Scripts

Create the directory build/pkg-scripts (or your chosen path), and include the following scripts:

Pre-Installation Script (preinstall):

This script runs before the .pkg installs your app.

#!/bin/bash
echo "Running pre-install script..."
# Add any custom setup commands here

Post-Installation Script (postinstall):

This script runs after the .pkg installs your app. For example, you can set up additional directories or files.

#!/bin/bash
echo "Running post-install script..."
WEBUI_DIR="/Applications/Warcraft III/_retail_/webui"

if [ ! -d "$WEBUI_DIR" ]; then
    mkdir -p "$WEBUI_DIR"
    echo "Created $WEBUI_DIR"
fi

Post-Uninstallation Script (postuninstall):

This script is not directly supported by .pkg installers but can be achieved by including a cleanup script in your app bundle for users to run.


---

3. Set Script Permissions

Ensure your scripts are executable:

chmod +x build/pkg-scripts/preinstall
chmod +x build/pkg-scripts/postinstall


---

4. Build the .pkg

Run the electron-builder command to build the .pkg installer:

npm run electron-builder --mac --x64

If you’ve added a custom script in your package.json, you can also run:

npm run build:mac


---

5. Testing the .pkg

Install the .pkg on a macOS system.

Confirm that it installs your app to /Applications.

Verify that your pre- and post-install scripts are executed properly (e.g., by checking log output or directory creation).



---

Notes:

.pkg installers are signed and notarized by Apple for security. Ensure that your app is correctly signed using Developer ID certificates, and notarize the .pkg after building. Add the following to your build configuration:

"mac": {
  "hardenedRuntime": true,
  "entitlements": "build/entitlements.mac.plist",
  "entitlementsInherit": "build/entitlements.mac.plist",
  "identity": "Developer ID Application: Your Name (TeamID)"
}

To notarize the .pkg, use the electron-notarize library or manually submit it using xcrun altool.

.pkg installers are better for professional-grade software since they allow pre- and post-install scripting, unlike .dmg.

[BogdanW3]

I see in that response that not even the pkg supports running it automatically sadly

It might make sense to change how the error displays, to just display on the W3Champions frame

[BogdanW3]

Oh ye, to make matters worse, the War3 dir is not even too likely to be $programfiles/Warcraft III :/

[marcoabreu]

Could we just make that the index.html does a no-op if w3c is not installed/launched?

[BogdanW3]

We could, I might do that now

[MichaelDeitz]

@BogdanW3 Did you ever do the work for this? If not, is this something we still want?