From 540347247646f23a5f298d2602ea905a16d3c598 Mon Sep 17 00:00:00 2001 From: Thijs Wiefferink Date: Thu, 10 Dec 2015 23:16:19 +0100 Subject: [PATCH] Cleanup/update config.yml and default.yml comments - Add links to the wiki. - Make things more consistent. --- AreaShop/src/main/resources/config.yml | 112 +++++++++++------------- AreaShop/src/main/resources/default.yml | 57 ++++++------ 2 files changed, 78 insertions(+), 91 deletions(-) diff --git a/AreaShop/src/main/resources/config.yml b/AreaShop/src/main/resources/config.yml index 615eefc..d0060fe 100644 --- a/AreaShop/src/main/resources/config.yml +++ b/AreaShop/src/main/resources/config.yml @@ -1,6 +1,7 @@ # ╔════════════════════════════════════════════════════════════════════════════════════════════════════════════════════════════╗ # ║ 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 │ @@ -8,28 +9,29 @@ ## 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 you need to write on the sign to trigger the plugin. +## The tags that need to be written on the first line of a sign to use it with AreaShop. signTags: - ## Tag for adding a rent region. + ## Add a rental region. rent: '[asrent]' - ## Tag for adding a buy region. + ## Add a buy region. buy: '[asbuy]' - ## Tag for adding a sign to an existing region. + ## Add a sign to an existing region. add: '[as]' # ┌────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────┐ -# │ NUMBERS: Options to change the output of prices. │ +# │ NUMBERS: Options to change the display of prices. │ # └────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────┘ -## The characters displayed before a price, special characters like € can be used. +## The characters displayed before a price. moneyCharacter: '$' -## The characters displayed after a price, special characters like € can be used. +## 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'). +## 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 for disable. +## 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. @@ -46,7 +48,6 @@ timeFormatSign: 'dd-MM HH:mm' ## 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). -## Be careful with deleting words, will break settings using those, adding is no problem. seconds: [s, sec, secs, second, seconds] minutes: [m, min, mins, minute, minutes] hours: [h, hour, hours] @@ -54,8 +55,8 @@ days: [d, day, days] weeks: [w, week, weeks] months: [M, month, months] years: [y, year, years] -## Allow or disallow extending rental region when the player is above his limits enforced by the 'limitGroups' below. -## false will ensure a player will eventually lose his region when he has no access anymore (rankup with other limits for example) +## 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 @@ -64,11 +65,11 @@ allowRegionExtendsWhenAboveLimits: false # └────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────┘ ## 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.'. -## Every player already has the group 'default' and ops have the unlimited 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. -## This can be used to get different limits for other worlds or area's. -## Give players permissions globally and not per world! That would break limits when then try renting/buying from within another world. +## 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: 1 @@ -79,11 +80,14 @@ limitGroups: # ┌────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────┐ # │ PROFILES: Assigned in general (default.yml), for a group (groups.yml) or individually (.yml) │ # └────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────┘ -## Below is a list of tags that can be used with all the profiles below. -## If a tag has no value (for example when you use %player% when the region is not rented/bought) then the tag will not get replaced. +## 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), will not get replaced if no renter/buyer. -## %uuid% The uuid of the player that rents/buys the region, will not get replaced if no renter/buyer. +## %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 ', '. ## %price% The price of the region formatted with the configured characters before and after the number. @@ -100,9 +104,9 @@ limitGroups: ## %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 characters). +## %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 (only the number between 0-100). +## %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). @@ -116,14 +120,14 @@ limitGroups: ## %millisecond% The current millisecond of the second. ## %epoch% The number of milliseconds since January 1, 1970 (Unix Epoch). -## Below are profiles for the signs, you can assign profiles to regions -## by setting 'general.signProfile' in default.yml, groups or individual regions. +## 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 clicking player and 'Console' ones from the console. + ## 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%' @@ -175,17 +179,17 @@ signProfiles: - 'areashop info region %region%' shiftRightClickPlayer: - 'areashop sell %region%' -## Option to run certain commands when one of these events happen. +## 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 (changing signs, saving/loading schematics, etc.), +## 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 create a list of commands (see example at the created event). +## 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%" + ## - "say An AreaShop region has been created: %region%" deleted: before: after: @@ -210,8 +214,8 @@ eventCommandProfiles: ## 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. -## Be carefull with these options, it could crash your server or destroy (parts of) your world if used wrong! ## 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: @@ -235,34 +239,34 @@ schematicProfiles: resell: save: '' restore: '' -## Flag profiles to specify what flags should be set on the WorldGuard regions. +## 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:'. -## You can add groups by using 'g:', so in total you could use: '%uuid%, %friendsuuid%, g:vip, n:cool-guy'. +## You can add groups by using 'g:', 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:' behind it, is one of the following: -## members, non_members, owners, non_owners, all. Example, only owners can enter the region: -## entry: 'deny g:non_owners' +## 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: - members: '' + members: '' # Remove all members. greeting: '%lang:prefix%%lang:greeting-forrent%' rented: - members: '%uuid%, %friendsuuid%' + members: '%uuid%, %friendsuuid%' # Add the renter and added friends as region members. greeting: '%lang:prefix%%lang:greeting-rented%' forsale: - members: '' + members: '' # Remove all members. greeting: '%lang:prefix%%lang:greeting-forsale%' sold: - members: '%uuid%, %friendsuuid%' + members: '%uuid%, %friendsuuid%' # Add the buyer and added friends as region members. greeting: '%lang:prefix%%lang:greeting-bought%' resale: - members: '%uuid%, %friendsuuid%' + members: '%uuid%, %friendsuuid%' # Add the buyer and added friends as region members. greeting: '%lang:prefix%%lang:greeting-resale%' -## Profiles that specify when players should get messages about rent that almost run out. -## The numbers that start sections in the profile specify how time before it actually runs out it should be executed. +## 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: @@ -270,7 +274,7 @@ expirationWarningProfiles: "1 day": warnPlayer: true commands: - ## - "say %region% is about to expire for %player%: %timeleft% left" + ## - "say %region% is about to expire for %player%: %timeleft% left" "1 hour": warnPlayer: true commands: @@ -283,17 +287,16 @@ expirationWarningProfiles: # │ 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. The case-insensitive option is enabled because -## WorldGuard will return the correct region no matter what the casing is. +## 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__' + - '__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 +# 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. @@ -322,7 +325,7 @@ maximumBlocks: 1000000 ## 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 +## 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. @@ -330,43 +333,30 @@ maximumTries: 50000 ## Timings for saving files that need saving. saving: - ## Time between saving files that need to be saved (not all files will be saved by default). delay: '10 minutes' - ## How many regions per tick will be saved. regionsPerTick: 1 ## Timings for rent expiration checking. expiration: - ## Time between checking if rent regions have been expired. delay: '59 seconds' - ## Number of rent regions to check per tick. regionsPerTick: 5 ## Timings for expiration warning to online players. expireWarning: - ## The time between checking if expiration warning need to be sent. delay: '5 minutes' - ## Number of regions to update per tick. - regionsPerTick: 3 + regionsPerTick: 5 ## Timings for updating signs and region flags ('/as reload' or after '/as groupadd' or '/as groupdel'). update: - ## Number of regions to update per tick. regionsPerTick: 5 ## Time between checking if any regions need to be unrented because the player was not online for the specified time period. inactive: - ## Time between checking if a regions needs to be unrented/sold because of inactivity by the player. delay: '15 minutes' - ## Number of rent regions to check per tick. regionsPerTick: 5 ## Timings for the periodic updating of signs (for timeleft tags etc). signs: - ## Time between updates of all signs. delay: '60 seconds' - ## Number of regions to update signs for per tick. 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: - ## Number of regions to update signs for per tick. - regionsPerTick: 5 + regionsPerTick: 10 ## Timings for adding regions to AreaShop ('/as stack'). adding: - ## Number of regions to add per tick. regionsPerTick: 2 \ No newline at end of file diff --git a/AreaShop/src/main/resources/default.yml b/AreaShop/src/main/resources/default.yml index 79abd04..f1f7579 100644 --- a/AreaShop/src/main/resources/default.yml +++ b/AreaShop/src/main/resources/default.yml @@ -1,70 +1,67 @@ # ╔════════════════════════════════════════════════════════════════════════════════════════════════════════════════════════════╗ # ║ default.yml file of the AreaShop plugin created by NLThijs48, Github can be found at https://github.com/NLthijs48/AreaShop.║ # ║ All settings below are default settings and can be overridden by group settings or individual region settings. ║ +# ║ More information and tutorials can be found on the wiki: https://github.com/NLthijs48/AreaShop/wiki ║ # ╚════════════════════════════════════════════════════════════════════════════════════════════════════════════════════════════╝ # ┌────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────┐ # │ GENERAL: Options for all regions. │ # └────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────┘ general: - ## Set this to true to enable saving/restoring for regions as specified in the profile below, which is specified in the config. + ## Set to true to enable saving/restoring for regions as specified in the profile below, which is specified in the config. enableRestore: false - ## The schematic profile as specified in the config. + ## The schematic profile from the 'schematicProfiles' section in the config. schematicProfile: 'default' - ## The event commands profile as specified in the config. + ## The event commands profile from the 'eventCommandProfiles' section in the config. eventCommandProfile: 'default' - ## The profile for the format of the sign as specified in the config. + ## The profile for the format of the sign from the 'signProfiles' section in the config. signProfile: 'default' - ## The profile for the WorldGuard flags as specified in the config. + ## The profile for the WorldGuard flags from the 'flagProfiles' section in the config. flagProfile: 'default' ## The y location within the region to start searching for safe teleport spots (x and z will be in the middle of the region). ## Possible values: bottom, middle, top. teleportLocationY: bottom - ## If true the teleportation algorithm only allows telportation to inside the region, otherwise it will expand algorithm - ## a cube from the starting point to check for safe spots (then it could end outside the region). - ## If you set a teleport location outside of the region with /as settp then setting this to true breaks that teleport (players cannot use it). + ## If true the teleportation algorithm only allows telportation to inside the region, otherwise it will expand + ## a cube from the starting point to check for safe spots (then it could end outside of the region). teleportIntoRegion: true ## Same as above, but then for when you teleport to the sign of a region instead of the region itself. teleportToSignIntoRegion: false ## Set where the '/as find' command should teleport the player to, set to true for the first sign of the region and set to ## false to teleport to the location set by '/as settp' or the default location (if not set). findTeleportToSign: true - ## Restricts the /as buy and /as rent commands to the world of the region . - ## Useful if you have diffrent economies for different worlds. + ## Restricts the '/as buy' and '/as rent' commands to the world of the region. restrictedToWorld: false - ## Restricts the /as buy and /as rent commands to the region itself (player needs to be inside). + ## Restricts the '/as buy' and '/as rent' commands to the region itself (player needs to be inside). restrictedToRegion: false ## The UUID of the landlord, this player will receive all money from rents/buys (but not reselling with '/as resell'). - ## If you use this value be sure that you set 'moneyBack' to 0, because money will not be substracted from the account - ## of the landlord and the player would get money 'out of thin air'. - landlord: "" + landlord: '' ## Name of the landlord, if the landlord UUID setting is not provided then the name will be used instead - landlordName: "" + landlordName: '' # ┌────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────┐ # │ RENT: Options for rent regions. │ # └────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────┘ rent: - ## The default price of a renting region. + ## The default price of a rental region. price: 1000 - ## The default duration of a renting region, you can find all time indicators in config.yml below the RENTING header. + ## The default duration of a rental region, you can find all time indicators in config.yml below the RENTING header. duration: '1 day' - ## The percentage of the renting price you get back if you unrent the region (price of time left will be multiplied by this/100). + ## The percentage of the rent price you get back if you unrent the region (price of time left will be multiplied by this/100). moneyBack: 100 - ## Maximum number of extends a player can do (-1 for infinite, 0 for no extending). + ## Maximum number of extends a player can do (-1 for infinite, 0 for no extending), if they are at this number then + ## they are force to let their rent run out (and can rent it again at that point). maxExtends: -1 ## The Maximum time they can have the region rented in advance (use times like '1 day' etc, or 'unlimited' for no limit). - ## If you set this lower then the rent duration then players will not be able to rent the region - ## (because it always exceeds the maxRentTime in that case). + ## This can prevent players from renting their region for a year, and to ensure they periodically have to extend their rent. maxRentTime: 'unlimited' - ## Automatically unrent the region after the specified number of minutes between the last login time of the renter and the current time. + ## Automatically unrent the region after the specified time between the last login time of the renter and the current time. ## Use times like '1 day' etc, or 'disabled' for never. inactiveTimeUntilUnrent: 'disabled' - ## If a region of a player has less then this time left when he joins the server he will get a warning. - ## You can find all time indicators in config.yml below the RENTING header, change to '' to disable. + ## If a region of a player has less then this time left when he joins the server he will get a notice about his region. + ## Use '' to disable. warningOnLoginTime: '1 day' - ## The profile for the expiration warnings as specified in the config. + ## The profile for the expiration warnings from the 'expirationWarningProfiles' section in the config. expirationWarningProfile: 'default' - ## If renting the region would go above 'maxRentTIme', then extend to the maximum instead of adding the full duration + ## If renting the region would go above 'maxRentTIme', then extend to the maximum instead of cancelling the rent. extendToFullWhenAboveMaxRentTime: true @@ -72,10 +69,10 @@ rent: # │ BUY: Options for buy regions. │ # └────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────┘ buy: - ## The default price of a buying region. + ## The default price of a buy region. price: 1000 - ## The percentage of the buying price you get back if you sell the region. + ## The percentage of the price you get back if you sell the region. moneyBack: 100 ## Automatically sell the region after the specified number of minutes between the last login time of the buyer and the current time - ## -1 mean never, 1440 is one day, 43200 is one month, 525600 is one year. - inactiveTimeUntilSell: -1 \ No newline at end of file + ## Use times like '1 day' etc, or 'disabled' for never. + inactiveTimeUntilSell: 'disabled' \ No newline at end of file