AreaShop Config

# ╔════════════════════════════════════════════════════════════════════════════════════════════════════════════════════════════╗
# ║ config.yml file of the AreaShop plugin created by NLThijs48, Github can be found at https://github.com/NLthijs48/AreaShop. ║
# ║ This file contains options to change the working of the plugin, the profiles defined here can be used in default.yml.      ║
# ║ More information and tutorials can be found on the wiki: https://github.com/NLthijs48/AreaShop/wiki                        ║
# ╚════════════════════════════════════════════════════════════════════════════════════════════════════════════════════════════╝
# ┌────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────┐
# │ GENERAL: Options that influence the global state of the plugin                                                             │
# └────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────┘
## Chatprefix used for all messages in the chat, also changes the greeting messages.
chatPrefix: '&2[AreaShop]&r '
## The language file that should be used, check the 'lang' folder for build-in languages (use the filename without .yml here).
## More information can be found here: https://github.com/NLthijs48/AreaShop/wiki/Language-support.
language: EN
## The tags that need to be written on the first line of a sign to use it with AreaShop.
signTags:
  ## Add a rental region.
  rent: '[asrent]'
  ## Add a buy region.
  buy: '[asbuy]'
  ## Add a sign to an existing region.
  add: '[as]'

# ┌────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────┐
# │ NUMBERS: Options to change the display of prices.                                                                          │
# └────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────┘
## The characters displayed before a price.
moneyCharacter: '$'
## The characters displayed after a price.
moneyCharacterAfter: ''
## How many numbers behind the dot should be shown (2 will make numbers like '8.55', '9.01', '5,20').
fractionalNumbers: 2
## Set this to true if you want to hide '.0' for a number like '15.0' ('4.50' will still stay '4.50').
hideEmptyFractionalPart: true
## Use metric suffixes if the price is above this number (use 1.00M instead of 1000000.00 etc.), use -1 to disable.
## Indications are used as defined on: http://en.wikipedia.org/wiki/Metric_prefix, implemented from 'k' to 'Y'.
metricSuffixesAbove: 1000000.0
## The character(s) to use as decimal mark.
decimalMark: '.'


# ┌────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────┐
# │ RENTING: Options that apply to all rent regions.                                                                           │
# └────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────┘
## Timeformat to use on the signs, default is like '30-06 14:52', US format: 'MM-dd KK:mm a'.
## Search for 'java SimpleDateFormat' for more options and documentation.
timeFormatSign: 'MM-dd HH:mm'
## Timeformat used in the chat, default is like '30 june 2014 14:52', US format: 'MMMMMMMMMMMMMMMMM dd yyyy KK:mm a'.
## Search for 'java SimpleDateFormat' for more options and documentation.
timeFormatChat: 'dd MMMMMMMMMMMMMMMMM yyyy HH:mm'
## Time indicators, used for specifing time periods (for example rent duration).
seconds: [s, sec, secs, second, seconds]
minutes: [m, min, mins, minute, minutes]
hours: [h, hour, hours]
days: [d, day, days]
weeks: [w, week, weeks]
months: [M,  month,  months]
years: [y, year, years]
## Allow or disallow extending a rental region when the player is above his limits enforced by the 'limitGroups' section below.
## false will ensure a player will eventually lose his region when he has no access anymore.
allowRegionExtendsWhenAboveLimits: false


# ┌────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────┐
# │ PERMISSION GROUPS: Assigned by giving players certain permissions.                                                         │
# └────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────┘
## Configure the max total regions, max rent regions and max buy regions with different groups (-1 is unlimited).
## Assign a group to players by giving them the permission 'areashop.limits.<group>'.
## Every player already has the group 'default', OPs bypass the limits because of the 'areashop.limitbypass' permission.
## All the groups applied to the player will be checked and only if they all allow an extra region it will be permitted.
## Add a 'worlds' or 'groups' list to a group to only count regions from those worlds and/or groups.
## Give players permissions globally and not world specific! This ensures renting/buying while in another world works correctly.
## More information can be found here: https://github.com/NLthijs48/AreaShop/wiki/Limitgroups-information-and-examples.
limitGroups:
  default:
    total: 3
    rents: 3
    buys: 3
  Moderator:
    total: 3
    rents: 3
    buys: 3
  SeniorModerator:
    total: 5
    rents: 5
    buys: 5
  Admin:
    total: 7
    rents: 7
    buys: 7
  Owner:
    total: 20
    rents: 20
    buys: 20
  CoOwner:
    total: 20
    rents: 20
    buys: 20
  notavailable:
    total: 0
    rents: 0
    buys: 0
  buildsite:
    total: 1
    rents: 1
    buys: 0
    groups:
    - 'buildsite'
