Advanced-Portals/README.md

56 lines
3.2 KiB
Markdown
Raw Normal View History

2024-11-18 06:45:39 +01:00
![Advanced portals](./docs/logo.png)
2019-06-02 07:19:41 +02:00
2024-11-18 06:45:39 +01: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)
[![](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
2024-11-18 06:45:39 +01:00
Advanced Portals
==============
An advanced portals plugin 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.
2024-11-18 06:45:39 +01:00
# Usage
2023-04-06 05:50:08 +02:00
2024-11-18 06:45:39 +01:00
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).
2024-11-18 06:45:39 +01:00
# 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)
2021-05-14 12:42:46 +02:00
# Contributing
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/
2024-06-16 05:00:49 +02:00
Also if you could, please run `pre-commit run --files ...` or `pre-commit run --all-files` to ensure that the code is formatted correctly.
2024-06-16 05:57:25 +02:00
You will need to have clang-format installed for this to work.
2024-06-16 05:00:49 +02:00
2021-05-23 23:37:52 +02:00
## 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
2021-05-25 02:32:22 +02:00
The scopes available should be the specific modules being worked on. E.g. core, spigot, docs
2023-04-06 05:46:48 +02:00
## Documentation
That is handled on the [website](https://github.com/sekwah41/Advanced-Portals/tree/website) branch.
At some point I may merge this onto this branch to try to push for documentation changes with new features, though for now this works.