Configuration
Configuration Settings
Run Once First
If you would like to change the basic settings then simply run the plugin once so it creates it's config.yml file then edit the file to change the settings, and then reload the plugin to allow the settings to take effect. The changes only effect newly protected regions and will not effect old ProtectionStone Regions.
ProtectionStones Has The Following Settings:
PS (WorldGuard) Region Flags
Here are some examples of the WorldGuard Region Flags (all are currently able to be set):
Flag.chest-access: (ALLOW/DENY) CHEST-ACCESS Flag set to DENY by default, if set to DENY only the ProtectionStone Owner and Members can use chests in the region.
Flag.entry: (ALLOW/DENY) ENTRY Flag set to ALLOW by Default, if set to DENY only the ProtectionStone Owner and Members can enter the region.
Flag.mob-spawning: (ALLOW/DENY) MOB-SPAWNING Flag set to DENY by default, if set to DENY mobs won't spawn in the region.
Flag.pvp: (ALLOW/DENY) PVP Flag set to DENY by default, if set to DENY PVP is turned off in the region.
Flag.use: (ALLOW/DENY) USE Flag set to DENY by default, if set to DENY only the ProtectionStone Owner and Members can use items in the region.
Flag.greeting: Default GREETING Message Flag message for entering a region. This can use %player% and will replace this token with the player's name.
Flag.farewell: Default FAREWELL Message Flag message for leaving a region. This can use %player% and will replace this token with the player's name.
Visit WorldGuard for the complete list of WorldGuard Region Flags and more information.
PS (WorldGuard) Region Sizes
These are the default blocks that can be used, any block can be used and up to 16 block types, but admin beware what you select.
Blocks.COAL_ORE: Default is size 5 which creates a 11x11x11 region.
Blocks.LAPIS_ORE: Default is size 10 which creates a 21x21x21 region.
Blocks.DIAMOND_ORE: Default is size 20 which creates a 41x41x41 region.
The size number is the distance from the placement of the ProtectionStone (usually the center of the cube) to the outside edge.
Here is a list of all the valid Bukkit Names, many of these names are not blocks, but the blocks you may use.
Note: If you wish to use Redstone Ore use GLOWING_REDSTONE_ORE instead of REDSTONE_ORE, which is data item value 74 (not 73).
Additional Settings
Region.SKYBEDROCK: (overrides the Y-Axis of the created region) default is false, set to true and all regions will be created with a vertical area from sky down to bedrock. This does not effect the X-Axis or the Z-Axis Sizes.
Region.NODROP: Makes all ProtectionStones a single use block, default is false. If set to true, breaking a ProtectionStone removes your region but doesn't give you back the ProtectionStone.
Region.AUTOHIDE: Automatically hides ProtectionStones after placement, defaults to false.
Region.NOSILKTOUCH: Blocks Silk Touch Pickaxe Drops, default is false. If set to true, breaking most blocks in your ProtectionStone block list should return the normal item that is dropped. If you have Region.NOSILKTOUCH set to true and have COAL_ORE as one of your blocks then breaking it with a Silk Touch Pickaxe should return the normal piece of coal. Remember that some blocks always return an ore block, like GOLD_ORE and IRON_ORE. Only effects blocks in your list.
Region.BLOCKPISTONS If you set it to true, all blocks moved by pistons are checked to see if any of the blocks are in the ProtectionStones Blocks List (meaning a material that could be used as a PS), and if they are the piston won't move. This is set to false by default.
Region.LIMIT: Allows you to place a count limit on created regions, defaults to -1 which means no limits, -2 which means use Group Limits (see below), 0 means all block placement is temporarily blocked, any positive number is the maximum number of regions a player can create. This region limit includes all owned regions both ProtectionStones created regions and normal WorldGuard Regions.
Region.SAVETIMER: WorldGuard Regions for all worlds are saved on server restart or if the plugins are /reload(ed), but this setting allows for more flexibility.
-1 = Save after all PS region changes (which is the default setting and how older versions of PS work).
0 = Don't save PS region changes, which would only get saved on the restart or reload.
n = A number meaning how many minutes to wait until the next PS region save. This number is in minutes. Don't set it to low or you will cause large amounts of server lag, If you use this setting the first save happens five minutes after the server starts, and then once each time your time limit is reached.
Region.PRIORITYOVERRIDE: If set to true (default is false), players are allowed to place "sub-regions" within parent regions that have a priority level set to -1.
For example, a player called "townowner" would create a large PS protected region, then set other sub regions up to protect restricted areas in their town, for example, their home. Then "townowner" would use the "/ps priority -1" command to set the large "town" region's priority to the correct number to allow players to claim regions there.
Then "homeowner" would go to the town and place their PS to create their "plot" in the town.
Priority: Sets the WorldGuard Region Priority Level for all new PS Regions created (default is 0, which is the setting in older versions of PS).
Group Limits
To use Group Limits do the following:
1) Set Region.LIMIT to -2
2) Set your group block placement limits, there are nine groups. The defaults are below.
Group:
LIMIT1: 0
LIMIT2: 1
LIMIT3: 3
LIMIT4: 7
LIMIT5: -1
LIMIT6: 0
LIMIT7: 0
LIMIT8: 0
LIMIT9: 0
Just like the Region.LIMIT setting: -1 means unlimited blocks, 0 means no blocks can be placed.
3) Set your group block type limits, there are nine groups that work with with the limit groups above. The defaults are below.
BLOCKS1: COAL_ORE LAPIS_ORE DIAMOND_ORE
BLOCKS2: COAL_ORE LAPIS_ORE DIAMOND_ORE
BLOCKS3: COAL_ORE LAPIS_ORE DIAMOND_ORE
BLOCKS4: COAL_ORE LAPIS_ORE DIAMOND_ORE
BLOCKS5: COAL_ORE LAPIS_ORE DIAMOND_ORE
BLOCKS6: COAL_ORE LAPIS_ORE DIAMOND_ORE
BLOCKS7: COAL_ORE LAPIS_ORE DIAMOND_ORE
BLOCKS8: COAL_ORE LAPIS_ORE DIAMOND_ORE
BLOCKS9: COAL_ORE LAPIS_ORE DIAMOND_ORE
The blocks listed in the blocks must have a space between them if there is more than one. They must also appear in the Blocks Section of the config.yml. The Limit Number is the total PS/World Guard Regions the player in this group can own, the blocks are the only blocks that the player in this group can place.
4) Give your player permission in your permission plugin, only add them to one group. Here are the permissions all are defaulted to false:
protectionstones.group1, protectionstones.group2, protectionstones.group3, protectionstones.group4, protectionstones.group5, protectionstones.group6, protectionstones.group7, protectionstones.group8, protectionstones.group9
If you forget to set a player to a group in step #4 they will be set to zero ProtectionStones.
If you set a player to more than one group in step #4 they will be set to the first group that they have permissions for. So for best results always set your Group.Limit list in ascending order to protect against a player getting a higher block limit due to a multiple permissions mistake.
Exclusion.WORLDS: This is a list of worlds (seperated by spaces) to exclude from creating ProtectionStone Regions.
Exclusion.PLACEMENT: This option set to "false" will block the placement of ProtectionStones in excluded worlds and give a message about ProtectionStones not being allowed. If you set it to "true" blocks in the ProtectionStones block list are allowed to be placed but don't create ProtectionStone Regions. Both settings only effect worlds that have been added to the Exclusion.WORLDS List.
NOTE: Explosion.DETECTION has been removed due to conflicts with some updated plugins.
Don't forget to reload your server plugins to make the changes take effect.