Skip to content

Configuration

EspiDev edited this page Jul 28, 2019 · 28 revisions

Default Configuration (config.toml)

config_version = 6
uuidupdated = true
# Please do not change the config version unless you know what you are doing!

# ---------------------------------------------------------------------------------------
# Protection Stones Config
# Block configs have been moved to the blocks folder.
# To make new blocks, copy the default "block1.toml" and make another file (ex. "block2.toml")
# Does your config look messy? It's probably because of gradual config updates. Consider using the default configs.
# If you need the default configs again, you can get it from here: https://github.com/espidev/ProtectionStones/tree/master/src/main/resources
# ---------------------------------------------------------------------------------------


# Cooldown between placing protection blocks (in seconds). -1 to disable.
placing_cooldown = -1

# Set to true to not block server startup for loading the UUID cache.
# /ps add and /ps remove will not work for offline players until the cache is finished loading.
async_load_uuid_cache = false

# Whether or not to allow regions to have identical names (from /ps name).
# If this is set to true, players will have to use numbers after the name if they encounter duplicates.
allow_duplicate_region_names = false

# Time in seconds between /ps view attempts.
# Can prevent lag from spamming the command.
ps_view_cooldown = 20

# Base command for protection stones (change if conflicting with other commands)
base_command = "ps"

# Aliases for the command
aliases = [
    "pstone",
    "protectionstone",
    "protectionstones"
]

Default Configuration (block1.toml)

# Define your protection block below
# Use block type from here: https://hub.spigotmc.org/javadocs/spigot/org/bukkit/Material.html
type = "EMERALD_ORE"

# Another way to refer to the protection stone
# Can be used for /ps give and /ps get
# Must be one word (no spaces)
alias = "64"

# Whether or not to restrict obtaining of the protection stone to only /ps get and /ps give and custom crafting recipes.
# Other ways to obtain this block (ex. mining) will not work as a protection stone.
# Useful to allow the protection block to only be obtained from a shop or command.
# Set to "false" if you want to allow players to obtain a protection stone naturally
restrict_obtaining = true

# Enable or disable the use of this protection stone in specific worlds
# "blacklist" mode prevents this protect block from being used in the worlds in "worlds"
# "whitelist" mode allows this protect block to only be used in the worlds in "worlds"
# Can override with protectionstones.admin permission
world_list_type = "blacklist"
worlds = [
    "exampleworld1",
    "exampleworld2"
]

[region]
    # Minimum distance between claims (that aren't owned by the same owner), measured from the protection block to the edge of another region
    # You will probably have to change this between blocks, since the region sizes will be different
    # Set to -1 for no minimum, but will still check for overlapping regions
    distance_between_claims = -1

    # Protection radius of block
    # Set y_radius to -1 if you want it to protect from sky to bedrock. If this doesn't appear to work set it to 256.
    x_radius = 64
    y_radius = -1
    z_radius = 64

    # How many blocks to offset the default location of /ps home from the protection block
    home_x_offset = 0
    home_y_offset = 1
    home_z_offset = 0

    # Specify the default flags to be set when a new protected region is created.
    flags = [
        "pvp deny",
        "greeting &lEntering &b&l%player%'s &f&lprotected area",
        "farewell &lLeaving &b&l%player%'s &f&lprotected area",
        "greeting-title Entering &b%player%'s &fprotected area",
        "farewell-title Leaving &b%player%'s &fprotected area",
        "creeper-explosion deny",
    ]

    # List all the flags that can be set by region owners. Separate them with a comma, no space.
    allowed_flags = [
        "use",
        "pvp",
        "greeting",
        "greeting-title",
        "farewell",
        "farewell-title",
        "mob-spawning",
        "creeper-explosion",
    ]

    # Default priority type for this block type protection stone
    priority = 0

[block_data]
    # Name given to protection block when obtained with /ps give or /ps get
    # Leave as '' for no name
    display_name = "&a&m<---&r&b 64x64 Protection Stone &r&a&m--->"

    # Lore given to protection block when obtained with /ps give or /ps get
    # Leave as [] for no lore
    lore = [
        "&6(⌐■_■)ノ♪ Nobody's going to touch my stuff!",
    ]

    # Add price when using /ps get
    # Must have compatible economy plugin (requires Vault, ie. Essentials)
    price = 0.0

    # Whether or not to allow crafting this item using a custom recipe
    # Useful to allow crafting the item when restrict_obtaining is set to true
    allow_craft_with_custom_recipe = false
    # Specify the custom crafting recipe below
    # You must fill the item spots with names from here: https://hub.spigotmc.org/javadocs/spigot/org/bukkit/Material.html
    # If you want air, you can just leave the spot as ""
    custom_recipe = [
        ["", "STONE", ""],
        ["STONE", "EMERALD", "STONE"],
        ["", "STONE", ""]
    ]
    # Amount of the protection item to give when crafted
    recipe_amount = 1

