mirror of
https://gitlab.com/SamB440/rpgregions-2.git
synced 2025-12-28 11:19:24 +00:00
64 lines
2.7 KiB
Markdown
64 lines
2.7 KiB
Markdown

|
|
# RPGRegions 2
|
|
|
|
RPGRegions 2 is the successor to RPGRegions 1. The entire plugin has been recoded and has an entirely new design. With performance in mind, it is the only discovery plugin that is up-to-date and supporting SQL.
|
|
|
|
# Links
|
|
- [Spigot](https://www.spigotmc.org/resources/rpgregions-1-12-1-15.74479/)
|
|
- [Wiki](https://fortitude.islandearth.net)
|
|
- [Discord](https://discord.gg/fh62mxU)
|
|
|
|
## About RPGRegions
|
|
RPGRegions lets you create configurable regions that your players can discover. Aiming to promote exploration, you set titles, sounds, deliver unlimited rewards, and execute commands to do whatever you want.
|
|
|
|
## What makes it different to v1?
|
|
RPGRegions 2 is the successor to RPGRegions 1. The entire plugin has been recoded and has an entirely new design. With performance in mind, it is the only discovery plugin that is up-to-date, per-region configs, and supporting SQL.
|
|
|
|
## Features
|
|
|
|
* Detailed documentation in multiple languages
|
|
* Create complex, levelled regions (TBA)
|
|
* Per-region fog (TBA, in 1.16)
|
|
* In-game editing
|
|
* Region effects
|
|
* Per-region config
|
|
* Hidden (secret) regions
|
|
* Supports multiple region plugins
|
|
* Unlimited reward-giving system
|
|
* Teleport to discovered regions
|
|
* Hints
|
|
* Developer API
|
|
* Asynchronous
|
|
* Supports PaperLib
|
|
* Animated titles
|
|
* PAPI and Head Database support
|
|
* MySQL
|
|
* Discovery GUI
|
|
* Easy to use commands with tab-complete
|
|
* Fully translatable (via Languagy)
|
|
* Fully customisable GUI
|
|
* Open source
|
|
|
|
### A note on version support
|
|
RPGRegions will always support the latest Spigot version. Currently it works with 1.12+, however legacy versions may be dropped at any time.
|
|
|
|
## Requirements
|
|
|
|
* Java 8+
|
|
* A 1.12+ server
|
|
* Languagy
|
|
* Protection plugin (WorldGuard)
|
|
|
|
Find out how to install and configure at our wiki.
|
|
|
|
## FAQ
|
|
1. Do you support x protection plugin?
|
|
We aim to support as many as possible, as long as it has a maven repository and documentation we will add it.
|
|
2. Why is the jar over 1MB?
|
|
RPGRegions has a few libs that are (unfortunately) large, some are within the Spigot jar, but their package locations have changed between versions. In order to offer multi-version compatibility we need to shade these into the jar.
|
|
3. What makes it better than x discovery plugin?
|
|
RPGRegions offers full configuration for each individual region. It is constantly up-to-date and aims to support as many region plugins as possible. Additionally, it has support for MySQL, unlike any other. See our comparison table at the bottom of the FAQ.
|
|
4. Can I get x feature added?
|
|
We are always looking for new features to add. Create an issue on Jira and we will get round to it.
|
|
|