Upstream/Advanced-Portals
1
0
Fork 0
mirror of https://github.com/sekwah41/Advanced-Portals.git synced 2024-11-07 11:30:41 +01:00
Code Issues Projects Releases Wiki Activity

Update README.md

Browse Source
This commit is contained in:
sekwah41 2018-06-04 04:06:09 +01:00 committed by GitHub
parent 75d844a294
commit 2b248ba01e
No known key found for this signature in database
GPG Key ID: 4AEE18F83AFDEB23
1 changed files with 24 additions and 27 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

51
README.md
View File

@ -1,48 +1,45 @@
Advanced Portals <a href="https://travis-ci.org/sekwah41/Advanced-Portals/branches">![Build Status](https://travis-ci.org/sekwah41/Advanced-Portals.svg?branch=master)</a> Advanced Portals <a href="https://travis-ci.org/sekwah41/Advanced-Portals/branches">![Build Status](https://travis-ci.org/sekwah41/Advanced-Portals.svg?branch=core-dev)</a>
================ ================
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>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> **NOTE:** This is the rewrite that is in progress to also allow multiple platforms of server mods, if you are looking for the old version or this version isn't finished check the branch <a href="https://github.com/sekwah41/Advanced-Portals/tree/portals-old">portals-old</a>
<p><b>NOTE:</b> This is the rewrite that is in progress to also allow multiple platforms of server mods, if you are looking for the old version or this version isn't finished check the branch <a href="https://github.com/sekwah41/Advanced-Portals/tree/portals-old">portals-old</a></p> Also please use the markdown and not html for updates to this file, references can be found [here](https://github.com/adam-p/markdown-here/wiki/Markdown-Cheatsheet)
<h1>Branch Layout</h1> #Branch Layout
<ul> * [master](https://github.com/sekwah41/Advanced-Portals/) (core code) ![Build Status](https://travis-ci.org/sekwah41/Advanced-Portals.svg?branch=master)
<li><a href="https://github.com/sekwah41/Advanced-Portals/">master</a> (core code)</li> * [core-dev](https://github.com/sekwah41/Advanced-Portals/tree/core-dev) (Core Dev Code) ![Build Status](https://travis-ci.org/sekwah41/Advanced-Portals.svg?branch=core-dev)
<li><a href="https://github.com/sekwah41/Advanced-Portals/tree/spigot">spigot</a> (Spigot/Craftbukkit) (still needs to be made)</li> * [spigot](https://github.com/sekwah41/Advanced-Portals/tree/spigot) (Spigot/Craftbukkit) ![Build Status](https://travis-ci.org/sekwah41/Advanced-Portals.svg?branch=spigot)
<li><a href="https://github.com/sekwah41/Advanced-Portals/tree/sponge">sponge</a> (Sponge Powered) (still needs to be made)</li> * [spigot-dev](https://github.com/sekwah41/Advanced-Portals/tree/spigot-dev) (Spigot/Craftbukkit Dev Code) ![Build Status](https://travis-ci.org/sekwah41/Advanced-Portals.svg?branch=spigot-dev)
</ul> * [sponge](https://github.com/sekwah41/Advanced-Portals/tree/sponge") (Sponge Powered) ![Build Status](https://travis-ci.org/sekwah41/Advanced-Portals.svg?branch=sponge)
<h1>Help</h1> #Help
<a href="https://github.com/sekwah41/Advanced-Portals/wiki/Commands">List Of Commands</a> [List Of Commands](https://github.com/sekwah41/Advanced-Portals/wiki/Commands)
<a href="https://www.spigotmc.org/resources/advanced-portals.14356/">Spigot Page</a> [Spigot Page](https://www.spigotmc.org/resources/advanced-portals.14356/)
<a href="http://dev.bukkit.org/bukkit-plugins/advanced-portals/">Bukkit Page</a> [Bukkit Page](http://dev.bukkit.org/bukkit-plugins/advanced-portals/)
<br>
<h1>Supported Platforms</h1> #Supported Platforms
<ul> * Spigot/Craftbukkit (planned for release of recode)
<li>Spigot/Craftbukkit (planned for release of recode)</li> * Sponge Powered (planned)
<li>Sponge Powered (planned)</li>
</ul>
<h1>API</h1> #API
Still needs major work on the documentation however javadocs will be made available on my website on release. Still needs major work on the documentation however javadocs will be made available on my website on release.
May be out of date but I will keep whatever javadocs there are updated every now and then here May be out of date but I will keep whatever javadocs there are updated every now and then here
http://www.sekwah.com/javadocs/advancedportals/ http://www.sekwah.com/javadocs/advancedportals/
<h1>Usage Data</h1> #Usage Data
<img src="http://i.mcstats.org/AdvancedPortals/Global+Statistics.borderless.png" alt="Global Plugin Stats" title="Global Plugin Stats">
![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. 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> To get the needed bukkit versions download the spigot buildtools and run the appropriate commands for the versions listed in the pom file.
<p>e.g. "java -jar BuildTools.jar --rev 1.10.2" (Enter this into git bash)</p> 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