Advanced-Portals/README.md
2024-07-17 04:14:30 +01:00

73 lines
3.9 KiB
Markdown

![Advanced Portals](https://i.imgur.com/UIF6cQR.png)
[![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)
[![](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)
Advanced Portals
==============
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.
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).
# Download
- [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)
# 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.
# Usage Data
Usage stats can be found here https://bstats.org/plugin/bukkit/AdvancedPortals
# 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.
# Contributing
Don't worry about updating the file numbers in `bungee.yml`, `plugin.yml` and `AdvancedPortalsPlugin.java`.
They will be updated automatically before builds.
Please ensure that your commits are in the following style for PR's
https://www.conventionalcommits.org/en/v1.0.0/
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)
<!---
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)