15 Commits
0.0.1 ... 0.0.3

Author SHA1 Message Date
8149d07619 homebrew 2025-06-16 14:00:59 -07:00
50526b78aa remove native UI elements, update README 2025-06-16 13:53:06 -07:00
656109e935 wip update 2025-06-13 10:19:33 -07:00
a281948d0b homebrew 2025-06-13 10:03:49 -07:00
ec7e63ed16 Update README.md 2025-06-10 04:56:08 +00:00
72f7a1e163 upgraded config creation 2025-06-09 21:46:35 -07:00
bdf8067bdc reorder early exits 2025-06-07 10:06:20 -07:00
3fab12d6f5 Update README.md 2025-06-06 17:15:26 +00:00
013b8c479f add ability to launch epoch client 2025-06-05 16:48:50 -07:00
1a6af606ff readme 2025-06-05 12:20:12 -07:00
95d54ea91a macos 2025-06-05 12:18:20 -07:00
235fae8ec9 readme 2025-06-05 11:36:31 -07:00
027a8e073b error handling, release builds 2025-06-05 11:32:46 -07:00
58f3977707 Update README.md 2025-06-03 05:16:30 +00:00
203449fbf9 install 2025-06-02 14:22:23 -07:00
7 changed files with 240 additions and 80 deletions

5
.gitignore vendored
View File

@ -1,2 +1,5 @@
.idea .idea
epoch-linux bin/
epochcli-*
epochcli
*.tar.gz

18
Formula/epochcli.rb Normal file
View File

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

View File

