homebrew

.gitignore

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

Formula/epochcli.rb

@@ -0,0 +1,18 @@
+class Epochcli < Formula
+  desc "Updater and Launcher for Epoch"
+  homepage "https://git.burkey.co/eburk/epochcli/src/branch/master"
+  url "https://git.burkey.co/eburk/epochcli/archive/0.0.2.tar.gz"
+  sha256 "192ae687256a33468e97c7116177b65fb42b42a66138f61f24b93b76f4048f1c"
+  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

@@ -2,22 +2,23 @@
 
 CLI tool for updating and launching [Project Epoch](https://www.project-epoch.net/) on Linux & macOS.
 
-## TODO
+## Setup
+For Linux, a `wine` prefix with `dxvk` installed is sufficient, or you can use something like Lutris or faugus-launcher without the launcher functionality in `epochcli`.
 
-- improve config generation
+For macOS, I've found the best way to run the client 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.
-- add ability to launch Epoch after an update
 
-## Instructions
+1. Download and extract the latest binary from the [releases](https://git.burkey.co/eburk/epochcli/releases) page. 
-For Linux, a `wine` prefix with `dxvk` installed works great, or you can use something like Lutris or Faugus-launcher
+2. 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`
+3. You can now use `epochcli` as just a standalone updater or also a launcher based on your configuration. You can always run `epochcli -c` to redo the configuration or edit the config file manually
 
-For macOS, the [Kegworks Wineskin port](https://github.com/Kegworks-App/Kegworks) works great
+## Usage
-
+```
-2. Install `epochcli` by either
+> ./epochcli -h
-   1. Download the latest binary from the [releases](https://git.burkey.co/eburk/epochcli/releases) page 
+  -c    Runs config configuration step. Overrides the config file
-   2. If you have the `go` toolchain installed, you can run `go install git.burkey.co/eburk/epochcli` to install to your `$GOROOT`
+  -f    Forces epochcli to update files even if they match the current version
-   3. Compile the source yourself
+  -h    Print help
-3. Run `epochcli` once. This will create a config file at `$HOME/.config/epochcli/config.toml`. Update the variables with the appropriate information
+  -u    Ignore EnableLauncher setting in config and only runs an update. Does nothing if EnableLauncher is false
-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
+```
 
 ## Issues
 

config.go

@@ -10,6 +10,7 @@ import (
 type Config struct {
 	WowDir         string
 	LaunchCmd      string
+	EnableLauncher bool
 }
 
 const (
@@ -19,7 +20,7 @@ const (
 
 var cfgPath string
 
-func setupConfig() (*Config, error) {
+func setupConfig(rerun bool) (*Config, error) {
 	home := os.Getenv("HOME")
 	if home == "" {
 		return nil, fmt.Errorf("$HOME environment variable not set")
@@ -28,11 +29,48 @@ func setupConfig() (*Config, error) {
 	newConfig := Config{
 		WowDir:         defaultWowPath,
 		LaunchCmd:      defaultLaunchCmd,
+		EnableLauncher: false,
 	}
 
 	cfgPath = filepath.Join(home, ".config", configDirName, configName)
 
-	if _, statErr := os.Stat(cfgPath); os.IsNotExist(statErr) {
+	_, statErr := os.Stat(cfgPath)
+	if rerun || os.IsNotExist(statErr) {
+		fmt.Println("Enter the path to your Wow directory below:")
+		_, err := fmt.Scanln(&newConfig.WowDir)
+		if err != nil {
+			return nil, err
+		}
+
+		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): ")
+			var s string
+			_, err := fmt.Scanf("%s", &s)
+			if err != nil {
+				return nil, err
+			}
+
+			if s == "y" || s == "Y" {
+				newConfig.EnableLauncher = true
+				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, err
+				}
+				if s != "" {
+					newConfig.LaunchCmd = s
+				}
+				break
+			}
+
+			if s == "n" || s == "N" {
+				break
+			}
+
+			fmt.Println("Please enter a valid value of either 'y' or 'n'")
+		}
+
 		os.MkdirAll(filepath.Join(home, ".config", configDirName), 0755)
 
 		file, err := os.Create(cfgPath)
@@ -46,8 +84,7 @@ func setupConfig() (*Config, error) {
 			return nil, err
 		}
 
-		fmt.Printf("Created new config at %s, edit it before running the launcher again\n", cfgPath)
+		fmt.Println("Created new config at ", cfgPath)
-		os.Exit(0)
 	}
 
 	_, err := toml.DecodeFile(cfgPath, &newConfig)

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,23 +50,26 @@ 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.EnableLauncher {
 		if config.LaunchCmd == defaultLaunchCmd {
 			log.Fatalf("LaunchCmd in %s is still the default setting, exiting\n", cfgPath)
 		}
 
-	fmt.Printf("Starting Epoch....\n", count)
+		fmt.Println("Starting Epoch...")
-
 		switch runtime.GOOS {
 		case "darwin":
 			exec.Command("open", config.LaunchCmd).Run()
@@ -69,9 +77,15 @@ func main() {
 			exec.Command(config.LaunchCmd).Run()
 		}
 	}
+}
 
-func downloadUpdate(config *Config) (int, error) {
+type DownloadStats struct {
-	var c int
+	updated int
+	current int
+}
+
+func downloadUpdate(config *Config, force bool) (DownloadStats, error) {
+	var stats DownloadStats
 
 	manifest, err := getManifest()
 	if err != nil {
@@ -88,42 +102,46 @@ func downloadUpdate(config *Config) (int, error) {
 			os.MkdirAll(localDir, 0755)
 		}
 
+		if !force {
 			if _, err = os.Stat(localPath); err == nil {
 				data, err := os.ReadFile(localPath)
 				if err != nil {
-				return c, err
+					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,8 +1,9 @@
-#!/usr/bin/env sh
+#!/usr/bin/env bash
 
 set -e
 
 rm -f ./*.tar.gz
+rm -rf bin
 
 mkdir bin
 
@@ -12,10 +13,10 @@ tar czvf epochcli-linux-amd64.tar.gz bin/epochcli-linux-amd64
 GOOS=linux GOARCH=arm64 go build -o bin/epochcli-linux-arm64
 tar czvf epochcli-linux-arm64.tar.gz bin/epochcli-linux-arm64
 
-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
 
+GOOS=darwin GOARCH=amd64 go build -o bin/epochcli-darwin-amd64
+tar czvf epochcli-darwin-amd64.tar.gz bin/epochcli-darwin-amd64
+
 rm -rf bin