From 44ee4c5ab5e8cfb4e9cecab7a45d41ffdf37fd86 Mon Sep 17 00:00:00 2001 From: forgive <81714507+4GlVE@users.noreply.github.com> Date: Sun, 24 Jul 2022 23:39:12 -0400 Subject: [PATCH] Update README.md --- README.md | 42 ++++++++++++++++++++++++++++++++++++++++-- 1 file changed, 40 insertions(+), 2 deletions(-) diff --git a/README.md b/README.md index 9bf0b7f..54544ed 100644 --- a/README.md +++ b/README.md @@ -1,2 +1,40 @@ -# zonetool-helper -Batch script that automatically downloads Zonetool. +# Zonetool Helper + +**A batch script that automatically downloads and installs [Zonetool](https://github.com/ZoneTool/zonetool)** + +- [Installation](#installation) +- [Features](#features) +- [To-Do List](#to-do-list) +- [Credits](#credits) + +## Installation + +Simply download the script through [this link](https://github.com/4GlVE/zonetool-helper/releases/latest). Scroll down to `Assets` and download `zonetool-helper.bat`. + +Once the script is downloaded, drag and drop into any of your COD4, MW2/IW4x, or MW3 game directories. + +**Example directory:** +```text +.../ + └── Steam/ + └── .../ + └── Call of Duty Modern Warfare 3 +``` + +Once this is done run the script, then follow the prompts. + +## Features + +> Downloads Zonetool and its binaries into your game directory, allowing you to choose between Rekti's version or Quak's version. +- **Disclamer:** The download I supplied for Quak's version is believed to be an old build, it has other features that the base version doesn't have, but for most things the base version is good enough. + +## To Do List +- [ ] Build Quak's latest as the current download may be an older version. +- [ ] Create a uninstall script within this script. +- [ ] Create an auto-updater for this script. + +## Credits +- [Rekti](https://github.com/RektInator) // For making Zonetool +- [Quak](https://github.com/Joelrau) // For making their Zonetool version +- [Expert](https://github.com/soexperttt) // For giving me the idea for this script +- [Chopper](https://github.com/chopper1337) // For help with extra stuff