46 lines
2.0 KiB
Markdown
46 lines
2.0 KiB
Markdown
# epochcli
|
|
|
|
CLI tool for updating and launching [Project Epoch](https://www.project-epoch.net/) on Windows, Linux and macOS.
|
|
|
|
## Setup
|
|
|
|
### 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. Easiest method is to just use the folder with your wow install.
|
|
|
|
### 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 in the macOS instructions below
|
|
|
|
### macOS
|
|
|
|
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. Any suggestions would be welcome, see my contact information below.
|
|
|
|
You can easily install with homebrew or build from source yourself. 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
|
|
```
|
|
|
|
## First Run
|
|
|
|
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 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
|
|
```
|
|
> ./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
|
|
|
|
If you have any issues, [email me](mailto:evan@burkey.co) or ping `Battlehammer` on the Epoch discord |