upgraded config creation
This commit is contained in:
27
README.md
27
README.md
@ -2,22 +2,25 @@
|
||||
|
||||
CLI tool for updating and launching [Project Epoch](https://www.project-epoch.net/) on Linux & macOS.
|
||||
|
||||
## TODO
|
||||
## 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`
|
||||
|
||||
- improve config generation
|
||||
- add ability to launch Epoch after an update
|
||||
For macOS, the [Kegworks Wineskin port](https://github.com/Kegworks-App/Kegworks) works great (tutorial coming in the future...)
|
||||
|
||||
## Instructions
|
||||
For Linux, a `wine` prefix with `dxvk` installed works great, or you can use something like Lutris or Faugus-launcher
|
||||
|
||||
For macOS, the [Kegworks Wineskin port](https://github.com/Kegworks-App/Kegworks) works great
|
||||
|
||||
2. Install `epochcli` by either
|
||||
1. Download the latest binary from the [releases](https://git.burkey.co/eburk/epochcli/releases) page
|
||||
1. Install `epochcli` by either
|
||||
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. Run `epochcli` once. This will create a config file at `$HOME/.config/epochcli/config.toml`. Update the variables with the appropriate information
|
||||
4. Run `epochcli` again. It will download the patch files from Epoch's servers to your Wow directory and start the game. You can also pass the -u switch to only update if you use a launcher like Lutris, etc
|
||||
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
|
||||
|
||||
## 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
|
||||
|
||||
|
Reference in New Issue
Block a user