Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

chore: update readme #75

Merged
merged 1 commit into from
Feb 2, 2024
Merged

chore: update readme #75

Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
76 changes: 14 additions & 62 deletions README.md
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -1,100 +1,52 @@
# wowtools

## Announcment:
## Announcment

Please see the latest announcements under the [Discussion](https://github.com/lyledouglass/wowtools/discussions) tab

---

## About:
## About

This project is based off other applications that manage certain functions with WoW, specifically api scrapping, addon management, and backups. With the Curseforge API changes, many developers are deprecating their applications. While this application will _not_ manage addons found on Curseforge, my intent is to offer some of the other features that other applications had, such as WTF folder backups, PTR profiles copies, new character setups, etc.

---

## Windows

<details>
<summary>Expand</summary>

### Requirements
## Requirements

- This application is written and compiled in Go. All dependencies are compiled in the application executable.
- You will need to have the `config.yaml` in the same directory as the exe

### Download

The latest release can be found here: https://github.com/ldougbmx/wowtools/releases

- Download the wowtools.exe and config.yaml
- The README and LICENSE files are also included in the release
- Place the files anywhere on your system (but both in the same directory)
- Verify/Update the config.yml to set custom paths if needed

### Usage

Update the config.yaml file if you have WoW installed in a custom location. This application relies on the yaml for file paths. You can leave the Linux options blank

### Functionality
## Functionality

This is the standard operation of the app if you don't specify any CLI flags. If CLI flags are detected, this full process will not run.

1. Creates `_retail_\Backups` and `_retail_\Backups\WTF` directories if they don't exist
1. Creates `_retail_\Backups` and `_retail_\Backups\WTF` directories if they don't exist

### CLI Flags

wowtools allows you to specify specific flags when calling the app from the CLI which will perform specific tasks outside the functionality listed above

###

`backup`

- Zips up the WTF directory (`C:\Program Files (x86)\World of Warcraft\_retail_\WTF`) and backs it up to `C:\Program Files (x86)\World of Warcraft\_retail_\Backups\WTF`, with the format of YYYY-MM-DD.zip
- Reads the `retention_rate` from the yml and removes the oldest zip file if the count in the folder is higher than it.

###
`restore`

- Performs a destructive action to remove the current WTF folder and replace it with a specific backup from the `C:\Program Files (x86)\World of Warcraft\_retail_\Backups\WTF` directory

`copy-ptr`

- This flag will run wowtools and _only_ do the following
- Remove the WTF and Interface folder from your PTR install folder
- Use Windows Robocopy to copy the WTF and Interface folder from your retail folder to the PTR folder.

### Adding an icon to the exe

There are a few options that can be used to add an icon to the executable so it doesn't look as 'ugly' in the Start Menu or a folder you store commonly used apps.

1. Create a shortcut to the application and add an icon to the shortcut.
1. I store my wowtools in my WoW retail folder and create a shortcut to it on my Start menu
2. The icon I use can be found in the images folder in this repo
2. Another more complex process is using an application like 'Resource Hacker', or even using the [go-winres](https://github.com/tc-hib/go-winres) package and manually build the app from source.
</details>

---

## Linux

<details>
<summary>Expand</summary>
The `wowtools_server` application is compiled for Linux for use in conjunction with cron.

### Requirements

- A linux based machine

## Download/Installation

The latest release can be found here: https://github.com/ldougbmx/wowtools/releases
<br>
### Functionality
The latest release can be found on the [releases](https://github.com/ldougbmx/wowtools/releases) page

- Scrapes the WoW Token Price via the Blizzard and reports it if the sale price is above a set value
- More coming soon &trade;
</details>

---
- Download the wowtools.exe and config.yaml
- The README and LICENSE files are also included in the release
- Place the files anywhere on your system (but both in the same directory)
- Verify/Update the config.yml to set custom paths if needed

## Planned enhancements

- Implement more CLI commands to allow users to perform specific actions on demand.
- Implement better method of managing secrets inside the docker container
For planned enhancements, please review the [issues](https://github.com/lyledouglass/wowtools/issues) tab in the github repository
Loading