10 Commits
0.0.1 ... 0.0.2

Author SHA1 Message Date
3ee6b1dce1 upgraded config creation 2025-06-09 21:38:39 -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 218 additions and 71 deletions

4
.gitignore vendored
View File

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

View File

@ -1,17 +1,26 @@
# 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 Instructions
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, the [Kegworks Wineskin port](https://github.com/Kegworks-App/Kegworks) works great (tutorial coming in the future...)
2. Install `epoch-linux` by either
1. Download the latest binary from the [releases](https://git.burkey.co/eburk/epoch-linux/releases) page 1. Install `epochcli` by either
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` 1. Downloading 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 install git.burkey.co/eburk/epochcli` to install to your `$GOROOT`
3. Compile the source yourself 3. Compile the source yourself
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 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`
4. Run `epoch-linux` again. It will download the patch files from Epoch's servers to your Wow directory 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
5. Use your launcher or tool of choice to startup Epoch in `wine`
## Usage
```
> ./epochcli -h
-c Runs config configuration step. Overrides the config file
-h Print help
-u Ignore EnableLauncher setting in config and only runs an update. Does nothing if EnableLauncher is false
```
## Issues ## Issues

105
config.go Normal file
View File

@ -0,0 +1,105 @@
package main
import (
"errors"
"fmt"
"github.com/BurntSushi/toml"
"github.com/sqweek/dialog"
"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("Press any key to open a file window and select your wow directory")
var r rune
_, _ = fmt.Scanf("%c", &r)
var err error
newConfig.WowDir, err = dialog.Directory().Title("Select your wow directory").Browse()
if err != nil {
if errors.Is(err, dialog.ErrCancelled) {
return nil, fmt.Errorf("cancelled dialog box, exiting")
}
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
}

9
go.mod
View File

@ -1,5 +1,10 @@
module git.burkey.co/eburk/epoch-linux 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/sqweek/dialog v0.0.0-20240226140203-065105509627
)
require github.com/TheTitanrain/w32 v0.0.0-20180517000239-4f5cfb03fabf // 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/TheTitanrain/w32 v0.0.0-20180517000239-4f5cfb03fabf h1:FPsprx82rdrX2jiKyS17BH6IrTmUBYqZa/CXT4uvb+I=
github.com/TheTitanrain/w32 v0.0.0-20180517000239-4f5cfb03fabf/go.mod h1:peYoMncQljjNS6tZwI9WVyQB3qZS6u79/N3mBOcnd3I=
github.com/sqweek/dialog v0.0.0-20240226140203-065105509627 h1:2JL2wmHXWIAxDofCK+AdkFi1KEg3dgkefCsm7isADzQ=
github.com/sqweek/dialog v0.0.0-20240226140203-065105509627/go.mod h1:/qNPSY91qTz/8TgHEMioAUc6q7+3SOybeKczHMXFcXw=

113
main.go
View File

@ -3,79 +3,81 @@ 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 ( var (
config Config helpFlag bool
updateOnlyFlag bool
rerunConfig bool
) )
flag.BoolVar(&helpFlag, "h", false, "Print help")
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()
func setupConfig() { if helpFlag {
home := os.Getenv("HOME") flag.CommandLine.SetOutput(os.Stdout)
if home == "" { flag.PrintDefaults()
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)
} }
func downloadUpdate() (int, error) { updated, current, err := downloadUpdate(config)
var c int if err != nil {
log.Fatal(err)
}
fmt.Printf("Updated %d files\n", updated)
if current > 0 {
fmt.Printf("%d files are already up to date\n", 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(config *Config) (int, int, error) {
var updateCount, currentCount int
manifest, err := getManifest() manifest, err := getManifest()
if err != nil { if err != nil {
@ -95,11 +97,12 @@ func downloadUpdate() (int, error) {
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 updateCount, currentCount, 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 {
currentCount += 1
continue continue
} }
} }
@ -108,26 +111,26 @@ func downloadUpdate() (int, error) {
outFile, err := os.Create(localPath) outFile, err := os.Create(localPath)
if err != nil { if err != nil {
return c, err return updateCount, currentCount, 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 updateCount, currentCount, 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 updateCount, currentCount, 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 updateCount, currentCount, err
} }
c += 1 updateCount += 1
} }
return c, nil return updateCount, currentCount, nil
} }

19
release.sh Executable file
View File

@ -0,0 +1,19 @@
#!/usr/bin/env sh
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=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
rm -rf bin