8 Commits
1.0.5 ... 1.0.8

Author SHA1 Message Date
f3e50a197f 1.0.8 2025-07-20 11:33:02 -07:00
89f954eec9 cleanup 2025-07-20 11:32:41 -07:00
d133ae6b29 remove unknown patches 2025-07-20 11:26:06 -07:00
882413fb1e 1.0.7 2025-07-12 05:51:33 -07:00
2cdeeef5b4 fix mac issues 2025-07-12 05:51:07 -07:00
afb8457489 fix spacing 2025-07-12 05:29:58 -07:00
2cb2208478 1.0.6 2025-07-10 15:39:03 -07:00
d21e48c1c9 fix launching 2025-07-10 15:38:22 -07:00
4 changed files with 142 additions and 36 deletions

View File

@ -5,12 +5,15 @@ CLI tool for updating and launching [Project Epoch](https://www.project-epoch.ne
## Installing ## Installing
### Linux ### 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. 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 from the macOS instructions 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 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 ### 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. I currently use a Parallels VM and run the Windows version of epochcli inside the VM as an updater and launcher. 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.
@ -35,6 +38,7 @@ Download and extract the latest binary from the [releases](https://git.burkey.co
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` 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 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 ## Usage
``` ```

View File

@ -1,6 +1,7 @@
package main package main
import ( import (
"bufio"
"fmt" "fmt"
"github.com/BurntSushi/toml" "github.com/BurntSushi/toml"
"os" "os"
@ -13,7 +14,9 @@ import (
type Config struct { type Config struct {
WowDir string WowDir string
LaunchCmd string LaunchCmd string
WinePrefix string
EnableLauncher bool EnableLauncher bool
RemoveUnknownPatches bool
} }
const ( const (
@ -21,7 +24,10 @@ const (
configName = "config.toml" configName = "config.toml"
) )
var cfgPath string var (
configRun = false
cfgPath string
)
func setupConfig(rerun bool) (*Config, error) { func setupConfig(rerun bool) (*Config, error) {
home, err := os.UserHomeDir() home, err := os.UserHomeDir()
@ -34,27 +40,31 @@ func setupConfig(rerun bool) (*Config, error) {
WowDir: defaultWowPath, WowDir: defaultWowPath,
LaunchCmd: defaultLaunchCmd, LaunchCmd: defaultLaunchCmd,
EnableLauncher: false, EnableLauncher: false,
RemoveUnknownPatches: true,
} }
_, statErr := os.Stat(cfgPath) _, statErr := os.Stat(cfgPath)
if rerun || os.IsNotExist(statErr) { if rerun || os.IsNotExist(statErr) {
configRun = true
fmt.Println("Enter the path to your Wow directory below. Use the full path without shortcuts like '~' (ex: /home/user/epoch):") fmt.Println("Enter the path to your Wow directory below. Use the full path without shortcuts like '~' (ex: /home/user/epoch):")
var s string s, err := readLine()
_, err = fmt.Scanln(&s)
if err != nil { if err != nil {
return nil, fmt.Errorf("unable to read input: %v", err) return nil, fmt.Errorf("unable to read input: %v", err)
} }
newConfig.WowDir = strings.TrimSpace(s) newConfig.WowDir = s
fmt.Println()
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): ")) 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): "))
if err != nil { if err != nil {
return nil, err return nil, err
} }
fmt.Println()
if p { 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) return nil, fmt.Errorf("unable to create desktop shortcut: %v", err)
@ -64,18 +74,22 @@ func setupConfig(rerun bool) (*Config, error) {
return nil, fmt.Errorf("unable to create desktop shortcut: %v", err) return nil, fmt.Errorf("unable to create desktop shortcut: %v", err)
} }
} else { } 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") s, err = input("Enter your wine prefix. Leave blank if you do not need to set WINEPREFIX")
fmt.Printf("> ")
_, err = fmt.Scanf("%s", &s)
if err != nil { if err != nil {
return nil, fmt.Errorf("unable to read input: %v", err) return nil, err
} }
s = strings.TrimSpace(s) fmt.Println()
if s != "" { newConfig.WinePrefix = s
newConfig.LaunchCmd = s newConfig.LaunchCmd = "wine " + newConfig.LaunchCmd
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)
} }
} }
@ -86,8 +100,30 @@ func setupConfig(rerun bool) (*Config, error) {
file, err := os.Create(cfgPath) file, err := os.Create(cfgPath)
if err != nil { if err != nil {
file.Close()
return nil, fmt.Errorf("unable to create config file: %v", err) return nil, fmt.Errorf("unable to create config file: %v", err)
} }
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.Printf("Created new config at %s\n\n", cfgPath)
}
_, err = toml.DecodeFile(cfgPath, &newConfig)
if err != nil {
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() defer file.Close()
encoder := toml.NewEncoder(file) encoder := toml.NewEncoder(file)
@ -95,26 +131,16 @@ func setupConfig(rerun bool) (*Config, error) {
return nil, fmt.Errorf("unable to encode config file: %v", err) return nil, fmt.Errorf("unable to encode config file: %v", err)
} }
fmt.Println("Created new config at ", cfgPath)
}
_, err = toml.DecodeFile(cfgPath, &newConfig)
if err != nil {
return nil, err
}
return &newConfig, nil return &newConfig, nil
} }
func promptYesNo(prompt string) (bool, error) { func promptYesNo(prompt string) (bool, error) {
var s string
for { for {
fmt.Print(prompt) fmt.Print(prompt)
_, err := fmt.Scanf("%s", &s) s, err := readLine()
if err != nil { if err != nil {
return false, fmt.Errorf("unable to read input: %v", err) return false, fmt.Errorf("unable to read input: %v", err)
} }
s := strings.TrimSpace(s)
if s == "y" || s == "Y" { if s == "y" || s == "Y" {
return true, nil return true, nil
@ -126,3 +152,23 @@ func promptYesNo(prompt string) (bool, error) {
fmt.Println("Please enter a valid value of either 'y' or 'n'") 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
}

78
main.go
View File

@ -6,12 +6,13 @@ import (
"flag" "flag"
"fmt" "fmt"
"io" "io"
"io/fs"
"log" "log"
"net/http" "net/http"
"os" "os"
"os/exec" "os/exec"
"path/filepath" "path/filepath"
"runtime" "regexp"
"strings" "strings"
) )
@ -28,7 +29,7 @@ func main() {
} }
if outOfDate { if outOfDate {
fmt.Println("There is a new version of epochcli, please update before running") fmt.Println("There is a new version of epochcli, you must update before running")
os.Exit(1) os.Exit(1)
} }
@ -65,9 +66,14 @@ func main() {
log.Fatal(err) 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 { if updateOnlyFlag {
@ -80,10 +86,19 @@ func main() {
} }
fmt.Println("Starting Epoch...") 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)
} }
} }
} }
@ -108,7 +123,10 @@ func downloadUpdate(config *Config, force bool) (DownloadStats, error) {
localPath := filepath.Join(config.WowDir, path) localPath := filepath.Join(config.WowDir, path)
localDir := filepath.Dir(localPath) localDir := filepath.Dir(localPath)
if _, err = os.Stat(localDir); os.IsNotExist(err) { if _, err = os.Stat(localDir); os.IsNotExist(err) {
os.MkdirAll(localDir, 0755) err = os.MkdirAll(localDir, 0755)
if err != nil {
return stats, fmt.Errorf("failed to create directory %s: %v", localDir, err)
}
} }
if !force { if !force {
@ -127,34 +145,72 @@ func downloadUpdate(config *Config, force bool) (DownloadStats, error) {
} }
} }
fmt.Printf(" %s...\n", localPath) fmt.Printf("Updating %s...\n", localPath)
outFile, err := os.Create(localPath) outFile, err := os.Create(localPath)
if err != nil { if err != nil {
return stats, err return stats, err
} }
defer outFile.Close()
for _, url := range []string{file.Urls.Cloudflare, file.Urls.Digitalocean, file.Urls.None} { for _, url := range []string{file.Urls.Cloudflare, file.Urls.Digitalocean, file.Urls.None} {
resp, err := http.Get(url) resp, err := http.Get(url)
if err != nil { if err != nil {
outFile.Close()
return stats, err return stats, err
} }
defer resp.Body.Close() defer resp.Body.Close()
if resp.StatusCode != http.StatusOK { if resp.StatusCode != http.StatusOK {
outFile.Close()
return stats, fmt.Errorf("failed to download update from %s, status code: %d", url, resp.StatusCode) return stats, fmt.Errorf("failed to download update from %s, status code: %d", url, resp.StatusCode)
} }
_, err = io.Copy(outFile, resp.Body) _, err = io.Copy(outFile, resp.Body)
if err != nil { if err != nil {
outFile.Close()
return stats, err return stats, err
} }
break break
} }
outFile.Close()
stats.updated += 1 stats.updated += 1
} }
if config.RemoveUnknownPatches {
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(config.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 return stats, nil
} }

View File

@ -7,7 +7,7 @@ import (
"regexp" "regexp"
) )
const version = "1.0.5" const version = "1.0.8"
const versionUrl = "https://git.burkey.co/eburk/epochcli/raw/branch/master/version.go" const versionUrl = "https://git.burkey.co/eburk/epochcli/raw/branch/master/version.go"
func needUpdate() (bool, error) { func needUpdate() (bool, error) {