21 Commits
0.0.3 ... 1.0.7

Author SHA1 Message Date
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
f916ba0059 fix version check 2025-07-07 11:32:38 -07:00
970d8c654f add version check 2025-07-07 11:02:07 -07:00
a5b3719d33 version preupdate 2025-07-07 10:29:23 -07:00
1200a1bfc2 updated to v2 api 2025-07-07 10:01:38 -07:00
af8a2dbd1e warning msg, readme 2025-07-04 10:24:23 -07:00
dd8282623e update README 2025-07-04 06:55:29 -07:00
a9367763f3 Merge pull request 'cleanup prompting' (#1) from cleanup into master
Reviewed-on: #1
2025-07-04 13:29:56 +00:00
7dd915b060 cleanup prompting 2025-07-04 06:10:25 -07:00
4e78277f99 Update README.md 2025-06-27 21:35:16 +00:00
ad97817e80 Update README.md 2025-06-27 21:05:46 +00:00
9a0606ce32 Update README.md 2025-06-27 21:04:45 +00:00
d4f841f8a0 update release script 2025-06-27 13:59:48 -07:00
134d70e29b update for 1.0 2025-06-27 10:59:02 -07:00
6199f0865e add windows support 2025-06-21 09:31:23 -07:00
a24eb6903f cleanup README 2025-06-16 14:16:59 -07:00
1fc00d83eb homebrew 2025-06-16 14:11:58 -07:00
12 changed files with 305 additions and 91 deletions

View File

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

View File

@ -1,15 +1,43 @@
# epochcli # 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.
## Installing
### 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 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. 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 ## 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`.
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. ![ss](ss.png)
1. Download and extract the latest binary from the [releases](https://git.burkey.co/eburk/epochcli/releases) page. 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. 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
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
## Usage ## Usage
``` ```
@ -22,4 +50,4 @@ For macOS, I've found the best way to run the client is in a Parallels Win 11 VM
## Issues ## 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

130
config.go
View File

@ -1,15 +1,20 @@
package main package main
import ( import (
"bufio"
"fmt" "fmt"
"github.com/BurntSushi/toml" "github.com/BurntSushi/toml"
"os" "os"
"path"
"path/filepath" "path/filepath"
"runtime"
"strings"
) )
type Config struct { type Config struct {
WowDir string WowDir string
LaunchCmd string LaunchCmd string
WinePrefix string
EnableLauncher bool EnableLauncher bool
} }
@ -18,13 +23,17 @@ 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 := os.Getenv("HOME") home, err := os.UserHomeDir()
if home == "" { if err != nil {
return nil, fmt.Errorf("$HOME environment variable not set") return nil, fmt.Errorf("unable to determine home directory: %v", err)
} }
cfgPath = filepath.Join(home, ".config", configDirName, configName)
newConfig := Config{ newConfig := Config{
WowDir: defaultWowPath, WowDir: defaultWowPath,
@ -32,65 +41,118 @@ func setupConfig(rerun bool) (*Config, error) {
EnableLauncher: false, EnableLauncher: false,
} }
cfgPath = filepath.Join(home, ".config", configDirName, configName)
_, statErr := os.Stat(cfgPath) _, statErr := os.Stat(cfgPath)
if rerun || os.IsNotExist(statErr) { if rerun || os.IsNotExist(statErr) {
fmt.Println("Enter the path to your Wow directory below:") configRun = true
_, err := fmt.Scanln(&newConfig.WowDir) fmt.Println("Enter the path to your Wow directory below. Use the full path without shortcuts like '~' (ex: /home/user/epoch):")
s, err := readLine()
if err != nil {
return nil, fmt.Errorf("unable to read input: %v", err)
}
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): "))
if err != nil { if err != nil {
return nil, err return nil, err
} }
fmt.Println()
for { if p {
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): ") newConfig.EnableLauncher = true
var s string newConfig.LaunchCmd = path.Join(newConfig.WowDir, "Project-Epoch.exe")
_, err := fmt.Scanf("%s", &s)
if err != nil {
return nil, err
}
if s == "y" || s == "Y" { if runtime.GOOS == "windows" {
newConfig.EnableLauncher = true exePath, err := os.Executable()
fmt.Println("Enter your launch command to start Wow below. If you would rather configure this later in the configuration file, just press Enter") if err != nil {
fmt.Printf("> ") return nil, fmt.Errorf("unable to create desktop shortcut: %v", err)
_, err = fmt.Scanf("%s", &s) }
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 { if err != nil {
return nil, err return nil, err
} }
if s != "" { fmt.Println()
newConfig.LaunchCmd = s
newConfig.WinePrefix = 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)
} }
break fmt.Printf("Modify the configuration file at %s if you need to customize it\n\n", cfgPath)
} }
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) 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) file, err := os.Create(cfgPath)
if err != nil { if err != nil {
return nil, err return nil, fmt.Errorf("unable to create config file: %v", err)
} }
defer file.Close() defer file.Close()
encoder := toml.NewEncoder(file) encoder := toml.NewEncoder(file)
if err = encoder.Encode(newConfig); err != nil { if err = encoder.Encode(newConfig); err != nil {
return nil, err return nil, fmt.Errorf("unable to encode config file: %v", err)
} }
fmt.Println("Created new config at ", cfgPath) fmt.Printf("Created new config at %s\n\n", cfgPath)
} }
_, err := toml.DecodeFile(cfgPath, &newConfig) _, err = toml.DecodeFile(cfgPath, &newConfig)
if err != nil { if err != nil {
return nil, err return nil, err
} }
return &newConfig, nil 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
}

