Upstream
/
Advanced-Portals
mirror of https://github.com/sekwah41/Advanced-Portals.git
1
0
Fork 0
Code Issues Projects Releases Wiki Activity

Updated readme

This commit is contained in:
Sekwah 2019-06-02 17:43:09 +01:00
parent 8c5d8d689c
commit ae5557f816
1 changed files with 19 additions and 18 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

37
README.md
View File

@ -1,33 +1,34 @@
![Advanced Portals](https://i.imgur.com/UIF6cQR.png)
Advanced Portals ![Build Status](https://travis-ci.org/sekwah41/Advanced-Portals.svg?branch=portals-old)
Advanced Portals ![Build Status](https://travis-ci.org/sekwah41/Advanced-Portals.svg?branch=master)
==============
<h2>Build Instructions</h2>
<p>(This part is mostly aimed for beginners in case they haven't seen a maven project)
<p>You must have maven 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</p>
An advanced portals plugin for bukkit made by sekwah41 designed to have a wide range of features which are easy to use. It adds a bunch of commands to create and edit portals and destinations. This plugin not only enable normal teleportation but also cross server teleportation for networks using bungee.
<h2>Plugin Info</h2>
<p><b>NOTE:</b> This is the old version of Advanced Portals, look in the appropriate branch for the newer versions.</p>
# Branch Layout
* [master](https://github.com/sekwah41/Advanced-Portals/) (Release Build) ![Build Status](https://travis-ci.org/sekwah41/Advanced-Portals.svg?branch=master)
* [dev](https://github.com/sekwah41/Advanced-Portals/tree/dev) (Dev Build) ![Build Status](https://travis-ci.org/sekwah41/Advanced-Portals.svg?branch=dev)
* [recode](https://github.com/sekwah41/Advanced-Portals/tree/recode) (Recode) ![Build Status](https://travis-ci.org/sekwah41/Advanced-Portals.svg?branch=recode)
<p>An advanced portals plugin for bukkit made by sekwah41 designed to have a wide range of features which are easy to use. It adds a bunch of commands to create and edit portals and destinations. This plugin not only enable normal teleportation but also cross server teleportation for networks using bungee.</p>
Once the recode is done the master branch will be releases and the dev branch will be where work is done.
<a href="https://github.com/Plugineers/Advanced-Portals/wiki/Commands">List Of Commands</a>
# 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
<a href="https://www.spigotmc.org/resources/advanced-portals.14356/">Spigot Page</a>
# Help
[List Of Commands](https://github.com/sekwah41/Advanced-Portals/wiki/Commands)
<a href="http://dev.bukkit.org/bukkit-plugins/advanced-portals/">Bukkit Page</a>
<br>
<br>
<p>Usage Data</p>
[Spigot Page](https://www.spigotmc.org/resources/advanced-portals.14356/)
<img src="http://i.mcstats.org/AdvancedPortals/Global+Statistics.borderless.png" alt="Global Plugin Stats" title="Global Plugin Stats">
[Bukkit Page](http://dev.bukkit.org/bukkit-plugins/advanced-portals/)
# Usage Data
![Global Plugin Stats](http://i.mcstats.org/AdvancedPortals/Global+Statistics.borderless.png)
The api isn't implemented in this version, sorry for any inconvenience. Check the recode tree for possibly a working recode at some point.
<p>To get the needed bukkit versions download the spigot buildtools and run the appropriate commands for the versions listed in the pom file.</p>
<p>e.g. "java -jar BuildTools.jar --rev 1.10.2" (Enter this into git bash)</p>
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)
<p>Use the versions to test code before you turn it into reflection or suggest it to be turned into reflection.</p>
Use the versions to test code before you turn it into reflection or suggest it to be turned into reflection.
<p>You should never use direct craftbukkit references in public builds as it would only work in one spigot version</p>
You should never use direct craftbukkit references in public builds as it would only work in one spigot version