Correct sound and material names must be used. Refer to the Spigot docs for more information:
Sounds: https://hub.spigotmc.org/javadocs/spigot/org/bukkit/Sound.html
Materials: https://hub.spigotmc.org/javadocs/spigot/org/bukkit/Material.html
¶ Main configuration
To enable legacy support for WorldGuard integrations, you will need to set the integration to
WorldGuard_Legacy.
settings.integration.name: name of protection plugin to use (default: WorldGuard*)
settings.storage.mode: type of storage to use, either file or sql (default: file)
settings.sql.host: IP of the sql server (default: localhost)
settings.sql.port: Port of the sql server (default: 3306)
settings.sql.db: database name to use (default: RPGRegions)
settings.sql.user: username to connect with (default: user)
settings.sql.password: password to connect with (default: pass)
settings.server.gui.*: individual gui pane settings
- The integration will be set automatically to whatever plugin can be found on your server, however will fallback to WorldGuard if no others are found.
¶ Default discovery settings
You can find out how to format dates here.
settings.server.discoveries.date.format: format of dates shown to users
settings.server.discoveries.discovered.title.fadein: title fadein time (Ticks)
settings.server.discoveries.discovered.title.stay: title stay time (Ticks)
settings.server.discoveries.discovered.title.fadeout: title fadeout time (Ticks)
settings.server.discoveries.discovered.sound.name: default sound to play
settings.server.discoveries.discovered.sound.pitch: pitch of sound
¶ Default language file (en_gb)
next_page: "&aNext Page"
previous_page: "&cPrevious Page"
regions: "Regions"
discovered_on: "&7Discovered on: %0"
discovered_title:
- "&d%0 discovered!"
discovered_subtitle:
- "&fKeep exploring to discover more!"
already_discovered_title:
- "&d%0 entered!"
already_discovered_subtitle:
- "&fAlready discovered!"
teleport: "&aClick to teleport"
cannot_teleport: "&cWe can't teleport you because that world doesn't exist!"
unknown_region: "Unknown Realm"
exit: "&cExit"
cannot_enter: "&cYou require %0 to enter this area."
previous_page_lore:
- "&fGo to the previous page"
next_page_lore:
- "&fGo to the next page"
exit_lore:
- "&fExit the GUI"
cooldown: "&cThat is currently on cooldown."
region_enter_actionbar: "&a%0"
¶ InventoryFramework configuration
RPGRegions takes advantage of InventoryFramework, an advanced GUI framework. Most of RPGRegion's GUIs are configurable via config.yml.
See the Inventory Framework Wiki for more information.
¶ Panes
Panes, put simply, are a section of the GUI. They can contain any number of items, and their position is determined by the posX and posY in the config.yml sections.
It is important the posY does not exceed that of the GUI as a whole.
It is also important the height does not exceed it either.
¶ Masks
Some panes can contain masks. Masks define where the items within a pane will be placed. An example is the outline pane:
- '111111111'
- '100000001'
- '100000001'
- '100000001'
- '100000001'
- '111111111'
This will place items all around the inventory border. 0 is empty and 1 is filled. It is important the length and height match that of the maximum inventory size.
¶ Reward types
See api for making your own rewards.
- PlayerCommandReward
- ConsoleCommandReward
- ExperienceReward
- ItemReward
- MessageReward
- MoneyReward
- AlonsoLevelReward
- QuestReward
- TeleportReward
- RegionDiscoverReward
¶ External reward types
These are rewards served by external plugins.
¶ NT-Rpg
- cz.neumimto.rpg.spigot.bridges.RpgRegionsClassExpReward
¶ Effect types
See api for making your own effects.
- PotionRegionEffect
¶ Requirement types
See api for making your own requirements.
- AlonsoLevelRequirement
- LevelRequirement
- DependencyRequirement
- MoneyRequirement
- PlaceholderRequirement
- PermissionRequirement
- QuestRequirement
¶ IconCommand's
An IconCommand looks like the following in your json files:
"iconCommand": [
{
"command": "say",
"clickType": "DISCOVERED",
"cooldown": 0
},
{
"command": "say command2",
"clickType": "UNDISCOVERED",
"cooldown": 0
}
]
The "command" value is the command to execute (supports placeholders), the "clickType" value is whether to run this command when clicked when the region is DISCOVERED by the player or UNDISCOVERED. The "cooldown" is how long, in ticks, a player has to wait to execute this command again.
¶ Region configs (.json)
Region configs are defined in a json file. These can be found under plugins/RPGRegions/regions/. An example file is created and updated every time the plugin starts (exampleconfig.json);
{
"world": null,
"id": "exampleconfig",
"customName": "ExampleConfig",
"rewards": [
{
"type": "net.islandearth.rpgregions.rewards.ExperienceReward",
"properties": {
"xp": 10
}
},
{
"type": "net.islandearth.rpgregions.rewards.ItemReward",
"properties": {
"item": {
"v": 2730,
"type": "IRON_BARS"
}
}
},
{
"type": "net.islandearth.rpgregions.rewards.PlayerCommandReward",
"properties": {
"command": "say I discovered a region!"
}
},
{
"type": "net.islandearth.rpgregions.rewards.ConsoleCommandReward",
"properties": {
"command": "say Server sees you discovered a region!"
}
},
{
"type": "net.islandearth.rpgregions.rewards.MessageReward",
"properties": {
"messages": [
"\u0026aExample message as a reward"
]
}
}
],
"sound": "AMBIENT_UNDERWATER_EXIT",
"icon": "WOODEN_AXE",
"undiscoveredIcon": "TOTEM_OF_UNDYING",
"iconCommand": [
{
"command": "say",
"clickType": "DISCOVERED",
"cooldown": 0
}
],
"showCoords": false,
"location": null,
"hints": [],
"showHint": false,
"teleportable": false,
"hidden": false,
"discoverable": true,
"effects": [
{
"type": "net.islandearth.rpgregions.effects.PotionRegionEffect",
"properties": {
"potionEffect": {
"type": "GLOWING",
"duration": 100,
"amplifier": 1,
"ambient": true,
"particles": true,
"icon": true
},
"wearingRequired": true,
"ignoreItems": [
{
"v": 2730,
"type": "IRON_CHESTPLATE"
}
],
"ignorePerm": true
}
}
],
"requirements": [],
"discoveredLore": [],
"alwaysShowTitles": false,
"title": null,
"subtitle": null,
"discoveredTitle": null,
"discoveredSubtitle": null,
"regenerate": {
"schematicName": null,
"origin": null,
"regenerateInterval": 50000,
"loadChunks": false,
"regeneratingEntities": [
{
"entityType": "SHULKER",
"validSpawnSurfaces": [
"PURPUR_BLOCK",
"PURPUR_PILLAR"
],
"maxPerChunk": 5,
"rarity": 30,
"isMythicEntity": false
}
],
"onDiscover": false,
"onlyEntities": true
},
"teleportCooldown": 0,
"showActionbar": true,
"colour": "13369344",
"lineColour": "13369344",
"dynmap": true
}
This file cannot be edited and will not be loaded at start.
This file will contain every single reward option available, so you can add them manually into your region configurations.
To automatically add reward configurations, there are some commands available.