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

Update README.md

Browse Source
This commit is contained in:
Evan Burkey
2025-06-27 21:04:45 +00:00
parent d4f841f8a0
commit 9a0606ce32
1 changed files with 9 additions and 9 deletions
Download Patch File Download Diff File Expand all files Collapse all files

18
README.md
View File

@ -2,16 +2,12 @@
CLI tool for updating and launching [Project Epoch](https://www.project-epoch.net/) on Windows, Linux and macOS. CLI tool for updating and launching [Project Epoch](https://www.project-epoch.net/) on Windows, Linux and macOS.
## Setup ## Installing
### 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.
### Linux ### 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. 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 to install. 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.
### macOS ### macOS
@ -27,10 +23,14 @@ brew install --HEAD epochcli
brew upgrade epochcli --fetch-HEAD brew upgrade epochcli --fetch-HEAD
``` ```
## First Run ### 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
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` 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 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
## Usage ## Usage
``` ```
@ -43,4 +43,4 @@ brew upgrade epochcli --fetch-HEAD
## 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 ping `Battlehammer` on the Epoch discord