diff --git a/.github/CODEOWNERS b/.github/CODEOWNERS new file mode 100644 index 0000000..0dc7101 --- /dev/null +++ b/.github/CODEOWNERS @@ -0,0 +1 @@ +* @lyledouglass \ No newline at end of file diff --git a/README.md b/README.md index 5a2ac0d..7a13111 100644 --- a/README.md +++ b/README.md @@ -1,6 +1,6 @@ # wowtools -## Announcment +## Announcments Please see the latest announcements under the [Discussion](https://github.com/lyledouglass/wowtools/discussions) tab @@ -13,51 +13,35 @@ This project is based off other applications that manage certain functions with - 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 -## 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 - -### 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. - -`wtfrestore` - -- 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 - -`ptrcopy` - -- 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. - -`update` - -- This flag will run wowtools and _only_ do the following - - Check the version of the application against the latest release on github - - If the version is different, it will download the latest release to your downloads folder so you can replace the current executable - -`help` - -- Shows help text for the application -- This flag is not complete and there is more help text to be added - ## Download/Installation -The latest release can be found on the [releases](https://github.com/ldougbmx/wowtools/releases) page +The latest release can be found on the [releases](https://github.com/lyledouglass/wowtools/releases) page - 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 +## Functionality + +Functionality of the app can be found in the [functionality.md](https://github.com/lyledouglass/wowtools/blob/main/functionality.md) file + ## Planned enhancements For planned enhancements, please review the [issues](https://github.com/lyledouglass/wowtools/issues) tab in the github repository + +## Contributing + +### Pull Requests + +Every change in the codebase should be done via pull requests. This +applies to everyone, including the project maintainers. This is to +ensure that every change is reviewed and discussed before it goes into +the codebase, and builds are succeeding + +### Conventional Commits + +In order to have a clean and readable commit history, this repository +requires the use of [ConventionalCommits](https://www.conventionalcommits.org/en/v1.0.0/). +Using conventional commits will allow for automatic versioning and +changelog generation as well diff --git a/functionality.md b/functionality.md new file mode 100644 index 0000000..9fb482b --- /dev/null +++ b/functionality.md @@ -0,0 +1,33 @@ +# Functionality + +`wowtools.exe ` + +## 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. + +`wtfrestore` + +- 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 + +`ptrcopy` + +- 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. + +`update` + +- This flag will run wowtools and _only_ do the following + - Check the version of the application against the latest release on github + - If the version is different, it will download the latest release to your downloads folder so you can replace the current executable + +`help` + +- Shows help text for the application +- This flag is not complete and there is more help text to be added \ No newline at end of file