1.0.9

Reviewed-on: #1

README.md

@@ -2,20 +2,21 @@
 
 CLI tool for updating and launching [Project Epoch](https://www.project-epoch.net/) on Windows, Linux and macOS.
 
-## Setup
+## Installing
-
-### 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.
 
 ### 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.
 
-Download and extract the latest binary from the [releases](https://git.burkey.co/eburk/epochcli/releases) page, build from source yourself, or use homebrew to install.
+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.
+
+If you are an Arch Linux (or derivative) user, you can use the provided [AUR package](https://aur.archlinux.org/packages/epochcli) to install
+
+A tutorial for the full setup of Epoch on Arch Linux [can be found here](https://burkey.co/posts/epoch-linux/)
 
 ### macOS
 
-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.
+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:
 
@@ -27,10 +28,17 @@ brew install --HEAD epochcli
 brew upgrade epochcli --fetch-HEAD
 ```
 
-## First Run
+### 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
+
+![ss](ss.png)
 
 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 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
+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
+3. By default, `epochcli` will delete any non-standard patches. This can be disabled by changing the configuration file's `RemoveUnknownPatches` value to `false`
 
 ## Usage
 ```
@@ -43,4 +51,4 @@ brew upgrade epochcli --fetch-HEAD
 
 ## 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

@@ -1,6 +1,7 @@
 package main
 
 import (
+	"bufio"
 	"fmt"
 	"github.com/BurntSushi/toml"
 	"os"
@@ -11,17 +12,24 @@ import (
 )
 
 type Config struct {
-	WowDir         string
+	WowDir               string
-	LaunchCmd      string
+	LaunchCmd            string
-	EnableLauncher bool
+	WinePrefix           string
+	EnableLauncher       bool
+	RemoveUnknownPatches bool
 }
 
 const (
-	configDirName = "epochcli"
+	configDirName    = "epochcli"
-	configName    = "config.toml"
+	configName       = "config.toml"
+	defaultWowPath   = "/path/to/wow"
+	defaultLaunchCmd = "not configured"
 )
 
-var cfgPath string
+var (
+	configRun = false
+	cfgPath   string
+)
 
 func setupConfig(rerun bool) (*Config, error) {
 	home, err := os.UserHomeDir()
@@ -31,67 +39,60 @@ func setupConfig(rerun bool) (*Config, error) {
 	cfgPath = filepath.Join(home, ".config", configDirName, configName)
 
 	newConfig := Config{
-		WowDir:         defaultWowPath,
+		WowDir:               defaultWowPath,
-		LaunchCmd:      defaultLaunchCmd,
+		LaunchCmd:            defaultLaunchCmd,
-		EnableLauncher: false,
+		EnableLauncher:       false,
+		RemoveUnknownPatches: true,
 	}
 
 	_, statErr := os.Stat(cfgPath)
 	if rerun || os.IsNotExist(statErr) {
-		fmt.Println("Enter the path to your Wow directory below:")
+		configRun = true
-		var s string
+		fmt.Println("Enter the path to your Wow directory below. Use the full path without shortcuts like '~' (ex: /home/user/epoch):")
-		_, err = fmt.Scanln(&s)
+		s, err := readLine()
 		if err != nil {
 			return nil, fmt.Errorf("unable to read input: %v", err)
 		}
-		newConfig.WowDir = strings.TrimSpace(s)
+		newConfig.WowDir = s
 
-		for {
+		fmt.Println()
-			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): ")
+		p, err := promptYesNo(fmt.Sprintf("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 {
-			if err != nil {
+			return nil, err
-				return nil, fmt.Errorf("unable to read input: %v", err)
+		}
-			}
+		fmt.Println()
-			s = strings.TrimSpace(s)
 
-			if s == "y" || s == "Y" {
+		if p {
-				newConfig.EnableLauncher = true
+			newConfig.EnableLauncher = true
+			newConfig.LaunchCmd = path.Join(newConfig.WowDir, "Project-Epoch.exe")
 
-				if runtime.GOOS == "windows" {
+			if runtime.GOOS == "windows" {
-					newConfig.LaunchCmd = path.Join(newConfig.WowDir, "Project-Epoch.exe")
+				exePath, err := os.Executable()
-					exePath, err := os.Executable()
+				if err != nil {
-					if err != nil {
+					return nil, fmt.Errorf("unable to create desktop shortcut: %v", err)
-						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
 				}
-			}
+				err = makeLink(exePath, path.Join(home, "Desktop", "Project-Epoch.lnk"))
+				if err != nil {
+					return nil, fmt.Errorf("unable to create desktop shortcut: %v", err)
+				}
+			} else {
+				s, err = input("Enter your wine prefix. Leave blank if you do not need to set WINEPREFIX")
+				if err != nil {
+					return nil, err
+				}
+				fmt.Println()
 
-			if s == "n" || s == "N" {
+				newConfig.WinePrefix = s
-				break
+				newConfig.LaunchCmd = "wine " + newConfig.LaunchCmd
-			}
 
-			fmt.Println("Please enter a valid value of either 'y' or 'n'")
+				fmt.Println("Your launch command has been set to the following:")
+				if s == "" {
+					fmt.Printf("wine %s\n", newConfig.LaunchCmd)
+				} else {
+					fmt.Printf("WINEPREFIX=%s %s\n", newConfig.WinePrefix, newConfig.LaunchCmd)
+				}
+				fmt.Printf("Modify the configuration file at %s if you need to customize it\n\n", cfgPath)
+			}
 		}
 
 		err = os.MkdirAll(filepath.Join(home, ".config", configDirName), 0755)
@@ -101,16 +102,18 @@ func setupConfig(rerun bool) (*Config, error) {
 
 		file, err := os.Create(cfgPath)
 		if err != nil {
+			file.Close()
 			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 {
+			file.Close()
 			return nil, fmt.Errorf("unable to encode config file: %v", err)
 		}
+		file.Close()
 
-		fmt.Println("Created new config at ", cfgPath)
+		fmt.Printf("Created new config at %s\n\n", cfgPath)
 	}
 
 	_, err = toml.DecodeFile(cfgPath, &newConfig)
@@ -118,5 +121,56 @@ func setupConfig(rerun bool) (*Config, error) {
 		return nil, err
 	}
 
+	// Rewrite config file with any new defaults
+	file, err := os.Create(cfgPath)
+	if err != nil {
+		return nil, fmt.Errorf("unable to config file: %v", err)
+	}
+	defer file.Close()
+
+	encoder := toml.NewEncoder(file)
+	if err = encoder.Encode(newConfig); err != nil {
+		return nil, fmt.Errorf("unable to encode config file: %v", err)
+	}
+
 	return &newConfig, nil
 }
+
+func promptYesNo(prompt string) (bool, error) {
+	for {
+		fmt.Print(prompt)
+		s, err := readLine()
+		if err != nil {
+			return false, fmt.Errorf("unable to read input: %v", err)
+		}
+
+		if s == "y" || s == "Y" {
+			return true, nil
+		}
+
+		if s == "n" || s == "N" {
+			return false, nil
+		}
+		fmt.Println("Please enter a valid value of either 'y' or 'n'")
+	}
+}
+
+func input(prompt string) (string, error) {
+	fmt.Println(prompt)
+	fmt.Printf("> ")
+
+	s, err := readLine()
+	if err != nil {
+		return "", fmt.Errorf("unable to read input: %v", err)
+	}
+	return s, nil
+}
+
+func readLine() (string, error) {
+	reader := bufio.NewReader(os.Stdin)
+	in, err := reader.ReadString('\n')
+	if err != nil {
+		return "", fmt.Errorf("unable to read input: %v", err)
+	}
+	return strings.TrimSpace(in), nil
+}

main.go

@@ -1,27 +1,26 @@
 package main
 
 import (
-	"crypto/md5"
-	"encoding/hex"
 	"flag"
 	"fmt"
-	"io"
+	"git.burkey.co/eburk/epochcli/pkg/epoch"
 	"log"
-	"net/http"
 	"os"
 	"os/exec"
-	"path/filepath"
-	"runtime"
 	"strings"
 )
 
-const (
-	manifestUrl      = "https://updater.project-epoch.net/api/manifest"
-	defaultWowPath   = "/path/to/wow"
-	defaultLaunchCmd = "not configured"
-)
-
 func main() {
+	outOfDate, err := needUpdate()
+	if err != nil {
+		log.Fatal(err)
+	}
+
+	if outOfDate {
+		fmt.Println("There is a new version of epochcli, you must update before running")
+		os.Exit(1)
+	}
+
 	var (
 		helpFlag       bool
 		updateOnlyFlag bool
@@ -50,14 +49,19 @@ func main() {
 		log.Fatalf("WowDir in %s is still the default setting, exiting", cfgPath)
 	}
 
-	stats, err := downloadUpdate(config, forceFlag)
+	stats, err := epoch.DownloadUpdate(config.WowDir, forceFlag, config.RemoveUnknownPatches)
 	if err != nil {
 		log.Fatal(err)
 	}
 
-	fmt.Printf("%d files updated\n", stats.updated)
+	fmt.Printf("%d files updated\n\n", stats.Updated)
-	if stats.current > 0 {
+	if stats.Current > 0 {
-		fmt.Printf("%d files are already up to date\n", stats.current)
+		fmt.Printf("%d files are already up to date\n\n", stats.Current)
+	}
+
+	if configRun {
+		fmt.Println("Configuration complete!")
+		os.Exit(0)
 	}
 
 	if updateOnlyFlag {
@@ -70,77 +74,19 @@ func main() {
 		}
 
 		fmt.Println("Starting Epoch...")
-		if runtime.GOOS == "darwin" {
+		var cmd = strings.Split(config.LaunchCmd, " ")
-			exec.Command("open", config.LaunchCmd).Run()
+		ex := exec.Command(cmd[0], cmd[1:]...)
-		} else {
+		cmdStr := strings.Join(cmd, " ")
-			exec.Command(config.LaunchCmd).Run()
+		if config.WinePrefix != "" {
+			prefix := fmt.Sprintf("WINEPREFIX=%s", config.WinePrefix)
+			newEnv := append(os.Environ(), prefix)
+			ex.Env = newEnv
+			cmdStr = prefix + " " + cmdStr
+		}
+		fmt.Println("Running command:", cmdStr)
+		err = ex.Run()
+		if err != nil {
+			log.Fatal(err)
 		}
 	}
 }
-
-type DownloadStats struct {
-	updated int
-	current int
-}
-
-func downloadUpdate(config *Config, force bool) (DownloadStats, error) {
-	var stats DownloadStats
-
-	manifest, err := getManifest()
-	if err != nil {
-		log.Fatalf("Failed to get manifest: %v\n", err)
-	}
-
-	for _, file := range manifest.Files {
-		path := strings.ReplaceAll(file.Path, `\`, `/`)
-		path = strings.TrimLeft(path, `\`)
-
-		localPath := filepath.Join(config.WowDir, path)
-		localDir := filepath.Dir(localPath)
-		if _, err = os.Stat(localDir); os.IsNotExist(err) {
-			os.MkdirAll(localDir, 0755)
-		}
-
-		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(" %s...\n", localPath)
-
-		outFile, err := os.Create(localPath)
-		if err != nil {
-			return stats, err
-		}
-		defer outFile.Close()
-
-		resp, err := http.Get(file.URL)
-		if err != nil {
-			return stats, err
-		}
-		defer resp.Body.Close()
-		if resp.StatusCode != http.StatusOK {
-			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 stats, err
-		}
-
-		stats.updated += 1
-	}
-
-	return stats, nil
-}

pkg/epoch/manifest.go

@@ -1,4 +1,4 @@
-package main
+package epoch
 
 import (
 	"encoding/json"
@@ -6,21 +6,30 @@ import (
 	"net/http"
 )
 
+const (
+	manifestUrl = "https://updater.project-epoch.net/api/v2/manifest"
+)
+
 type File struct {
 	Path   string `json:"Path"`
 	Hash   string `json:"Hash"`
 	Size   int    `json:"Size"`
 	Custom bool   `json:"Custom"`
-	URL    string `json:"URL"`
+	Urls   struct {
-	Origin string `json:"Origin"`
+		Digitalocean string `json:"digitalocean"`
+		Cloudflare   string `json:"cloudflare"`
+		None         string `json:"none"`
+	} `json:"Urls"`
 }
 
 type Manifest struct {
-	Version string `json:"Version"`
+	Version   string `json:"Version"`
-	Files   []File `json:"Files"`
+	UID       string `json:"Uid"`
+	Files     []File `json:"Files"`
+	CheckedAt string `json:"checked_at"`
 }
 
-func getManifest() (*Manifest, error) {
+func GetManifest() (*Manifest, error) {
 	resp, err := http.Get(manifestUrl)
 	if err != nil {
 		return nil, err

pkg/epoch/update.go

@@ -0,0 +1,127 @@
+package epoch
+
+import (
+	"crypto/md5"
+	"encoding/hex"
+	"fmt"
+	"io"
+	"io/fs"
+	"log"
+	"net/http"
+	"os"
+	"path/filepath"
+	"regexp"
+	"strings"
+)
+
+type DownloadStats struct {
+	Updated int
+	Current int
+}
+
+func DownloadUpdate(wowdir string, force bool, removeUnknown bool) (DownloadStats, error) {
+	var stats DownloadStats
+
+	manifest, err := GetManifest()
+	if err != nil {
+		log.Fatalf("Failed to get manifest: %v\n", err)
+	}
+
+	for _, file := range manifest.Files {
+		path := strings.ReplaceAll(file.Path, `\`, `/`)
+		path = strings.TrimLeft(path, `\`)
+
+		localPath := filepath.Join(wowdir, path)
+		localDir := filepath.Dir(localPath)
+		if _, err = os.Stat(localDir); os.IsNotExist(err) {
+			err = os.MkdirAll(localDir, 0755)
+			if err != nil {
+				return stats, fmt.Errorf("failed to create directory %s: %v", localDir, err)
+			}
+		}
+
+		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", localPath)
+
+		outFile, err := os.Create(localPath)
+		if err != nil {
+			return stats, err
+		}
+
+		for _, url := range []string{file.Urls.Cloudflare, file.Urls.Digitalocean, file.Urls.None} {
+			resp, err := http.Get(url)
+			if err != nil {
+				outFile.Close()
+				return stats, err
+			}
+			defer resp.Body.Close()
+			if resp.StatusCode != http.StatusOK {
+				outFile.Close()
+				return stats, fmt.Errorf("failed to download update from %s, status code: %d", url, resp.StatusCode)
+			}
+
+			_, err = io.Copy(outFile, resp.Body)
+			if err != nil {
+				outFile.Close()
+				return stats, err
+			}
+
+			break
+		}
+
+		outFile.Close()
+		stats.Updated += 1
+	}
+
+	if removeUnknown {
+		patches := make([]string, 0)
+		patchreg := regexp.MustCompile(`patch-[A-Za-z].MPQ`)
+
+		for _, file := range manifest.Files {
+			if patchreg.MatchString(file.Path) {
+				patches = append(patches, strings.Split(file.Path, "Data\\")[1])
+			}
+		}
+
+		err = filepath.WalkDir(filepath.Join(wowdir, "Data"), func(path string, d fs.DirEntry, err error) error {
+			if !d.IsDir() && patchreg.MatchString(d.Name()) {
+				del := true
+				for _, patch := range patches {
+					if patch == d.Name() {
+						del = false
+						break
+					}
+				}
+				if del {
+					err = os.Remove(path)
+					if err != nil {
+						return err
+					}
+					fmt.Println("Removed unknown patch", d.Name())
+				}
+			}
+			return nil
+		})
+
+		if err != nil {
+			log.Fatalf("failed to delete unknown patches: %s", err)
+		}
+	}
+
+	return stats, nil
+}

release.sh

@@ -3,20 +3,20 @@
 set -e
 
 rm -f ./*.tar.gz
-rm -rf bin
+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
+GOOS=linux GOARCH=arm64 go build -o epochcli
-tar czvf epochcli-linux-amd64.tar.gz bin/epochcli-linux-amd64
+tar czvf epochcli-linux-arm64.tar.gz epochcli
+rm ./epochcli
 
-GOOS=linux GOARCH=arm64 go build -o bin/epochcli-linux-arm64
+GOOS=windows GOARCH=amd64 go build -o epochcli.exe
-tar czvf epochcli-linux-arm64.tar.gz bin/epochcli-linux-arm64
+zip -j epochcli-windows-amd64.zip epochcli.exe
+rm ./epochcli.exe
 
-GOOS=windows GOARCH=amd64 go build -o bin/epochcli-windows-amd64
+GOOS=windows GOARCH=arm64 go build -o epochcli.exe
-zip epochcli-windows-amd64.zip bin/epochcli-windows-amd64
+zip -j epochcli-windows-arm64.zip epochcli.exe
-
+rm ./epochcli.exe
-GOOS=windows GOARCH=arm64 go build -o bin/epochcli-windows-arm64
-zip epochcli-windows-arm64.zip bin/epochcli-windows-arm64
-
-rm -rf bin

version.go

@@ -0,0 +1,36 @@
+package main
+
+import (
+	"fmt"
+	"io"
+	"net/http"
+	"regexp"
+)
+
+const version = "1.0.9"
+const versionUrl = "https://git.burkey.co/eburk/epochcli/raw/branch/master/version.go"
+
+func needUpdate() (bool, error) {
+	resp, err := http.Get(versionUrl)
+	if err != nil {
+		return false, fmt.Errorf("unable to get version file: %v", err)
+	}
+	defer resp.Body.Close()
+
+	if resp.StatusCode != http.StatusOK {
+		return false, fmt.Errorf("failed to download update, status code: %d", resp.StatusCode)
+	}
+
+	b, err := io.ReadAll(resp.Body)
+	if err != nil {
+		return false, fmt.Errorf("unable to read response body: %v", err)
+	}
+
+	re := regexp.MustCompile(`const version = "([\d.]+)"`)
+	ver := re.FindStringSubmatch(string(b))
+	if len(ver) < 2 || ver[1] == "" {
+		return false, fmt.Errorf("unable to find version in response")
+	}
+
+	return ver[1] != version, nil
+}