Started the plugin README.md

README.md

@@ -1 +1,34 @@
-# MobHunt
+# Mob Hunt
+
+## Installation
+* Clone this repo.
+* Configure your config.
+* Run the dbinit.
+* Download the latest version of Mob Hunt from our [releases page](https://github.com/ModularSoftAU/MobHunt/releases/)
+* Drop the Mob Hunt jar file into your plugins' folder.
+* Set all of your point allocations per mob in the `config.yml` under `MobHunt.Points` and define your kill cap under `MobHunt.KillCap`
+
+## Requirements
+* MySQL Database.
+
+## Soft Dependencies
+- [Optional] `DecentHolograms` if you would like to have a holographic live update leaderboard.
+
+## Gameplay
+When a player kills a mob it is logged into a database and a number incremented in their name.
+Most amount and unique amount of mobs that a player kills, wins.
+
+#### Milestones
+When a player kills over an X amount of mobs, a message will broadcast to all online players that they have reached a milestone.
+The milestones can be changed and modified in the `config.yml` under `Milestones.Messages` and you can change them based on Major and Minor.
+
+### Holographic Leaderboard
+
+
+## Commands
+| Command               | Description                                              | Permission      |
+|-----------------------|----------------------------------------------------------|-----------------|
+| /mobstats             | Shows a breakdown of the mobs you killed                 |                 |
+| /mobclear             | Clear all mobs from yourself or another player.          | `mobhunt.admin` |
+| /mobleaderboard [mob] | Show the Top 5 Mob Hunters overall or of a specific mob. |                 |
+| /mobhelp              | Helps the player know how to play Mob Hunt.              |                 |

src/main/resources/config.yml

@@ -126,8 +126,7 @@ Lang:
       - "Killing Mobs rewards &5points&r, but sebsequent kills of the same Mob will yield less points."
       - "The best hunters will both, &ekill in quantity&r, and journey far and wide to &ehunt down the rarest Mobs&r with extreme prejudice."
       - ""
-      - "&6Happy hunting"
-      - "&6From Crafting For Christ&r"
+      - "&6Happy hunting!"
     Kill: "You killed a %MobType% for %Points% point%Plural%."
     CapReached: "You have reached the kill cap of %Cap% for %MobType%s.
       Points will not be awarded for killing this mob, but stats tracking

src/main/resources/plugin.yml

@@ -19,6 +19,6 @@ commands:
     usage: /mobleaderboard [mob]
     aliases: [lb, leaderboard]
   mobhelp:
-    description: Helps the player know how to play MobHunt.
+    description: Helps the player know how to play Mob Hunt.
     usage: /mobhelp
     aliases: [howtoplay]