From 523fbb1c832813a3c7c0548ad859e7f689361ade Mon Sep 17 00:00:00 2001 From: Sekwah Date: Mon, 3 Jun 2019 03:46:13 +0100 Subject: [PATCH] Added developer note --- README.md | 13 ++++--------- 1 file changed, 4 insertions(+), 9 deletions(-) diff --git a/README.md b/README.md index dfad8b1..49cb2e7 100644 --- a/README.md +++ b/README.md @@ -11,9 +11,6 @@ An advanced portals plugin for bukkit made by sekwah41 designed to have a wide r Once the recode is done the master branch will be releases and the dev branch will be where work is done. -# Build Instructions -You must have gradle installed then run "gradle build". Once the build is complete you will have a useable jar file in the folder named "build/lib" listed as Advanced-Portals-x.x.x-snapshot.jar - # Help [List Of Commands](https://github.com/sekwah41/Advanced-Portals/wiki/Commands) @@ -26,11 +23,9 @@ Usage stats can be found here https://bstats.org/plugin/bukkit/AdvancedPortals Were available here http://mcstats.org/plugin/AdvancedPortals but mcstats is no longer working. +# API + The api isn't implemented in this version, sorry for any inconvenience. Check the recode tree for possibly a working recode at some point. -To get the needed bukkit versions download the spigot buildtools and run the appropriate commands for the versions listed in the pom file. -e.g. "java -jar BuildTools.jar --rev 1.10.2" (Enter this into git bash) - -Use the versions to test code before you turn it into reflection or suggest it to be turned into reflection. - -You should never use direct craftbukkit references in public builds as it would only work in one spigot version +# Contribution +If you are going to change any of the reflection make sure you test it against the suggested supported versions at the moment e.g. 1.13 as well as 1.14 otherwise most will be accepted from just reviewing the code unless it changes something drastic which would effect other functionality in a bad way.