# ┌────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────┐
# │ PROFILES: Assigned in general (default.yml), for a group (groups.yml) or individually (<region>.yml)                       │
# └────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────┘
## The idea of profiles is that you can make different variations of them, and then assign the different variations to different
## subsects of regions (by assigning a profile to a region group, or an individual region).

## Below is a list of tags that can be used in all settings of profiles.
## If a tag has no value (for example %player% when the region is not rented/bought) then the tag will not get replaced.
## %region%         The region name (with correct capitalization).
## %player%         The name of the player that rents/buys the region (with correct capitalization).
## %uuid%           The UUID of the player that rents/buys the region.
## %friends%        The names of friends added to this region separated by ', '.
## %friendsuuid%    The UUID's of friends added to this region separated by ', '.
## $landlord$       The name of the landlord.
## %landlorduuid%   The UUID of the landlord.
## %price%          The price of the region formatted with the configured characters before and after the number.
## %rawprice%       The price without formatting, like '10.0' or '7.77'.
## %duration%       The duration of a rent region, for example '1 d', '4 minutes' or '2 years'.
## %world%          The name of the world that the region is in.
## %type%           The type of the region, 'rent' or 'buy'.
## %until%          The end time of a rent formatted as configured with 'timeFormatChat'.
## %untilshort%     The end time of a rent formatted as configured with 'timeFormatSign'.
## %width%          The width of the region (amount of blocks on the x-axis).
## %depth%          The depth of the region (amount of blocks on the z-axis).
## %height%         The height of the region (amount of blocks on the y-axis).
## %timeleft%       The time left on the rent (uses the unit of time that fits best, minutes used from 121 seconds till 120 minutes).
## %clicker%        The name of the player that clicked the sign (only to be used in the signProfiles section).
## %resellprice%    The price of a region when it is in resell mode.
## %rawresellprice% The resellprice without formatting, like '10.0' or '7.77'.
## %moneyback%      The amount of money the player will get back when unrenting/selling the region (formatted with currency layout).
## %rawmoneyback%   The moneyback without formatting, like '10.0' or '7.77'.
## %moneybackpercent% The percentage of the price the player will get back when unrenting the region.
## %maxextends%     The maximum number of extends a player can do on the region.
## %extendsleft%    The number of extends that are left (maxextends - timesextended).
## %maxrenttime%    The maximum time you can rent a region in advance (human readable).
## %inactivetime%   The maximum time a player may be inactive before unrent/sell (human readable).
## %year%           The current year.
## %month%          The current month in the year.
## %day%            The current day in the month.
## %hour%           The current hour in the day (0-23).
## %minute%         The current minute of the hour.
## %second%         The current second of the minute.
## %millisecond%    The current millisecond of the second.
## %epoch%          The number of milliseconds since January 1, 1970 (Unix Epoch).

## Determines the layout and functions of the signs linked to regions.
## Set 'general.signProfile' in default.yml, groups or individual regions to set the profile.
signProfiles:
  default:
    ## The following sections can be added for performing certain commands when the sign is clicked:
    ## rightClickPlayer, rightClickConsole, shiftRightClickPlayer, shiftRightClickConsole,
    ## leftClickPlayer, leftClickConsole, shiftLeftClickPlayer, shiftLeftClickConsole.
    ## Sections with 'Player' at the end will be run by the player that clicks the sign and 'Console' ones from the console.
    forrent:
      line1: '&2&l[For Rent]'
      line2: '%region%'
      line3: '%duration%'
      line4: '%price%'
      rightClickPlayer:
      - 'areashop rent %region%'
      leftClickPlayer:
      - 'areashop info region %region%'
    rented:
      line1: '&4&l[Rented]'
      line2: '%region%'
      line3: '%player%'
      line4: '%timeleft%'
      rightClickPlayer:
      - 'areashop rent %region%'
      leftClickPlayer:
      - 'areashop info region %region%'
      shiftRightClickPlayer:
      - 'areashop unrent %region%'
    forsale:
      line1: '&2&l[For Sale]'
      line2: '%region%'
      line3: '%price%'
      line4:
      rightClickPlayer:
      - 'areashop buy %region%'
      leftClickPlayer:
      - 'areashop info region %region%'
    resell:
      line1: '&9&l[Resale]'
      line2: '%region%'
      line3: '%resellprice%'
      line4: '&8%player%'
      rightClickPlayer:
      - 'areashop buy %region%'
      leftClickPlayer:
      - 'areashop info region %region%'
      shiftRightClickPlayer:
      - 'areashop stopresell %region%'
    sold:
      line1: '&4&l[Sold]'
      line2: '%region%'
      line3: '%player%'
      line4:
      rightClickPlayer:
      - 'areashop buy %region%'
      leftClickPlayer:
      - 'areashop info region %region%'
      shiftRightClickPlayer:
      - 'areashop sell %region%'
