eburk/epochcli
1
0
Fork 0
Code Pull Requests Packages Releases 4 Activity

remove native UI elements, update README

Browse Source
This commit is contained in:
Evan Burkey
2025-06-16 13:53:06 -07:00
parent 656109e935
commit 50526b78aa
5 changed files with 52 additions and 34 deletions
Download Patch File Download Diff File Expand all files Collapse all files

7
README.md
View File

@ -3,11 +3,11 @@
CLI tool for updating and launching [Project Epoch](https://www.project-epoch.net/) on Linux & macOS.
## 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 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, the [Kegworks Wineskin port](https://github.com/Kegworks-App/Kegworks) works great (tutorial coming in the future...)
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.
1. Download and extract the latest binary from the [releases](https://git.burkey.co/eburk/epochcli/releases) page. Due to using OS UI code, `epochcli` cannot be cross-compiled. I only provide release builds for the hardware I own (Linux amd64, macOS arm64). If you need a different platform, you will need to compile yourself. You can run `go install git.burkey.co/eburk/epochcli` to compile and install to your `$GOROOT`
1. Download and extract the latest binary from the [releases](https://git.burkey.co/eburk/epochcli/releases) page.
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. 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
@ -15,6 +15,7 @@ For macOS, the [Kegworks Wineskin port](https://github.com/Kegworks-App/Kegworks
```
> ./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
```