-
Notifications
You must be signed in to change notification settings - Fork 35
Config
Most config values should be self explanatory but here is still an overview what they do (ver 1.6.6)
Name | Description |
---|---|
startingBlocks | Amount of claim blocks every player starts with. default 500 |
maxClaimBlocks | Max claim blocks players can have with time. default 5000. Set to -1 to disable the need for claim blocks |
ticksForNextBlock | Time in ticks it take to get one claim block. default 1200. Resets if player relogs |
minClaimsize | Minimum blocks for a claim to be created. default 100 |
defaultClaimDepth | Initial depth of a claim. Auto extends down if player builds below. default 10 |
maxClaims | Max amount of claims a player can have. default -1 |
defaultClaimName | Default name for claims. Will get passed in the players name. use "%s" to reference it |
defaultEnterMessage | Default enter message. Will get passed in the players ("%1$s") name and the current claims ("%2$d") of the player |
defaultLeaveMessage | Default leave message |
blacklistedWorlds | List of worlds to disable claiming. default [] |
worldWhitelist | Change blacklist to whitelist. default false |
claimingItem | Specify the claiming item. default minecraft:golden_hoe |
claimingNBT | Specify the nbt the claiming item has to contain to count as one. See below for format |
inspectionItem | Item to inspect a block. default minecraft:stick |
inspectionNBT | Specify the nbt the inspection item has to contain to count as one. See below for format |
claimDisplayTime | Time in ticks to display any claims triggered by any means. default 1000 |
permissionLevel | Permission level to execute admin commands. default 2 |
ftbChunksCheck | Check for ftb chunks claims |
gomlReservedCheck | Check for goml claims |
mineColoniesCheck | Check for minecolonies colony claims |
buySellHandler | Define how claim blocks are bought. See below for more info |
maxBuyBlocks | Max amount of claim blocks players are able to buy. -1 = No Limit |
lenientBlockEntityCheck | If false any block entity will be considered. If true only block entities with inventory will |
breakBlockBlacklist | Add block registry names here that should be ignored when breaking blocks (for e.g. grave stones). Also accepts modid so e.g. "minecraft" will ignore all blocks from minecraft |
interactBlockBlacklist | Add block registry names here that should be ignored when doing interacting with it (for e.g. grave stones). Also accepts modid so e.g. "minecraft" will ignore all blocks from minecraft |
breakBlockEntityTagBlacklist | Add keys here that when a blockentity contains that key it will be ignored during breaking permission check. Only the base will be considered: If A,B are NBT and A={Foo=1} and B={Nested:{Foo=2}} and the config contains "Foo" then only A will be detected |
interactBlockEntityTagBlacklist | Like above but for interaction |
ignoredEntities | Add entitiy registry names here that should be ignored when doing permission checks. Also accepts modid so e.g. "minecraft" will ignore all entities from minecraft |
entityTagIgnore | Add keys here that when an entities scoreboard tags contains that key it will be ignored for permission check |
customItemPermission | Assign or override an item permission map so you could e.g. make it so enderpearls are assigned a different permission than currently. Syntax is <item/tag>-<permission> |
customBlockPermission | Assign or override a block permission map. Syntax is <block/tag>-<permission> |
dropTicks | Time in ticks drops will remain unlocked when a player uses the /flan unlockDrops command |
inactivityTimeDays | Time in days a player has to be inactive for his claims to be deleted |
inactivityBlocksMax | Maximum claimblocks a player can have for his claims to be deleted |
deletePlayerFile | If the player data will also be deleted due to inactivity |
bannedDeletionTime | After how many days since the ban the player and claim data will be deleted. |
defaultGroups | Set default permission groups each claim will have. The default value should be pretty self explanatory |
globalDefaultPerms | Define per world permission that apply globally here. See below for more information |
enableLogs | Enable various logging messages. default false |
Since flan is server side the lang config is server side too.
Version 1.1.0+ offer the option to define permissions per world that will be applied globally regardless of claims with only exception of admin claims.
If a permission is defined as global that permission will be checked before individual claim permission and claim permission will be ignored. This makes it e.g. possible to disable PvP on the server and allow it only in admin defined areas.
For the MOBSPAWN permission to work allowMobSpawnToggle needs to be true (only for version 1.4.0 below).
To specify every dimension use "*" instead of "".
For version <= 1.4.0 only false and true are accepted. ALLTRUE and ALLTRUE override claim permission (except admin claims) meaning if that is used that permission will be applied to the whole world while FALSE and TRUE only apply to outside claims. Admins using /flan adminMode are excempted from this.
To define global permission edit your the globalDefaulPerms in your config to something like this:
"globalDefaultPerms": {
"<dimension key>": {
"<permission name>": ALLFALSE|ALLTRUE|FALSE|TRUE
...
}
...
}
Example value here. Players will never be able to open containers and hurt each other in the overworld and explosions are disabled unless a claim allows it. In the nether they will not be able to open doors and will always are able to use anvils:
"globalDefaultPerms": {
"minecraft:overworld": {
"OPENCONTAINER": ALLFALSE,
"HURTPLAYER": ALLFALSE,
"EXPLOSIONS": FALSE
},
"minecraft:the_nether": {
"DOOR": ALLFALSE,
"ANVIL": ALLTRUE
}
}
For buyType/sellType
there are 3 types you can specify:
MONEY
: This needs a compatible currency mod installed
ITEM
: Uses an item to buy/sell claimblocks. Specified with the "ingredient" value. Uses vanilla Ingredient so if you dont know how to do it look at vanilla recipe examples.
Buying allows for multiple item types while selling will only allow one item output.
Example for single item:
"ingredient": {
"item": "minecraft:apple"
}
Example for buy ingredient using multiple items:
"buyIngredients": [
{
"amount": 10.0,
"ingredient": {
"item": "minecraft:iron_ingot"
}
},
{
"amount": 5.0,
"ingredient": {
"item": "minecraft:apple"
}
}
]
XP
: Uses xp points (not levels) to buy/sell claimblocks.
buyValue/sellValue
: How much "currency" a claimblock is worth. The final payment will be multiplied by this * <amount of claimblocks>
For buying the final amount to pay is rounded up if its not money.
So if you have a buyValue of 0.5 and you are buying 5 claimblocks which would result in a payment of 2.5 you would need to pay e.g. 3 diamonds for it.
For selling the final amount is rounded down if its not money.
So if you have a sellValue of 0.5 and you are selling 5 claimblocks you would only get 5 * 0.5 = 2.5 -> 2 diamonds back
NBT tags matches the item if the items nbt contain all the key-value pair specified in the config:
E.g. following example checks if the item contains the key "ClaimingTool" and if that key is true
{
"claimingNBT": {
"ClaimingTool": true
}
}