## Option to run certain commands when a region event happens.
## Commands at a 'before' section will execute before the region details are changed in the AreaShop system
## and before any other actions occurred (setting the owner, saving/loading schematics, etc.),
## the 'after' commands will be run when all changes are done.
## After 'before' or 'after' you can add a list of commands (see example at the created event).
eventCommandProfiles:
  default:
    created:
      before:
      after:
    ##  - "say An AreaShop region has been created: %region%"
    deleted:
      before:
      after:
    rented:
      before:
      after:
    extended:
      before:
      after:
    unrented:
      before:
      after:
    bought:
      before:
      after:
    sold:
      before:
      after:
    resell:
      before:
      after:
  buildsite:
    created:
      before:
      after:
    deleted:
      before:
      after:
    rented:
      before:
      after:
      - "as setowner %player% %region%lower"
    extended:
      before:
      after:
      - "as setowner %player% %region%lower"
    unrented:
      before:
      after:
      - "as unrent %region%lower"
    bought:
      before:
      after:
      - "as setowner %player% %region%lower"
    sold:
      before:
      after:
      - "as sell %region%lower"
    resell:
      before:
      after:
## For the following events you can specify if you want to restore or save the region to a schematic.
## After 'save:' or 'restore:' you enter the name of the file to restore from/to.
## If you want your regions all looking the same then you can leave out the %region% part to use the same schematic for all.
## The limit 'maximumBlocks' applies to restoring/saving schematics, be sure your regions are below the limit.
## More information can be found here: https://github.com/NLthijs48/AreaShop/wiki/Region-blocks-save-restore.
schematicProfiles:
  default:
    created:
      save: '%type%-%region%'
      restore: ''
    deleted:
      save: ''
      restore: '%type%-%region%'
    rented:
      save: '%type%-%region%'
      restore: ''
    unrented:
      save: ''
      restore: '%type%-%region%'
    bought:
      save: '%type%-%region%'
      restore: ''
    sold:
      save: ''
      restore: '%type%-%region%'
    resell:
      save: ''
      restore: ''
## Flag profiles to specify which flags should be set on the WorldGuard regions when the region is in a certain state.
## All normal region flags as present in WorldGuard can be used, and also members, owners, priority and parent.
## Each line represents a WorldGuard setting that should be set to a certain value when the region is in the specified state.
## The members and owners flag normally take a list of UUID's separated by 'comma space', adding by name is possible with 'n:<name>'.
## You can add groups by using 'g:<groupname>', so in total you could use: '%uuid%, %friendsuuid%, g:vip, n:coolGuy'.
## For flags like 'entry' and 'exit' you can add group setting by using 'g:<scope>' behind it, <scope> is one of the following:
## members, non_members, owners, non_owners, all. Example, only members can enter the region:
##   entry: 'deny g:non_members'
## Use '' for a flag to reset it.
flagProfiles:
  default:
    forrent:
      priority: 10 # Set region priority higher than default regions (it must be higher than other regions at the same place)
      members: '' # Remove all members.
      greeting: '%lang:prefix%%lang:greeting-forrent%'
    rented:
      priority: 10
      members: '%uuid%, %friendsuuid%' # Add the renter and added friends as region members.
      greeting: '%lang:prefix%%lang:greeting-rented%'
      interact: 'deny g:non_members' # Only allow region members/owners to use things in the region (chests, crafting bench, etc)
      build: 'deny g:non_members' # Only allow region members/owners to build (change to 'deny' to disallow building)
    forsale:
      priority: 10
      members: ''
      greeting: '%lang:prefix%%lang:greeting-forsale%'
    sold:
      priority: 10
      members: '%uuid%, %friendsuuid%'
      greeting: '%lang:prefix%%lang:greeting-bought%'
      interact: 'deny g:non_members'
      build: 'deny g:non_members'
    resale:
      priority: 10
      members: '%uuid%, %friendsuuid%'
      greeting: '%lang:prefix%%lang:greeting-resale%'
      interact: 'deny g:non_members'
      build: 'deny g:non_members'
