From 431368b9af49fe3ae6a3cafd9490dfbd60f2201f Mon Sep 17 00:00:00 2001 From: RedbeardRagnar Date: Sun, 26 Mar 2017 17:54:53 +0300 Subject: [PATCH] Rewrite README.md --- README.md | 30 +++++++++++++++++++++++++----- 1 file changed, 25 insertions(+), 5 deletions(-) diff --git a/README.md b/README.md index b31b2d0..4fb1571 100644 --- a/README.md +++ b/README.md @@ -1,5 +1,25 @@ -Make sure to support the main project: -https://github.com/azerothcore/azerothcore-wotlk/ -# AnticheatModule -* !!BEFORE RUNNING!!: Execute the included "conf/SQL/charactersdb_anticheat.sql" file on your characters database. This creates the necessary tables for this module. -* This is a port of the PassiveAnticheat Script from lordpsyan's repo to azerothcore. +# Anticheat Module + +This is a port of the PassiveAnticheat Script from lordpsyan's repo to [AzerothCore](http://www.azerothcore.org) + +## How to install + +###1) Simply place the module under the `modules` folder of your AzerothCore source folder. + +You can do clone it via git under the azerothcore/modules directory: + +`cd path/to/azerothcore/modules` + +`git clone https://github.com/azerothcore/mod-anticheat.git` + +or you can manually [download the module](https://github.com/azerothcore/mod-anticheat/archive/master.zip), unzip and place it under the `azerothcore/modules` directory. + +###2) Re-run cmake and launch a clean build of AzerothCore + +###3) Execute the included "conf/SQL/charactersdb_anticheat.sql" file on your characters database. This creates the necessary tables for this module. + +**That's it.** + +### (Optional) Edit module configuration + +If you need to change the module configuration, go to your server configuration folder (e.g. **etc**), copy `Anticheat.conf.dist` to `Anticheat.conf` and edit it as you prefer.