From 2d26945bd81bb639f6a5ac63963c3dd29aa60218 Mon Sep 17 00:00:00 2001 From: jakub1221 Date: Sat, 11 Feb 2017 14:46:44 +0100 Subject: [PATCH] Update README.md --- README.md | 33 +++++++++++++++++++++++++++++---- 1 file changed, 29 insertions(+), 4 deletions(-) diff --git a/README.md b/README.md index b2941c9..2c8cb32 100644 --- a/README.md +++ b/README.md @@ -3,10 +3,35 @@ ========= -HerobrineAI is plugin that creates Herobrine with custom AI and skin. -But all it is likely true Herobrine legend with some improvements. -Herobrine can be found randomly in the world or he can attack or haunt a player. +HerobrineAI is server-side bukkit plugin for Minecraft that creates Herobrine with custom AI and skin. +Plugin has many features and it is based on the legend of Herobrine. + +Contributing +--------- +This is an project and there are some parts of code that are poorly written, feel free to pull any refactored code. Building --------- - git clone git://github.com/jakub1221/HerobrineAI.git \ No newline at end of file +**Maven with jdk7+ is required** + +**1. Clone project** +``` +git clone git://github.com/jakub1221/HerobrineAI.git +``` + +**2. Install maven with jdk** +[Tutorial here](http://maven.apache.org/install.html) + +**3. Install Craftbukkit** +Plugin uses NMS code that is located in craftbukkit. +In order to get craftbukkit installed to local maven repository you need to run [BuildTools](https://www.spigotmc.org/wiki/buildtools/). + +**4. Build plugin** +``` +mvn clean install +``` +Plugin will be located in target directory after building is done. + +Downloads +--------- +You can download latest build from jenkins site [here](http://jenkins.logicshard.com/job/HerobrineAI/).