@ -1,17 +1,24 @@
# epoch-linux # epochcli
Linux updater and launcher for [Project Epoch](https://www.project-epoch.net/) CLI tool for updating and launching [Project Epoch](https://www.project-epoch.net/) on Linux & macOS.
## Instructions ## 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`.
1. Set up a copy of WoW 3.3.5 in a wine prefix or launcher of your choice. Chromiecraft has a good torrent you can use for the 3.3.5 client 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.
2. Install `epoch-linux` by either
1. Download the latest binary from the [releases](https://git.burkey.co/eburk/epoch-linux/releases) page 1. Download and extract 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 get git.burkey.co/eburk/epoch-linux@latest` to install to your `$GOROOT` 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. Compile the source yourself 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
3. Run `epoch-linux` once. This will create a config file at `$HOME/.config/epoch-linux/config.toml`. Change the `WowDir` variable to your Wow game directory
4. Run `epoch-linux` again. It will download the patch files from Epoch's servers to your Wow directory ## Usage
5. Use your launcher or tool of choice to startup Epoch in `wine` ```
> ./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 ## Issues

96
config.go Normal file
View File

@ -0,0 +1,96 @@
package main
import (
"fmt"
"github.com/BurntSushi/toml"
"os"
"path/filepath"
)
type Config struct {
WowDir string
LaunchCmd string
EnableLauncher bool
}
const (
configDirName = "epochcli"
configName = "config.toml"
)
var cfgPath string
func setupConfig(rerun bool) (*Config, error) {
home := os.Getenv("HOME")
if home == "" {
return nil, fmt.Errorf("$HOME environment variable not set")
}
newConfig := Config{
WowDir: defaultWowPath,
LaunchCmd: defaultLaunchCmd,
EnableLauncher: false,
}
cfgPath = filepath.Join(home, ".config", configDirName, configName)
_, 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)
if err != nil {
return nil, err
}
defer file.Close()
encoder := toml.NewEncoder(file)
if err = encoder.Encode(newConfig); err != nil {
return nil, err
}
fmt.Println("Created new config at ", cfgPath)
}
_, err := toml.DecodeFile(cfgPath, &newConfig)
if err != nil {
return nil, err
}
return &newConfig, nil
}

2
go.mod
View File

@ -1,4 +1,4 @@
module git.burkey.co/eburk/epoch-linux module git.burkey.co/eburk/epochcli
go 1.24.3 go 1.24.3

130
main.go
View File

@ -3,79 +3,89 @@ package main
import ( import (
"crypto/md5" "crypto/md5"
"encoding/hex" "encoding/hex"
"flag"
"fmt" "fmt"
"github.com/BurntSushi/toml"
"io" "io"
"log" "log"
"net/http" "net/http"
"os" "os"
"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/manifest"
configDirName = "epoch-linux" defaultWowPath = "/path/to/wow"
configName = "config.toml" defaultLaunchCmd = "not configured"
) )
type Config struct { func main() {
WowDir string var (
} helpFlag bool
updateOnlyFlag bool
forceFlag bool
rerunConfig bool
)
flag.BoolVar(&helpFlag, "h", false, "Print help")
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()
var ( if helpFlag {
config Config flag.CommandLine.SetOutput(os.Stdout)
) fmt.Println("Epochcli Help:")
flag.PrintDefaults()
func setupConfig() {
home := os.Getenv("HOME")
if home == "" {
log.Fatal("$HOME environment variable not set")
}
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: "/path/to/wow",
}
file, err := os.Create(cfgPath)
if err != nil {
log.Fatal(err)
}
defer file.Close()
encoder := toml.NewEncoder(file)
if err = encoder.Encode(newConfig); err != nil {
log.Fatal(err)
}
fmt.Printf("Created new config at %s, edit it before running the launcher again\n", cfgPath)
os.Exit(0) os.Exit(0)
} }
_, err := toml.DecodeFile(cfgPath, &config) config, err := setupConfig(rerunConfig)
if err != nil {
log.Fatal(err)
}
}
func main() {
setupConfig()
count, err := downloadUpdate()
if err != nil { if err != nil {
log.Fatal(err) log.Fatal(err)
} }
fmt.Printf("Updated %d files\n", count) if config.WowDir == defaultWowPath {
log.Fatalf("WowDir in %s is still the default setting, exiting", cfgPath)
}
stats, err := downloadUpdate(config, forceFlag)
if err != nil {
log.Fatal(err)
}
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.Println("Starting Epoch...")
switch runtime.GOOS {
case "darwin":
exec.Command("open", config.LaunchCmd).Run()
case "linux":
exec.Command(config.LaunchCmd).Run()
}
}
} }
func downloadUpdate() (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() manifest, err := getManifest()
if err != nil { if err != nil {
@ -92,42 +102,46 @@ func downloadUpdate() (int, error) {
os.MkdirAll(localDir, 0755) os.MkdirAll(localDir, 0755)
} }
if !force {
if _, err = os.Stat(localPath); err == nil { if _, err = os.Stat(localPath); err == nil {
data, err := os.ReadFile(localPath) data, err := os.ReadFile(localPath)
if err != nil { if err != nil {
return c, err return stats, err
} }
hashBytes := md5.Sum(data) hashBytes := md5.Sum(data)
hash := hex.EncodeToString(hashBytes[:]) hash := hex.EncodeToString(hashBytes[:])
if hash == file.Hash { if hash == file.Hash {
fmt.Printf("File %s is up to date\n", localPath)
stats.current += 1
continue continue
} }
} }
}
fmt.Printf("Updating %s...\n", file.Path) fmt.Printf(" %s...\n", localPath)
outFile, err := os.Create(localPath) outFile, err := os.Create(localPath)
if err != nil { if err != nil {
return c, err return stats, err
} }
defer outFile.Close() defer outFile.Close()
resp, err := http.Get(file.URL) resp, err := http.Get(file.URL)
if err != nil { if err != nil {
return c, err return stats, err
} }
defer resp.Body.Close() defer resp.Body.Close()
if resp.StatusCode != http.StatusOK { 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) _, err = io.Copy(outFile, resp.Body)
if err != nil { if err != nil {
return c, err return stats, err
} }
c += 1 stats.updated += 1
} }
return c, nil return stats, nil
} }

22
release.sh Executable file
View File

@ -0,0 +1,22 @@
#!/usr/bin/env bash
set -e
rm -f ./*.tar.gz
rm -rf bin
mkdir bin
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 bin/epochcli-linux-arm64
tar czvf epochcli-linux-arm64.tar.gz bin/epochcli-linux-arm64
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