This update contains a lot of changes so as always please do your own testing and take backups.
Major changes:
Removed 1.14 and 1.15 support According to bStats,
nobody is using these versions and so I have removed it from official support. If you are one of the rare people using this version, contact me and I may be able to provide a jar specifically for you.
A note on legacy support In the future, if it permits, I may readd some legacy support depending on how much work it takes.
Added our own region integration You will no longer need to rely on seperate plugins to run RPGRegions - you can now use the new RPGRegions integration which is in-built within the plugin. It currently supports cuboid and polygon regions, but is very basic and still work in progress.
Added region fog support With the new fog effect, you can now add per-region fog to your areas! However, this currently only supports 1.17 and may have some unknown issues. To achieve this, some packets are messed with and a lot of things could go wrong.
Config comments! The configuration file is now filled with comments on what does what. Comments will not appear unless you regenerate your config.yml. Default config with comments is below.
Code (YAML):
# This is the config for RPGRegions. # ------ Useful information ------ # Documentation can be found at https://fortitude.islandearth.net # Sounds can be found at https://hub.spigotmc.org/javadocs/spigot/org/bukkit/Sound.html # Materials can be found at https://hub.spigotmc.org/javadocs/spigot/org/bukkit/Material.html # ------ Support ------ # Found a bug? Create an issue at https://gitlab.com/SamB440/rpgregions-2/issues # Need help? Join our discord at https://discord.gg/fh62mxU # ------ Setting explanation ------ # See wiki for more detailed information. # search-offline-players: Tab complete will list offline players where possible. This can cause lag with lots of offline players due to Bukkit loading all of their data. # worlds.forceload: Forcefully load worlds on startup to ensure RPGRegions recognises them. ONLY ENABLE IF YOU KNOW WHAT YOU ARE DOING! # settings.metrics.send_custom_info: Disable if experiencing bStats lag spikes. # ------ Other config files ------ # See lang folder for language settings. # See regions folder for editing region files. settings:
metrics:
send_custom_info: true
# Send extra info to bStats. May want to disable if experiencing lag spikes from bStats. dev:
debug: false
# Enables debug output. Will spam console! integration:
name: RPGRegions
# Name of the integration: WorldGuard, Residence, GriefPrevention, UltraRegions, RPGRegions external:
dynmap: true
# Enable dynmap support storage:
mode: file
# Storage mode to use: sqlite, file, mysql. If you are dealing with lots of players, please use a mysql database. sql: # SQL settings host: localhost
# If you are in a docker container, please use the docker IP. Should be something like 172.18.0.1 for pterodactyl users. port: 3306
db: RPGRegions
user: user
pass: pass
server:
tabcomplete:
search-offline-players: true
# Show offline players in tab completion results. discoveries:
discovered:
name-colour: GREEN
# The colour of item titles in the discovery GUI title:
fadein: 20
stay: 60
fadeout: 20
animation_speed: 20
# Controls how fast the animation moves to the next frame cooldown: 0
animation_sound: BLOCK_TRIPWIRE_CLICK_ON
# Sound to play during animation animation_sound_pitch: 1
sound:
name: UI_TOAST_CHALLENGE_COMPLETE
pitch: 1
undiscovered:
name-colour: RED
# The colour of undiscovered item titles in the discovery GUI date:
format: dd-MM-yyyy HH:mm:ss
# https://docs.oracle.com/en/java/javase/16/docs/api/java.base/java/text/SimpleDateFormat.html gui: # ! READ ME FIRST ! # RPGRegions allows full control of GUIs and thus configuration may be complex. # Please read about panes first: https://github.com/stefvanschie/IF/wiki/Panes and https://fortitude.islandearth.net/en/rpgregions-2/installation/configuration#panes # Please read about masks as well: https://fortitude.islandearth.net/en/rpgregions-2/installation/configuration#masks # The first pane (back) will be explained fully, as it has common values of all panes. # If you want to disable a pane, set `show` to `false`. # ! READ ME FIRST ! default_region_icon: TOTEM_OF_UNDYING
# Default icon of regions in the discovery GUI. Can reset icons with /rpgr forceupdateicons general:
rows: 6
# Amount of rows in the GUI back:
posX: 0
# Position on the X axis within the back pane posY: 5
# Position on the Y axis within the back pane length: 1
# Length of the pane (usually the amount of items present) height: 1
# Height of the pane back: ARROW
# Item to display forward:
posX: 8
posY: 5
length: 1
height: 1
forward: ARROW
exit:
posX: 4
posY: 5
length: 1
height: 1
command: ''
show: true
exit: BARRIER
pane:
posX: 1
posY: 1
length: 7
height: 4
outlinePane: # This is the outside pane posX: 0
posY: 0
length: 9
height: 6
show: true
mask: - '111111111'
- '100000001'
- '100000001'
- '100000001'
- '100000001'
- '111111111'
outlinePane: GRAY_STAINED_GLASS_PANE
# Item to fill the outline pane with innerPane: # This is the pane where all your regions are displayed posX: 1
posY: 1
length: 7
height: 4
show: true
mask: - '1111111'
- '1111111'
- '1111111'
- '1111111'
innerPane: WHITE_STAINED_GLASS_PANE
# Item to fill the inner pane with if no region to display worlds: # Do not touch this section unless you know what you're doing forceload: false
# Forcefully load worlds that do not exist for RPGRegions
Other There have been several fixes and changes to the way region titles work, especially in regards to the animation of titles. One specific bug fixed is that discovered titles were not working.
Translation files no longer need to be regenerated - we will force add keys that do not exist.
Many performance fixes and improvements to the codebase have been made.