ez-dvsh spigot installation guide

EzTerry's Dark Oak Village & Additional Stronghold Mod
Spigot integration guide.  For Minecraft v1.8.7

=====
Introduction and Background
=====

The ez-dvsh mod is a base edit mod to Minecraft server code.  The original
distribution includes files for patching both the client (for single player use)
and the server for multiplayer use.  Note however, in the case of using dvsh on
a server it is not required that the clients be modified (ie any 1.8 vanilla,
dvsh, or optifine client will work correctly as expected with the modified
server)

While there is no intention to release this for Spigot, it is possible to
compile spigot to use the modified server binary as if it was the offical one
from Mojang, this document will describe how to make such a server.

=====
Requirements
=====

1) This document assumes you are comfortable running programs from the command
   line, and was made with the Linux user in mind (however this ought to work
   from the dos prompt with little or no modifications)

2) A copy of Python2.7 in order to run the ez-dvsh script if not included with
   your operating system/distro goto https://www.python.org/

3) You will need the following (download all of these to a new empty folder on
   your system

   a) minecraft 1.8.7 jar
     https://s3.amazonaws.com/Minecraft.Download/versions/1.8.7/minecraft_server.1.8.7.jar
   b) ez-dvsh patch installer for 1.8.7
     http://sandbox.devnull.name/minecraft/ez-dvsh/v1.8.7_ez-dvsh_patch.zip
   c) spigot BuildTools.jar
     https://hub.spigotmc.org/jenkins/job/BuildTools/lastSuccessfulBuild/artifact/target/BuildTools.jar
   d) patch for building spigot with ez-dvsh
     http://sandbox.devnull.name/minecraft/ez-dvsh/spigot_1.8.7/0001-Update-WorldGenVillagePieces-to-support-EZ-DVSH-mod.patch

====
Building Instructions
====

1) Download and place all the files listed under number 3 in requirements in a
   empty directory on your system

2) Open a terminal (dos prompt) and change into the directory with the files
   above

   At this point the current directory ought to have the following listing:

     ezterry@zack:/tmp/spigot-dvsh$ ls
     0001-Update-WorldGenVillagePieces-to-support-EZ-DVSH-mod.patch
     BuildTools.jar
     minecraft_server.1.8.7.jar
     v1.8.7_ez-dvsh_patch.zip

3) unzip v1.8.7_ez-dvsh_patch.zip (in linux 'unzip v1.8.7_ez-dvsh_patch')

4) run the python script to install the dvsh patch into the 1.8.7 server
   (using option 3 when prompted)

   Run will resemble the following:

     ezterry@zack:/tmp/spigot-dvsh$ ./v1.8.7_ez-dvsh_patch/install_patch.py
     ez-dv+sh
     patch files:
       /tmp/spigot-dvsh/v1.8.7_ez-dvsh_patch/client.zip
       /tmp/spigot-dvsh/v1.8.7_ez-dvsh_patch/server.zip

     Mod Installer for [ez-dv+sh]:
     Change world generation to include a 1 in 3 chance of a NPC village
     being dark oak, as well as increase the number of strongholds from 3
     to 5

     Please Choose Installation Method:
      (1) Automatic Client Patcher
      (2) Manual Client Patcher
      (3) Manual Server Patcher
      (4) Cancel and exit mod patcher
     Entry number of your choice: 3

     Please provide the location of the server jar file
     > minecraft_server.1.8.7.jar
     ail.class: Valid
     aqo.class: Valid
     aqt.class: Valid
     aqw$a.class: Valid
     aqw$f.class: Valid
     aqw$h.class: Valid
     aqw$i.class: Valid
     aqw$k.class: Valid
     aqw$m.class: Valid
     aqw$n.class: Valid
     jar successfully patched into: minecraft_server.1.8.7-ez-dvsh.jar

5) now make a new directory 'work' (ie 'mkdir work)

6) Move minecraft_server.1.8.7-ez-dvsh.jar into the new work directory, and
   rename to minecraft_server.1.8.7.jar

   (ie 'mv minecraft_server.1.8.7-ez-dvsh.jar work/minecraft_server.1.8.7.jar')

   this will cause BuildTools.jar to use the modified jar instead of
   re-downloading the official Minecraft server

7) now run 'java -jar BuildTools.jar --rev 1.8.7'

   *Note* this will fail but will fetch all the projects Spigot requires, and
   will start the decomposition process

   The expected error is:
    Exception in thread "main" difflib.PatchFailedException: Incorrect Chunk:
    the chunk content doesn't match the target

8) change directory into CraftBukkit (ie 'cd CraftBukkit')

9) apply the patch provided with the git am command:

   git am ../0001-Update-WorldGenVillagePieces-to-support-EZ-DVSH-mod.patch

   (ignore any white space warnings)

10) return to the main directory (eg 'cd ..')

11) complete the build with by running 'java -jar BuildTools.jar --dont-update')

12) now spigot ought to have properly built with the ez-dvsh mod included in
    the resulting server file, proceed to run, and install plugins as you would
    on any other spigot server.  You may wish to rename the
    spigot-1.8.7.jar to indicate it has the dvsh mod as well

====
Additional References
====

http://www.spigotmc.org/wiki/spigot-installation/

====
Final Notes
====

As the changes made in the mod are minor its exacted most plugins compatible
with minecraft 1.8.7 will work, however in some cases its possible things will
not behave correctly, please test your changes before deploying a server

also maps using the mod cannot go to a vanilla server (or unmodded spigot)
however installing updates to the ez-dvsh mod is possible unless specifically
warned.

As always this guide is just to allow you to merge my ezdvsh mod with spigot
however the resulting binary is comprised of incomparable licenses and may not
be re-distributed, only used for your personal use.