8
config_unix.go Normal file
View File

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

36
config_windows.go Normal file
View File

@ -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
}

7
go.mod
View File

@ -2,4 +2,9 @@ module git.burkey.co/eburk/epochcli
go 1.24.3 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

4
go.sum
View File

@ -1,2 +1,6 @@
github.com/BurntSushi/toml v1.5.0 h1:W5quZX/G/csjUnuI8SUYlsHs9M38FC7znL0lIO+DvMg= 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/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=

81
main.go
View File

@ -11,17 +11,26 @@ import (
"os" "os"
"os/exec" "os/exec"
"path/filepath" "path/filepath"
"runtime"
"strings" "strings"
) )
const ( const (
manifestUrl = "https://updater.project-epoch.net/api/manifest" manifestUrl = "https://updater.project-epoch.net/api/v2/manifest"
defaultWowPath = "/path/to/wow" defaultWowPath = "/path/to/wow"
defaultLaunchCmd = "not configured" defaultLaunchCmd = "not configured"
) )
func main() { 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 ( var (
helpFlag bool helpFlag bool
updateOnlyFlag bool updateOnlyFlag bool
@ -36,6 +45,7 @@ func main() {
if helpFlag { if helpFlag {
flag.CommandLine.SetOutput(os.Stdout) flag.CommandLine.SetOutput(os.Stdout)
fmt.Println("Epochcli Help:")
flag.PrintDefaults() flag.PrintDefaults()
os.Exit(0) os.Exit(0)
} }
@ -54,9 +64,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 {
@ -69,11 +84,19 @@ func main() {
} }
fmt.Println("Starting Epoch...") fmt.Println("Starting Epoch...")
switch runtime.GOOS { var cmd = strings.Split(config.LaunchCmd, " ")
case "darwin": ex := exec.Command(cmd[0], cmd[1:]...)
exec.Command("open", config.LaunchCmd).Run() cmdStr := strings.Join(cmd, " ")
case "linux": if config.WinePrefix != "" {
exec.Command(config.LaunchCmd).Run() 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)
} }
} }
} }
@ -98,7 +121,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 {
@ -117,28 +143,35 @@ 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()
resp, err := http.Get(file.URL) for _, url := range []string{file.Urls.Cloudflare, file.Urls.Digitalocean, file.Urls.None} {
if err != nil { resp, err := http.Get(url)
return stats, err if err != nil {
} outFile.Close()
defer resp.Body.Close() return stats, err
if resp.StatusCode != http.StatusOK { }
return stats, fmt.Errorf("failed to download update from %s, status code: %d", file.URL, resp.StatusCode) defer resp.Body.Close()
} if resp.StatusCode != http.StatusOK {
outFile.Close()
_, err = io.Copy(outFile, resp.Body) return stats, fmt.Errorf("failed to download update from %s, status code: %d", url, resp.StatusCode)
if err != nil { }
return stats, err
_, err = io.Copy(outFile, resp.Body)
if err != nil {
outFile.Close()
return stats, err
}
break
} }
outFile.Close()
stats.updated += 1 stats.updated += 1
} }

View File

@ -11,13 +11,18 @@ type File struct {
Hash string `json:"Hash"` Hash string `json:"Hash"`
Size int `json:"Size"` Size int `json:"Size"`
Custom bool `json:"Custom"` 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 { 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) {

View File

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

BIN
ss.png Normal file

Binary file not shown.

After

Width:  |  Height:  |  Size: 87 KiB

36
version.go Normal file
View File

@ -0,0 +1,36 @@
package main
import (
"fmt"
"io"
"net/http"
"regexp"
)
const version = "1.0.7"
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
}