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

docs: Updating Readme

This commit is contained in:
Sekwah 2021-05-12 01:22:50 +01:00
parent 3ac7a8c6ff
commit fd6ef9ac08
No known key found for this signature in database
GPG Key ID: C3BE2E6C861A461A
1 changed files with 9 additions and 16 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

25
README.md
View File

@ -12,12 +12,9 @@ Advanced Portals ![GitHub Workflow Status](https://img.shields.io/github/workflo
==============
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.
# Branch Layout
* [master](https://github.com/sekwah41/Advanced-Portals/) (Release Build)
* [dev](https://github.com/sekwah41/Advanced-Portals/tree/dev) (Dev Build)
* [recode](https://github.com/sekwah41/Advanced-Portals/tree/recode) (Recode)
Once the recode is done the master branch will be releases and the dev branch will be where work is done.
# Recode
We are currently slowly working on a complete re-code of the plugin with a full API.
For now maintaining the current 1.13+ spigot versions is our main priority.
# Help
[Command Documentation & Guides](https://www.guilded.gg/Sekwah/groups/MDqAZyrD/channels/72ffdaa3-9273-4722-bf47-b75408b371af/docs/1807463914)
@ -31,17 +28,13 @@ Once the recode is done the master branch will be releases and the dev branch wi
# Usage Data
Usage stats can be found here https://bstats.org/plugin/bukkit/AdvancedPortals
# Velocity Support
We add basic Velocity support though it isn't really a priority.
By default, the bungee: tag works without there being a plugin on velocity however for desti: to work
for now ensure that on spigot you have the bungeecord setting enabled to register the necessary packet channels.
We will look into adding better support for proxies (Especially Velocity as it looks better)
# 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.
# 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.
## Contributing
Please ensure that your commits are in the following style for PR's
https://www.conventionalcommits.org/en/v1.0.0/
This will help with changelogs and tracking bugfixes.