[behaviour]
    # Hide protection stone right away when placed?
    auto_hide = false

    # Disable returning the block when removed/unclaimed?
    no_drop = false

    # Prevents piston pushing of the block. Recommended to keep as true.
    prevent_piston_push = true

    # Prevents the block from being destroyed when exploded.
    # Recommended to keep true to prevent players from exploiting more protection stones with /ps unhide (when the block is destroyed)
    prevent_explode = true

    # Destroys the protection stone region when block is exploded. Can be useful for PVP/Factions servers.
    # prevent_explode must be false for this to work.
    destroy_region_when_explode = false

    # Silk Touch: if true, ore-blocks that are also configured by ProtectionStones will disallow Silk Touch drops
    # This was the old behaviour to prevent natural obtaining of the protection stone.
    # Recommended to keep false if "Restrict Obtaining" (the new way) is true
    prevent_silk_touch = false

[player]
    # Whether or not to prevent teleporting into a protected region if the player doesn't own it (except with ender pearl and chorus fruit)
    # Does not prevent entry, use the flag "entry deny" for preventing entry.
    # Bypass with protectionstones.tp.bypasstp
    prevent_teleport_in = false

    # Can't move for x seconds before teleporting with /ps home or /ps tp. Can be disabled with 0.
    # Option to teleport only if player stands still.
    # Can override with permission protectionstones.tp.bypasswait
    no_moving_when_tp_waiting = true
    tp_waiting_seconds = 0

    # Extra permission required to place this specific protection block (you still need protectionstones.create)
    # '' for no extra permission
    permission = ''

[event]

    # Events section
    # ~~~~~~~~~~~~~~
    # For each line on events, it is the format 'type: action'
    # The following are accepted types:
    # player_command - Execute command by player that caused event (won't execute if not applicable)
    # console_command - Execute command by console
    # message - Send message to player or console if applicable (colour support with &)
    # global_message - Send message to all players and console (colour support with &)

    # ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
    # Whether or not to enable event tracking (API events will still be enabled)
    enable = false

    # Execute commands when a region is created (ex. player place protection block)
    on_region_create = [
        'global_message: &l%player% created the region %region%!',
    ]

    # Execute commands when a region is destroyed (ex. when player destroy protection block)
    on_region_destroy = [
        'console_command: say %player% has destroyed region %region%!',
    ]

Default messages.yml

        cooldown: '&6Warning: &7Please wait for %time% seconds before placing again!'
no_such_command: '&cNo such command. please type /ps help for more info'
no_access: '&cYou are not allowed to do that here.'
no_room_in_inventory: '&cYou don''t have enough room in your inventory.'
invalid_block: '&cInvalid protection block.'
not_enough_money: '&cYou don''t have enough money! The price is %price%.'
invalid_world: '&cInvalid world.'
must_be_player: '&cYou must be a player to execute this command.'
help: |-
  &8&m=====&r PS Help &8&m=====
  &b> &7/ps help
command_requires_player_name: '&cThis command requires a player name.'
no_permission_toggle: '&cYou don''t have permission to use the toggle command.'
no_permission_create: '&cYou don''t have permission to place a protection block.'
no_permission_destroy: '&cYou don''t have permission to destroy a protection block.'
no_permission_members: '&cYou don''t have permission to use member commands.'
no_permission_owners: '&cYou don''t have permission to use owner commands.'
no_permission_admin: '&cYou do not have permission to use that command.'
no_permission_count: '&cYou do not have permission to use that command.'
no_permission_count_others: '&cYou do not have permission to use that command.'
no_permission_flags: '&cYou do not have permission to use flag commands.'
no_permission_per_flag: '&cYou do not have permission to use that flag.'
no_permission_unhide: '&cYou do not have permission to unhide protection blocks.'
no_permission_hide: '&c You do not have permission to hide protection blocks.'
no_permission_info: '&cYou do not have permission to use the region info command.'
no_permission_priority: '&cYou do not have permission to use the priority command.'
no_permission_region: '&cYou do not have permission to use region commands.'
no_permission_tp: '&cYou do not have permission to teleport to other players'' protection
  blocks.'
