Update README.md

.gitignore

@@ -1,4 +1,5 @@
 .idea
 bin/
 epochcli-*
+epochcli
 *.tar.gz

Formula/epochcli.rb

@@ -0,0 +1,16 @@
+class Epochcli < Formula
+  desc "Updater and Launcher for Epoch"
+  homepage "https://git.burkey.co/eburk/epochcli/src/branch/master"
+  license "ISC"
+  head "https://git.burkey.co/eburk/epochcli.git", branch: "master"
+
+  depends_on "go" => :build
+
+  def install
+    system "go", "build", *std_go_args(ldflags: "-s -w")
+  end
+
+  test do
+    assert_match "Epochcli Help:", shell_output("#{bin}/epochcli -h")
+  end
+end

README.md

@@ -1,24 +1,46 @@
 # epochcli
 
-CLI tool for updating and launching [Project Epoch](https://www.project-epoch.net/) on Linux & macOS.
+CLI tool for updating and launching [Project Epoch](https://www.project-epoch.net/) on Windows, Linux and macOS.
 
-## TODO
+## Installing
 
-- improve config generation
-- add ability to launch Epoch after an update
+### Linux
+A `wine` prefix with `dxvk` installed is sufficient, or you can use something like Lutris or faugus-launcher and just use `epochcli` for updating.
 
-## Instructions
-For Linux, a `wine` prefix with `dxvk` installed works great, or you can use something like Lutris or Faugus-launcher
+Download and extract the latest binary from the [releases](https://git.burkey.co/eburk/epochcli/releases) page, build from source yourself, or use homebrew from the macOS instructions to install.
 
-For macOS, the [Kegworks Wineskin port](https://github.com/Kegworks-App/Kegworks) works great
+### macOS
 
-2. Install `epochcli` by either
-   1. Download the latest binary from the [releases](https://git.burkey.co/eburk/epochcli/releases) page 
-   2. If you have the `go` toolchain installed, you can run `go install git.burkey.co/eburk/epochcli` to install to your `$GOROOT`
-   3. Compile the source yourself
-3. Run `epochcli` once. This will create a config file at `$HOME/.config/epochcli/config.toml`. Update the variables with the appropriate information
-4. Run `epochcli` again. It will download the patch files from Epoch's servers to your Wow directory and start the game. You can also pass the -u switch to only update if you use a launcher like Lutris, etc
+For macOS, I've found the best way to run Wow is in a Parallels Win 11 VM. Kegworks, Codeweavers, etc crash when the game starts up and I have not found a good solution so far. Any suggestions would be welcome, see my contact information below. I currently use a Parallels VM and run the Windows version of epochcli inside the VM as an updater and launcher.
+
+You can easily install with homebrew or build from source yourself. I dont have time to setup codesigning right now so there are no binaries provided for macOS. For homebrew, do the following:
+
+```shell
+brew tap eburk/epochcli https://git.burkey.co/eburk/epochcli
+brew install --HEAD epochcli
+
+# To update
+brew upgrade epochcli --fetch-HEAD
+```
+
+### Windows
+
+Download and extract the latest binary from the [releases](https://git.burkey.co/eburk/epochcli/releases) page or build from source yourself, then copy `epochcli.exe` to a location of your choice. To make it easy, just use the same folder as your Wow game files.
+
+## Setup
+
+1. Run `epochcli`. You will be taken through a setup process that configures the program and creates a config file at `$HOME/.config/epochcli/config.toml`
+2. You can now use `epochcli` as a standalone updater, but it can also act as a launcher based on your configuration. You can always run `epochcli -c` to redo the configuration, or edit the config file manually
+
+## Usage
+```
+> ./epochcli -h
+  -c    Runs config configuration step. Overrides the config file
+  -f    Forces epochcli to update files even if they match the current version
+  -h    Print help
+  -u    Ignore EnableLauncher setting in config and only runs an update. Does nothing if EnableLauncher is false
+```
 
 ## Issues
 
-If you have any issues, [email me](mailto:evan@burkey.co) or ping `Battlehammer` on the Epoch discord
+If you have any issues, [email me](mailto:epochcli@burkey.co) or send a private message to `Battlehammer` on the Epoch discord

config.go

@@ -4,12 +4,16 @@ import (
 	"fmt"
 	"github.com/BurntSushi/toml"
 	"os"
+	"path"
 	"path/filepath"
+	"runtime"
+	"strings"
 )
 
 type Config struct {
-	WowDir    string
-	LaunchCmd string
+	WowDir         string
+	LaunchCmd      string
+	EnableLauncher bool
 }
 
 const (
@@ -19,38 +23,97 @@ const (
 
 var cfgPath string
 
-func setupConfig() (*Config, error) {
-	home := os.Getenv("HOME")
-	if home == "" {
-		return nil, fmt.Errorf("$HOME environment variable not set")
+func setupConfig(rerun bool) (*Config, error) {
+	home, err := os.UserHomeDir()
+	if err != nil {
+		return nil, fmt.Errorf("unable to determine home directory: %v", err)
 	}
-
-	newConfig := Config{
-		WowDir:    defaultWowPath,
-		LaunchCmd: defaultLaunchCmd,
-	}
-
 	cfgPath = filepath.Join(home, ".config", configDirName, configName)
 
-	if _, statErr := os.Stat(cfgPath); os.IsNotExist(statErr) {
-		os.MkdirAll(filepath.Join(home, ".config", configDirName), 0755)
+	newConfig := Config{
+		WowDir:         defaultWowPath,
+		LaunchCmd:      defaultLaunchCmd,
+		EnableLauncher: false,
+	}
+
+	_, statErr := os.Stat(cfgPath)
+	if rerun || os.IsNotExist(statErr) {
+		fmt.Println("Enter the path to your Wow directory below:")
+		var s string
+		_, err = fmt.Scanln(&s)
+		if err != nil {
+			return nil, fmt.Errorf("unable to read input: %v", err)
+		}
+		newConfig.WowDir = strings.TrimSpace(s)
+
+		for {
+			fmt.Printf("Do you want to use epochcli to launch Wow? Select No if you plan on using a launcher tool like Lutris (y/n): ")
+			_, err = fmt.Scanf("%s", &s)
+			if err != nil {
+				return nil, fmt.Errorf("unable to read input: %v", err)
+			}
+			s = strings.TrimSpace(s)
+
+			if s == "y" || s == "Y" {
+				newConfig.EnableLauncher = true
+
+				if runtime.GOOS == "windows" {
+					newConfig.LaunchCmd = path.Join(newConfig.WowDir, "Project-Epoch.exe")
+					exePath, err := os.Executable()
+					if err != nil {
+						fmt.Println("unable to create desktop shortcut: ", err)
+						break
+					}
+					err = makeLink(exePath, path.Join(home, "Desktop", "Project-Epoch.lnk"))
+					if err != nil {
+						fmt.Println("unable to create desktop shortcut: ", err)
+					}
+					break
+				} else {
+					fmt.Println("Enter your launch command to start Wow below. If you would rather configure this later in the configuration file, just press Enter")
+					fmt.Printf("> ")
+
+					_, err = fmt.Scanf("%s", &s)
+					if err != nil {
+						return nil, fmt.Errorf("unable to read input: %v", err)
+					}
+					s = strings.TrimSpace(s)
+
+					if s != "" {
+						newConfig.LaunchCmd = s
+					}
+
+					break
+				}
+			}
+
+			if s == "n" || s == "N" {
+				break
+			}
+
+			fmt.Println("Please enter a valid value of either 'y' or 'n'")
+		}
+
+		err = os.MkdirAll(filepath.Join(home, ".config", configDirName), 0755)
+		if err != nil {
+			return nil, fmt.Errorf("unable to create config directory: %v", err)
+		}
 
 		file, err := os.Create(cfgPath)
 		if err != nil {
-			return nil, err
+			return nil, fmt.Errorf("unable to create config file: %v", err)
 		}
 		defer file.Close()
 
 		encoder := toml.NewEncoder(file)
 		if err = encoder.Encode(newConfig); err != nil {
-			return nil, err
+			return nil, fmt.Errorf("unable to encode config file: %v", err)
 		}
 
-		fmt.Printf("Created new config at %s, edit it before running the launcher again\n", cfgPath)
-		os.Exit(0)
+		fmt.Println("Created new config at ", cfgPath)
 	}
 
-	_, err := toml.DecodeFile(cfgPath, &newConfig)
+	_, err = toml.DecodeFile(cfgPath, &newConfig)
 	if err != nil {
 		return nil, err
 	}

config_unix.go

@@ -0,0 +1,8 @@
+//go:build linux || darwin
+
+package main
+
+func makeLink(src, dst string) error {
+	// Noop on unix
+	return nil
+}

config_windows.go

@@ -0,0 +1,36 @@
+package main
+
+import (
+	"github.com/go-ole/go-ole"
+	"github.com/go-ole/go-ole/oleutil"
+	"runtime"
+)
+
+func makeLink(src, dst string) error {
+	runtime.LockOSThread()
+	defer runtime.UnlockOSThread()
+
+	err := ole.CoInitializeEx(0, ole.COINIT_APARTMENTTHREADED|ole.COINIT_SPEED_OVER_MEMORY)
+	if err != nil {
+		return err
+	}
+
+	oleShellObject, err := oleutil.CreateObject("WScript.Shell")
+	if err != nil {
+		return err
+	}
+	defer oleShellObject.Release()
+	wshell, err := oleShellObject.QueryInterface(ole.IID_IDispatch)
+	if err != nil {
+		return err
+	}
+	defer wshell.Release()
+	cs, err := oleutil.CallMethod(wshell, "CreateShortcut", dst)
+	if err != nil {
+		return err
+	}
+	idispatch := cs.ToIDispatch()
+	oleutil.PutProperty(idispatch, "TargetPath", src)
+	oleutil.CallMethod(idispatch, "Save")
+	return nil
+}

go.mod

@@ -2,4 +2,9 @@ module git.burkey.co/eburk/epochcli
 
 go 1.24.3
 
-require github.com/BurntSushi/toml v1.5.0
+require (
+	github.com/BurntSushi/toml v1.5.0
+	github.com/go-ole/go-ole v1.3.0
+)
+
+require golang.org/x/sys v0.1.0 // indirect

go.sum

@@ -1,2 +1,6 @@
 github.com/BurntSushi/toml v1.5.0 h1:W5quZX/G/csjUnuI8SUYlsHs9M38FC7znL0lIO+DvMg=
 github.com/BurntSushi/toml v1.5.0/go.mod h1:ukJfTF/6rtPPRCnwkur4qwRxa8vTRFBF0uk2lLoLwho=
+github.com/go-ole/go-ole v1.3.0 h1:Dt6ye7+vXGIKZ7Xtk4s6/xVdGDQynvom7xCFEdWr6uE=
+github.com/go-ole/go-ole v1.3.0/go.mod h1:5LS6F96DhAwUc7C+1HLexzMXY1xGRSryjyPPKW6zv78=
+golang.org/x/sys v0.1.0 h1:kunALQeHf1/185U1i0GOB/fy1IPRDDpuoOOqRReG57U=
+golang.org/x/sys v0.1.0/go.mod h1:oPkhp1MJrh7nUepCBck5+mAzfO9JrbApNNgaTdGDITg=

main.go

@@ -25,18 +25,23 @@ func main() {
 	var (
 		helpFlag       bool
 		updateOnlyFlag bool
+		forceFlag      bool
+		rerunConfig    bool
 	)
 	flag.BoolVar(&helpFlag, "h", false, "Print help")
-	flag.BoolVar(&updateOnlyFlag, "u", false, "Only update the client, do not launch")
+	flag.BoolVar(&forceFlag, "f", false, "Forces epochcli to update files even if they match the current version")
+	flag.BoolVar(&updateOnlyFlag, "u", false, "Ignore EnableLauncher setting in config and only runs an update. Does nothing if EnableLauncher is false")
+	flag.BoolVar(&rerunConfig, "c", false, "Runs config configuration step. Overrides the config file")
 	flag.Parse()
 
 	if helpFlag {
 		flag.CommandLine.SetOutput(os.Stdout)
+		fmt.Println("Epochcli Help:")
 		flag.PrintDefaults()
 		os.Exit(0)
 	}
 
-	config, err := setupConfig()
+	config, err := setupConfig(rerunConfig)
 	if err != nil {
 		log.Fatal(err)
 	}
@@ -45,33 +50,41 @@ func main() {
 		log.Fatalf("WowDir in %s is still the default setting, exiting", cfgPath)
 	}
 
-	count, err := downloadUpdate(config)
+	stats, err := downloadUpdate(config, forceFlag)
 	if err != nil {
 		log.Fatal(err)
 	}
 
-	fmt.Printf("Updated %d files\n", count)
+	fmt.Printf("%d files updated\n", stats.updated)
+	if stats.current > 0 {
+		fmt.Printf("%d files are already up to date\n", stats.current)
+	}
 
 	if updateOnlyFlag {
 		os.Exit(0)
 	}
 
-	if config.LaunchCmd == defaultLaunchCmd {
-		log.Fatalf("LaunchCmd in %s is still the default setting, exiting\n", cfgPath)
-	}
+	if config.EnableLauncher {
+		if config.LaunchCmd == defaultLaunchCmd {
+			log.Fatalf("LaunchCmd in %s is still the default setting, exiting\n", cfgPath)
+		}
 
-	fmt.Printf("Starting Epoch....\n", count)
-
-	switch runtime.GOOS {
-	case "darwin":
-		exec.Command("open", config.LaunchCmd).Run()
-	case "linux":
-		exec.Command(config.LaunchCmd).Run()
+		fmt.Println("Starting Epoch...")
+		if runtime.GOOS == "darwin" {
+			exec.Command("open", config.LaunchCmd).Run()
+		} else {
+			exec.Command(config.LaunchCmd).Run()
+		}
 	}
 }
 
-func downloadUpdate(config *Config) (int, error) {
-	var c int
+type DownloadStats struct {
+	updated int
+	current int
+}
+
+func downloadUpdate(config *Config, force bool) (DownloadStats, error) {
+	var stats DownloadStats
 
 	manifest, err := getManifest()
 	if err != nil {
@@ -88,42 +101,46 @@ func downloadUpdate(config *Config) (int, error) {
 			os.MkdirAll(localDir, 0755)
 		}
 
-		if _, err = os.Stat(localPath); err == nil {
-			data, err := os.ReadFile(localPath)
-			if err != nil {
-				return c, err
-			}
-			hashBytes := md5.Sum(data)
-			hash := hex.EncodeToString(hashBytes[:])
-			if hash == file.Hash {
-				continue
+		if !force {
+			if _, err = os.Stat(localPath); err == nil {
+				data, err := os.ReadFile(localPath)
+				if err != nil {
+					return stats, err
+				}
+				hashBytes := md5.Sum(data)
+				hash := hex.EncodeToString(hashBytes[:])
+				if hash == file.Hash {
+					fmt.Printf("File %s is up to date\n", localPath)
+					stats.current += 1
+					continue
+				}
 			}
 		}
 
-		fmt.Printf("Updating %s...\n", file.Path)
+		fmt.Printf(" %s...\n", localPath)
 
 		outFile, err := os.Create(localPath)
 		if err != nil {
-			return c, err
+			return stats, err
 		}
 		defer outFile.Close()
 
 		resp, err := http.Get(file.URL)
 		if err != nil {
-			return c, err
+			return stats, err
 		}
 		defer resp.Body.Close()
 		if resp.StatusCode != http.StatusOK {
-			return c, fmt.Errorf("failed to download update from %s, status code: %d", file.URL, resp.StatusCode)
+			return stats, fmt.Errorf("failed to download update from %s, status code: %d", file.URL, resp.StatusCode)
 		}
 
 		_, err = io.Copy(outFile, resp.Body)
 		if err != nil {
-			return c, err
+			return stats, err
 		}
 
-		c += 1
+		stats.updated += 1
 	}
 
-	return c, nil
+	return stats, nil
 }

release.sh

@@ -1,21 +1,22 @@
-#!/usr/bin/env sh
+#!/usr/bin/env bash
 
 set -e
 
 rm -f ./*.tar.gz
+rm -f ./*.zip
 
-mkdir bin
+GOOS=linux GOARCH=amd64 go build -o epochcli
+tar czvf epochcli-linux-amd64.tar.gz epochcli
+rm ./epochcli
 
-GOOS=linux GOARCH=amd64 go build -o bin/epochcli-linux-amd64
-tar czvf epochcli-linux-amd64.tar.gz bin/epochcli-linux-amd64
+GOOS=linux GOARCH=arm64 go build -o epochcli
+tar czvf epochcli-linux-arm64.tar.gz epochcli
+rm ./epochcli
 
-GOOS=linux GOARCH=arm64 go build -o bin/epochcli-linux-arm64
-tar czvf epochcli-linux-arm64.tar.gz bin/epochcli-linux-arm64
+GOOS=windows GOARCH=amd64 go build -o epochcli.exe
+zip -j epochcli-windows-amd64.zip epochcli.exe
+rm ./epochcli.exe
 
-GOOS=darwin GOARCH=amd64 go build -o bin/epochcli-darwin-amd64
-tar czvf epochcli-darwin-amd64.tar.gz bin/epochcli-darwin-amd64
-
-GOOS=darwin GOARCH=arm64 go build -o bin/epochcli-darwin-arm64
-tar czvf epochcli-darwin-arm64.tar.gz bin/epochcli-darwin-arm64
-
-rm -rf bin
+GOOS=windows GOARCH=arm64 go build -o epochcli.exe
+zip -j epochcli-windows-arm64.zip epochcli.exe
+rm ./epochcli.exe