Advanced-Portals/README.md

73 lines
3.9 KiB
Markdown
Raw Normal View History

2019-06-02 07:19:41 +02:00
![Advanced Portals](https://i.imgur.com/UIF6cQR.png)
2019-09-08 00:39:39 +02:00
[![Discord](https://img.shields.io/discord/168282484037910528.svg?style=for-the-badge&logo=discord&logoColor=white)](https://discord.gg/fAJ3xJg)
[![](https://img.shields.io/github/contributors/sekwah41/Advanced-Portals.svg?style=for-the-badge&logo=github)](https://github.com/sekwah41/Advanced-Portals/graphs/contributors)
[![](https://img.shields.io/github/issues/sekwah41/Advanced-Portals.svg?style=for-the-badge&logo=github)](https://github.com/sekwah41/Advanced-Portals/issues)
[![](https://img.shields.io/github/issues-pr/sekwah41/Advanced-Portals.svg?style=for-the-badge&logo=github)](https://github.com/sekwah41/Advanced-Portals/pulls)
[![](https://img.shields.io/github/forks/sekwah41/Advanced-Portals.svg?style=for-the-badge&logo=github)](https://github.com/sekwah41/Advanced-Portals/network/members)
[![](https://img.shields.io/github/stars/sekwah41/Advanced-Portals.svg?style=for-the-badge&logo=github)](https://github.com/sekwah41/Advanced-Portals/stargazers)
2019-09-08 00:53:50 +02:00
[![](https://img.shields.io/github/license/sekwah41/Advanced-Portals.svg?logo=github&style=for-the-badge)](https://github.com/sekwah41/Advanced-Portals/blob/master/LICENSE.md)
2019-09-08 00:39:39 +02:00
Advanced Portals
2019-06-02 07:19:41 +02:00
==============
2019-06-02 18:43:09 +02:00
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.
2013-10-07 18:19:27 +02:00
2024-07-17 05:14:30 +02:00
The recode is actively being worked on and should be available relatively soon.
https://github.com/sekwah41/Advanced-Portals/issues/360
# Usage
Check out the [Tutorial](https://advancedportals.sekwah.com/docs/intro), [List of Commands](https://advancedportals.sekwah.com/docs/commands), and [List of Portal Tags](https://advancedportals.sekwah.com/docs/portal-tags).
2014-10-22 23:34:08 +02:00
# Download
2020-11-28 04:21:52 +01:00
- [Bukkit](https://dev.bukkit.org/projects/advanced-portals)
- [Spigot](https://www.spigotmc.org/resources/advanced-portals.14356/)
- [Curseforge](https://www.curseforge.com/minecraft/bukkit-plugins/advanced-portals)
- [Modrinth](https://modrinth.com/plugin/advanced-portals)
- [Github](https://github.com/sekwah41/Advanced-Portals/releases)
2016-03-14 17:15:24 +01:00
# Recode
2015-06-28 17:40:10 +02:00
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.
2019-06-02 18:43:09 +02:00
# Usage Data
Usage stats can be found here https://bstats.org/plugin/bukkit/AdvancedPortals
2019-06-03 04:46:13 +02:00
# API
2019-06-03 04:46:13 +02:00
The api isn't implemented in this version, sorry for any inconvenience. Check the recode tree for possibly a working recode at some point.
2021-05-14 12:42:46 +02:00
# Contributing
2021-06-27 18:34:33 +02:00
Don't worry about updating the file numbers in `bungee.yml`, `plugin.yml` and `AdvancedPortalsPlugin.java`.
They will be updated automatically before builds.
2021-05-12 02:22:50 +02:00
Please ensure that your commits are in the following style for PR's
https://www.conventionalcommits.org/en/v1.0.0/
2021-05-14 12:42:46 +02:00
Accepted tags mostly follow the Angular style and are meant to only loosely be followed.
When commits close an issue refer in the commit description in the following style (Refs #1, #2, #3)
## Types available
* **build**: Changes that affect the build system or external dependencies
* **ci**: Changes to our CI configuration files and scripts
* **docs**: Documentation only changes
* **feat**: A new feature
* **fix**: A bug fix
* **perf**: A code change that improves performance
* **refactor**: A code change that neither fixes a bug nor adds a feature
* **style**: Changes that do not affect the meaning of the code (white-space, formatting, missing semi-colons, etc)
2021-05-14 12:42:46 +02:00
<!---
We don't currently do tests. But in case.
* **test**: Adding missing tests or correcting existing tests
-->
## Scopes available
Scopes are only needed if relating to specific features just to make them easier to find.
_I'll expand the list as I work more on the project._
* **proxy** (Proxy specific features and issues)