## Profiles that specify when players should get messages about their rental region that almost runs out.
## Time identifiers specify how much time before the rent is actually over the player should be notified.
## When warnPlayer is set to true a message will be send that is specified in the language file.
## All commands in the list below 'commands:' will execute together with the warning, all normal variables can be used.
expirationWarningProfiles:
  default:
    "1 day":
      warnPlayer: true
      commands:
    ##  - "say %region% is about to expire for %player%: %timeleft% left"
    "1 hour":
      warnPlayer: true
      commands:
    "5 minutes":
      warnPlayer: true
      commands:


# ┌────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────┐
# │ ADVANCED AND DEBUG: Specific options to tweak the plugin precisely and check if it functions correctly.                    │
# └────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────┘
## Blacklist of region names that cannot be added to AreaShop for renting or buying. Regular expressions can be used, search
## for 'java regex pattern' to find documentation about how to use it.
## Example: Blocking all regions that have a name like 'house_1', 'house_2', etc. would be done with 'house_\d+'.
## The '\d' represents the numerical digits 0-9, the + symbol represents 1 or more times repeated.
## This means it would also block 'house_123' and 'house_000456'. It will not block 'ahouse_1' or 'house_'.
blacklist:
  - '__global__' # Would give access to the complete world, and is therefore not a good idea to ever add.
## Minimum length of the numbers that are suffixed for region names generated by the '/as stack' command.
## When having this at 3 it will generate names like this: 'region-001', 'region-014', 'region-4567'.
stackRegionNumberLength: 3
# Allow/disallow adding players that did not visit the server yet as friend of a region.
addFriendNotExistingPlayers: false
## Enable sending stats to http://mcstats.org/ (Metrics plugin).
## This information will give me an indication about how much the plugin is used and encourages me to continue development.
sendStats: true
## If enabled it will check for updates when loading the plugin, it will never download files, it will only notify about it
## A message will be printed in the console when an update is available and OPs will be notified when joining the server.
checkForUpdates: true
## Use colors when sending messages to console and log files.
useColorsInConsole: false
## Post error messages in the console when a command run from the config fails (from the 'runCommands' section for example).
postCommandErrors: true
## Update all region flags and signs after starting the plugin (uses the 'regionsPerTick' setting from the 'update' section).
## This ensures that changes to the config are directly visible after restarting the server.
updateRegionsOnStartup: true
## Enables / disables debug messages in the console, could be useful to figure out where errors come from.
debug: false
## Version of the config, do not change!
version: 2.2.2


# ┌────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────┐
# │ LIMITS AND TIMINGS: Options for limits and the frequencies for certain functions (be very careful with these!).            │
# └────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────┘
## Maximum number of blocks to save to or restore from a .schemetic.
maximumBlocks: 5000000
## Maximum number of locations the teleport function should check to find a safe spot.
maximumTries: 50000

## Setting the 'delay' setting to 0 or lower will prevent the taks from runnning, if you don't use a certain feature you
## could switch the task off this way.
## The 'delay' settings are specified using a number followed by one of the identifiers as defined above in the config.
## The 'regionsPerTick' settings are to configure how fast something goes, lower value is less lag, but slower updates.
## There are 20 ticks in 1 second, so if you set 'regionPerTick' to 5, then 5*20=100 regions per second will be updated.

## Timings for saving files that need saving.
saving:
  delay: '10 minutes'
  regionsPerTick: 1
## Timings for rent expiration checking.
expiration:
  delay: '59 seconds'
  regionsPerTick: 5
## Timings for expiration warning to online players.
expireWarning:
  delay: '5 minutes'
  regionsPerTick: 5
## Timings for updating signs and region flags ('/as reload' or after '/as groupadd' or '/as groupdel').
update:
  regionsPerTick: 5
## Time between checking if any regions need to be unrented because the player was not online for the specified time period.
inactive:
  delay: '15 minutes'
  regionsPerTick: 5
## Timings for the periodic updating of signs (for timeleft tags etc).
signs:
  delay: '3600 seconds'
  regionsPerTick: 3
## Number of regions per tick to check when a player joins to see if his name changed for regions he owned (updates the regions when changed).
nameupdate:
  regionsPerTick: 10
## Timings for adding regions to AreaShop ('/as stack').
adding:
  regionsPerTick: 2