no_permission_home: '&cYou do not have permission to teleport to your protection blocks.'
no_permission_unclaim: '&cYou do not have permission to use the unclaim command.'
no_permission_view: '&cYou do not have permission to use the view command.'
no_permission_give: '&cYou do not have permission to use the give command.'
no_permission_get: '&cYou do not have permission to use the get command.'
no_permission_sethome: '&cYou do not have permission to use the sethome command.'
no_permission_list: '&cYou do not have permission to use the list command.'
no_permission_list_others: '&cYou do not have permission to use the list command for
  others.'
no_permission_name: '&cYou do not have permission to use the name command.'
no_permission_setparent: '&cYou do not have permission to use the setparent command.'
no_permission_setparent_others: '&cYou do not have permission to inherit from regions
  you don''t own.'
psregion:
  added_to_region: '&b%player%&7 has been added to this region.'
  removed_from_region: '&b%player%&7 has been removed from region.'
  not_in_region: '&cYou are not in a protection stones region!'
  player_not_found: '&cPlayer not found.'
  not_ps_region: '&cNot a protection stones region.'
  region_does_not_exist: '&cRegion does not exist.'
  no_regions_owned: '&cYou don''t own any protected regions in this world!'
  no_region_permission: '&cYou do not have permission to do this in this region.'
  protected: '&bThis area is now protected.'
  no_longer_protected: '&eThis area is no longer protected.'
  cant_protect_that: '&cYou can''t protect that area.'
  reached_region_limit: '&cYou can not create any more protected regions.'
  reached_per_block_region_limit: '&cYou can not create any more regions of this type.'
  world_denied_create: '&cYou can not create protections in this world.'
  region_overlap: '&cYou can not place a protection block here as it overlaps another
    region.'
  region_too_close: '&cYour protection block must be a minimum of %num% blocks from
    the edge of other regions!'
  cant_teleport: '&cYour teleportation was blocked by a protection region!'
  specify_id_instead_of_alias: |-
    &7There were multiple regions found with this name! Please use an ID instead.
     Regions with this name: &b%regions%
toggle:
  help: '&b> &7/ps toggle'
  help_desc: Use this command to turn on or off placement of protection blocks.
  toggle_on: '&bProtection block placement turned on.'
  toggle_off: '&bProtection block placement turned off.'
count:
  count_help: '&b> &7/ps count [player (optional)]'
  count_help_desc: Count the number of regions you own or another player.
  personal_region_count: '&7Your region count in this world: &b%num%'
  other_region_count: '&7%player%''s region count in this world: &b%num%'
flag:
  help: '&b> &7/ps flag [flagname] [value|null|default]'
  help_desc: Use this command to set a flag in your protected region.
  flag_set: '&b%flag%&7 flag has been set.'
  flag_not_set: '&b%flag%&7 flag has &cnot&7 been set. Check your values again.'
visibility:
  hide_help: '&b> &7/ps hide'
  hide_help_desc: Use this command to hide or unhide your protection block.
  unhide_help: '&b> &7/ps unhide'
  unhide_help_desc: Use this command to hide or unhide your protection block.
  already_not_hidden: '&7The protection stone doesn''t appear hidden...'
  already_hidden: '&7The protection stone appears to already be hidden...'
info:
  help: '&b> &7/ps info members|owners|flags'
  help_desc: Use this command inside a ps region to see more information about it.
  header: '&8&m=====&r PS Info &8&m====='
  members: '&9Members: &7'
  no_members: '&c(no members)'
  owners: '&9Owners: &7'
  no_owners: '&c(no owners)'
  flags: '&9Flags: &7'
  region: '&9Region: &b'
  priority: '&9Priority: &b'
  parent: '&9Parent: &b'
  bounds: '&9Bounds: &b'
priority:
  help: '&b> &7/ps priority [number|null]'
  help_desc: Use this command to set your region's priority.
  info: '&7Priority: %priority%'
  set: '&ePriority has been set.'
  error: '&cError parsing input, check it again?'
region:
  help: '&b> &7/ps region [list|remove|disown] [playername]'
  help_desc: Use this command to find information or edit other players' (or your
    own) protected regions.
  not_found_for_player: '&7No regions found for %player% in this world.'
  list: '&7%player%''s regions in this world: &b%regions%'
  remove: '&e%player%''s regions have been removed in this world.'
  error_search: '&cError while searching for %player%''s regions. Please make sure
    you have entered the correct name.'
tp:
  help: '&b> &7/ps tp [player] [num]'
  help_desc: Teleports you to one of a given player's regions.
  number_above_zero: '&cPlease enter a number above 0.'
  valid_number: '&cPlease enter a valid number.'
  only_has_regions: '&c%player% only has %num% protected regions in this world!'
  tping: '&aTeleporting...'
  error_name: '&cError in teleporting to protected region! (parsing WG region name
    error)'
  error_tp: '&cError in finding the region to teleport to!'
  in_seconds: '&7Teleporting in &b%seconds%&7 seconds.'
  cancelled_moved: '&cTeleport cancelled. You moved!'
home:
  help: '&b> &7/ps home [name/id]'
  help_desc: Teleports you to one of your protected regions.
unclaim:
  help: '&b> &7/ps unclaim'
  help_desc: Use this command to pickup a placed protection stone and remove the region.
view:
  help: '&b> &7/ps view'
  help_desc: Use this command to view the borders of a protected region.
  cooldown: '&cPlease wait a while before using /ps view again.'
  generating: '&7Generating border...'
  generate_done: '&aDone! The border will disappear after 30 seconds!'
  removing: |-
    &bRemoving border...
    &aIf you still see ghost blocks, relog!
admin:
  help: |-
    &b> &7/ps admin { version | hide | unhide | cleanup | flag |
    &7         lastlogon | lastlogons | stats | fixregions }
  help_desc: This is an admin command showing different stats and allowing to override
    other player's regions.
  cleanup_help: '&b> &7/ps admin cleanup [remove|disown] [days] [world (console)]'
  cleanup_header: |-
    &eCleanup %arg% %days% days
    ================
  cleanup_footer: |-
    &e================
    Completed %arg% cleanup.
  hide_toggled: '&eAll protection stones have been %message% in this world.'
  last_logon: '&e%player% last played %days% days ago.'
  is_banned: '&e%player% is banned.'
  error_parsing: '&cError parsing days, are you sure it is a number?'
  console_world: '&cPlease specify the world as the last parameter.'
  lastlogons_header: |-
    &e%days% Days Plus:
    ================
  lastlogons_line: '&e%player% %time% days'
  lastlogons_footer: |-
    &e================
    %count% Total Players Shown
    %checked% Total Players Checked
  flag_help: '&b> &7/ps admin flag [world] [flagname] [value|null|default]'
reload:
  help: '&b> &7/ps reload'
  help_desc: Reload settings from the config.
  start: '&bReloading config...'
  complete: '&bCompleted config reload!'
addremove:
  help: '&b> &7/ps add|remove [playername]'
  help_desc: Use this command to add or remove a member of your protected region.
  owner_help: '&b> &7/ps addowner|removeowner [playername]'
  owner_help_desc: Use this command to add or remove an owner of your protected region.
get:
  help: '&b> &7/ps get [block]'
  help_desc: Use this command to get or purchase a protection block.
  gotten: '&bAdded protection block to inventory!'
give:
  help: '&b> &7/ps give [block] [player]'
  help_desc: Use this command to give a player a protection block.
  given: '&7Gave &b%block%&7 to &b%player%&7.'
  no_inventory_room: '&cThe player does not have enough inventory room.'
sethome:
  help: '&b> &7/ps sethome'
  help_desc: Use this command to set the home of a region to where you are right now.
  set: '&7The home for &b%psid%&7 has been set to your location.'
list:
  help: '&b> &7/ps list [player (optional)]'
  help_desc: Use this command to list the regions you, or another player owns.
  header: '&8&m=====&r %player%''s Regions &8&m====='
  owner: '&7Owner of:'
  member: '&7Member of:'
name:
  help: '&b> &7/ps name [name|none]'
  help_desc: Use this command to give a nickname to your region, to make identifying
    your region easier.
  removed: '&7Removed the name for %id%.'
  set_name: '&7Set the name of %id% to &b%name%&7.'
  taken: '&7The region name &b%name%&7 has already been taken! Try another one.'
setparent:
  help: '&b> &7/ps setparent [region|none]'
  help_desc: Use this command to allow this region to inherit properties from another
    region (owners, members, flags, etc.).
  success: '&7Successfully set the parent of &b%id%&7 to &b%parent%&7.'
  success_remove: '&7Successfully removed the parent of &b%id%&7.'
  circular_inheritance: '&cDetected circular inheritance (the parent already inherits
    from this region?). Parent not set.'
Clone this wiki locally