search

Zrips / Residence

Residence Bukkit Plugin
135 stars 85 forks source link

CustomContainers #615

Open Neoner161 opened 3 years ago

Neoner161 commented 3 years ago

Hello, i have problem with CustomContainers, it won't work, can someone please help me?

Neoner161 commented 3 years ago

These are Global Settings for Residence.

Global:

Starts UUID conversion on plugin startup

DONT change this if you are not sure what you doing

UUIDConvertion: false

If you running offline server, better to check this as true. This will help to solve issues with changing players UUID.

OfflineMode: false

Players with residence.versioncheck permission node will be noticed about new residence version on login

versionCheck: true

This loads the .yml file in the Residence Language folder

All Residence text comes from this file. (NOT DONE YET)

Language: Czech

Wooden Hoe is the default selection tool for Residence.

You can change it to another item ID listed here: http://www.minecraftwiki.net/wiki/Data_values

SelectionToolId: 290 Selection:

By setting this to true, all selections will be made from bedrock to sky ignoring Y coordinates

IgnoreY: false
# When this set to true, selections inside existing residence will be from bottom to top of that residence
# When this set to false, selections inside existing residence will be exactly as they are
IgnoreYInSubzone: false
# Defines height of nether when creating residences. This mostly applies when performing commands like /res select vert or /res auto which will expand residence to defined height
# This cant be higher than 255 or lower than 1
netherHeight: 128
# By setting this to true, player will only pay for x*z blocks ignoring height
# This will lower residence price by up to 255 times, so adjust block price BEFORE enabling this
NoCostForYBlocks: false

This determins which tool you can use to see info on residences, default is String.

Simply equip this tool and hit a location inside the residence and it will display the info for it.

InfoToolId: 287 Optimizations:

This will slightly change behavior of groups file CanTeleport section which will include server owner into check

# When this is set to false and CanTeleport set to false, players will not have option to teleport to other player residences, only to their own
# When this is set to true and CanTeleport set to false, players will not have option to teleport to residences in general
# Keep in mind that this only applies for commands like /res tp
CanTeleportIncludeOwner: false
# Name of your main residence world. Usually normal starting world 'World'. Capitalization essential
DefaultWorld: world
DisabledWorlds:
  # List Of Worlds where this plugin is disabled
  List: []
  # Disables all listeners in included worlds
  DisableListeners: true
  # Disabled any command usage in included worlds
  DisableCommands: true
# Delay in seconds between item pickups after residence flag prevents it
# Keep it at arround 10 sec to lower unesecery checks
ItemPickUpDelay: 10
AutomaticResidenceCreation:
  # When set to true /res auto command will check for new area collision with other residences to avoid overlapping.
  # Set it to false to gain some performace but new residence can often overlap with old ones
  CheckCollision: true
  # Defines new residence name increment when using automatic residence creation command if residence with that name already exist
  IncrementFormat: _[number]
GlobalChat:
  # Enables or disables chat modification by including players main residence name
  Enabled: false
  # Modifys chat to add chat titles.  If you're using a chat manager, you may add the tag {residence} to your chat format and disable this.
  SelfModify: true
  Format: '&c[&e%1&c]'
# When this set to true, any teleportation to residence where player dont have tp flag, action will be denyied
# This can prevent from teleporting players to residence with 3rd party plugins like esentials /tpa
BlockAnyTeleportation: true
# By setting this to true, regular pvp flag will be acting as overridepvp flag
# Overridepvp flag tries to ignore any pvp protection in that residence by any other plugin
OverridePvp: false
KickLocation:
  # By setting this to true, when player kicks another player from residence, he will be teleported to this location instead of getting outside residence
  Use: false
  World: world
  X: 0.5
  Y: 63.0
  Z: 0.5
  # Less than 0 - head up, more than 0 - head down. Range from -90 to 90
  Pitch: 0.0
  # Head position to left and right. Range from -180 to 180
  Yaw: 0.0
FlyLandLocation:
  # Used when players fly state is being turned to false because of fly flag and there is no solid land where to land for player
  World: world
  X: 0.5
  Y: 63.0
  Z: 0.5
  # Less than 0 - head up, more than 0 - head down. Range from -90 to 90
  Pitch: 0.0
  # Head position to left and right. Range from -180 to 180
  Yaw: 0.0
InfoCommand:
  # By setting this to true, when checking residence info with /res info, you will get only names in list, by hovering on them, you will get flag list
  ShortInformation: false
  # When set to true default residence flags set in flags.yml file will get excluded from info command output and will not be shown
  # If flag gets different state then it will be shown
  ExcludeDefaultFlags: false
Vote:
  # Range players can vote to, by default its from 0 to 10 points
  RangeFrom: 0
  RangeTo: 10
  # If this true, players can only give like for shop instead of point voting
  OnlyLike: false
ConsoleLogs:
  # If this true, flag changes throw GUI will be recorded in console
  ShowFlagChanges: true
Intervals:
  # How often in seconds to heal/feed players in residence with appropriate flag
  # Bigger numbers can save some resources
  Heal: 0
  Feed: 0
# Potions containing one of thos effects will be ignored if residence dont have pvp true flag set
NegativePotionEffects:
- blindness
- confusion
- harm
- hunger
- poison
- slow
- slow_digging
- weakness
- wither
NegativeLingeringPotions:
- slowness
- instant_damage
- poison
- slowness
# Defines speed for particular wspeed1 and wspeed2 flags. It can be from 0 up to 5
WalkSpeed:
  '1': 0.5
  '2': 2.0

The interval, in milliseconds, between movement checks.

Reducing this will increase the load on the server.

Increasing this will allow players to move further in movement restricted zones before they are teleported out.

MoveCheckInterval: 500 Tp:

The interval, in seconds, for teleportation.

# Use 0 to disable
TeleportDelay: 3
# Show aditional message in title message area when player is teleporting to residence
TeleportTitleMessage: true

RandomTeleportation: Worlds:

World name to use this feature. Add annother one with appropriate name to enable random teleportation

  MaxCoord:
    Enabled: true
    # Max coordinate to teleport, setting to 1000, player can be teleported between -1000 and 1000 coordinates
    MaxCoord: 1000
    # If maxcoord set to 1000 and mincoord to 500, then player can be teleported between -1000 to -500 and 500 to 1000 coordinates
    MinCoord: 500
    CenterX: 0
    CenterZ: 0
  # World name to use this feature. Add annother one with appropriate name to enable random teleportation
  MinCord:
    Enabled: true
    # Max coordinate to teleport, setting to 1000, player can be teleported between -1000 and 1000 coordinates
    MaxCoord: 1000
    # If maxcoord set to 1000 and mincoord to 500, then player can be teleported between -1000 to -500 and 500 to 1000 coordinates
    MinCoord: 500
    CenterX: 0
    CenterZ: 0
  # World name to use this feature. Add annother one with appropriate name to enable random teleportation
  CenterX:
    Enabled: true
    # Max coordinate to teleport, setting to 1000, player can be teleported between -1000 and 1000 coordinates
    MaxCoord: 1000
    # If maxcoord set to 1000 and mincoord to 500, then player can be teleported between -1000 to -500 and 500 to 1000 coordinates
    MinCoord: 500
    CenterX: 0
    CenterZ: 0
  # World name to use this feature. Add annother one with appropriate name to enable random teleportation
  CenterZ:
    Enabled: true
    # Max coordinate to teleport, setting to 1000, player can be teleported between -1000 and 1000 coordinates
    MaxCoord: 1000
    # If maxcoord set to 1000 and mincoord to 500, then player can be teleported between -1000 to -500 and 500 to 1000 coordinates
    MinCoord: 500
    CenterX: 0
    CenterZ: 0
  # World name to use this feature. Add annother one with appropriate name to enable random teleportation
  world:
    Enabled: true
    # Max coordinate to teleport, setting to 1000, player can be teleported between -1000 and 1000 coordinates
    MaxCoord: 1000
    # If maxcoord set to 1000 and mincoord to 500, then player can be teleported between -1000 to -500 and 500 to 1000 coordinates
    MinCoord: 500
    CenterX: 0
    CenterZ: 0
  DIM-1:
    Enabled: true
    MaxCoord: 1000
    MinCoord: 500
    CenterX: 0
    CenterZ: 0
  obchodak:
    Enabled: true
    MaxCoord: 1000
    MinCoord: 500
    CenterX: 0
    CenterZ: 0
  DIM1:
    Enabled: true
    MaxCoord: 1000
    MinCoord: 500
    CenterX: 0
    CenterZ: 0
  DIM2:
    Enabled: true
    MaxCoord: 1000
    MinCoord: 500
    CenterX: 0
    CenterZ: 0
  DIM7:
    Enabled: true
    MaxCoord: 1000
    MinCoord: 500
    CenterX: 0
    CenterZ: 0
  tezebak:
    Enabled: true
    MaxCoord: 1000
    MinCoord: 500
    CenterX: 0
    CenterZ: 0
  DIM-17:
    Enabled: true
    MaxCoord: 1000
    MinCoord: 500
    CenterX: 0
    CenterZ: 0
  DIM-29:
    Enabled: true
    MaxCoord: 1000
    MinCoord: 500
    CenterX: 0
    CenterZ: 0
  DIM-31:
    Enabled: true
    MaxCoord: 1000
    MinCoord: 500
    CenterX: 0
    CenterZ: 0
  DIM-28:
    Enabled: true
    MaxCoord: 1000
    MinCoord: 500
    CenterX: 0
    CenterZ: 0
  DIM-30:
    Enabled: true
    MaxCoord: 1000
    MinCoord: 500
    CenterX: 0
    CenterZ: 0
# How long force player to wait before using command again.
Cooldown: 5
# How many times to try find correct location for teleportation.
# Keep it at low number, as player always can try again after delay
MaxTries: 20

The interval, in minutes, between residence saves.

SaveInterval: 1

New save mechanic can minimize save file couple times and speedup save/load time in general

Bigger files have bigger impact

NewSaveMechanic: true Backup: AutoCleanUp:

Do you want to automatically remove backup files from main backup folder if they are older than defined day amount

  Use: false
  Days: 30
# Do you want to backup files by creating zip files in main residence folder in backup folder
# This wont have effect on regular backuped files made in save folder
UseZip: true
IncludeFiles:
  Worlds: true
  forsale: true
  leases: true
  permlists: true
  rent: true
  flags: true
  groups: true
  config: true

AutoCleanUp:

HIGHLY EXPERIMENTAL residence cleaning on server startup if player is offline for x days.

# Players can bypass this with residence.cleanbypass permission node
Use: false
# For how long player should be offline to delete hes residence
Days: 60
# Do you want to regenerate old residence area
# This requires world edit to be present
Regenerate: false
# Worlds to be included in check list
Worlds:
- world

Lwc:

Removes lwc protection from all defined objects when removing residence

OnDelete: true
# Removes lwc protection from all defined objects when buying residence
OnBuy: true
# Removes lwc protection from all defined objects when unrenting residence
OnUnrent: true
# List of blocks you want to remove protection from
MaterialList:
- CHEST
- TRAPPED_CHEST
- furnace
- dispenser

AntiGreef: TNT:

When set to true will allow tnt and minecart with tnt to explode below 62 (default) level outside of residence

  # This will allow mining with tnt and more vanilla play
  ExplodeBelow: false
  level: 62
Creeper:
  # When set to true will allow Creeper explode below 62 (default) level outside of residence
  # This will give more realistic game play
  ExplodeBelow: false
  level: 62
Flow:
  # Level from which one to start lava and water flow blocking
  # This dont have effect in residence area
  Level: 63
  # With this set to true, lava flow outside residence is blocked
  NoLavaFlow: true
  # With this set to true, water flow outside residence is blocked
  NoWaterFlow: true
  Worlds:
  - world
Place:
  # Level from which one to start block lava and water place
  # This don't have effect in residence area
  Level: 63
  # With this set to true, playrs cant place lava outside residence
  NoLavaPlace: true
  # With this set to true, playrs cant place water outside residence
  NoWaterPlace: true
  Worlds:
  - world
BlockFall:
  # With this set to true, falling blocks will be deleted if they will land in different area
  Use: true
  # Level from which one to start block block's fall
  # This don't have effect in residence area or outside
  Level: 62
  Worlds:
  - world
ResCleaning:
  # With this set to true, after player removes its residence, all blocks listed below, will be replaced with air blocks
  # Effective way to prevent residence creating near greefing target and then remove it
  # ATTENTION! Bigger residence areas could want to create bigger loads on server when cleaning up areas. So dont use this if regular player have access to huge residences. 15 million blocks would be a max limit
  Use: false
  # Level from whichone you want to replace blocks
  Level: 63
  # Block list to be replaced
  # By default only water and lava will be replaced
  Blocks:
  - WATER
  - LAVA
  Worlds:
  - world
Flags:
  # By setting this to true flags from list will be protected from change while there is some one inside residence besides owner
  # Protects in example from people inviting some one and changing pvp flag to true to kill them
  Prevent: true
  list:
  - pvp

The default group to use if Permissions fails to attach or your not using Permissions.

DefaultGroup: default

Enable / Disable the Lease System.

UseLeaseSystem: false

Sets date format when shown in example lease or rent expire date

How to use it properly, more information can be found at http://www.tutorialspoint.com/java/java_date_time.htm

DateFormat: E yyyy.MM.dd 'at' hh:mm:ss a zzz

Sets date format when shown in example lease or rent expire date

How to use it properly, more information can be found at http://www.tutorialspoint.com/java/java_date_time.htm

DateFormatShort: MM.dd hh:mm

Sets time zone for showing date, useful when server is in different country then main server player base

Full list of possible time zones can be found at http://www.mkyong.com/java/java-display-list-of-timezone-with-gmt/

TimeZone: Europe/Prague

Enable / Disable money returning on residence removal.

ResMoneyBack: false

The interval, in minutes, between residence lease checks (if leases are enabled).

LeaseCheckInterval: 10

Allows leases to automatically renew so long as the player has the money, if economy is disabled, this setting does nothing.

LeaseAutoRenew: true

Whether or not to use the Permissions system in conjunction with this config.

EnablePermissions: true

Set to true if NOT using Permissions or PermissionsBukkit, or using a really old version of Permissions

LegacyPermissions: false

Enable / Disable Residence's Economy System (iConomy, MineConomy, Essentials, BOSEconomy, and RealEconomy supported).

EnableEconomy: true

Defaults to None which will start by looking to default economy engine throw vault API and if it fails to any supported economy engine

Custom economy engines can be defined to access economy directly

Supported variables: Vault, iConomy, MineConomy, Essentials, BOSEconomy, RealEconomy, CMIEconomy, None

Type: None

When enabled extra message will appear in chat if residence is for rent or for sell to inform how he can rent/buy residence with basic information.

ExtraEnterMessage: true Sell:

If set to true, this will allow to sell subzones. Its recommended to keep it false tho

Subzone: false

Enables or disables the Rent System

EnableRentSystem: false Rent:

Prevents residence/subzone removal if its subzone is still rented by some one

PreventRemoval: true
# When set to true residence rent can be renewed from residence bank
DeductFromBank: false
# When set to true residence rent can be renewed from residence bank and if there is not enough money then we will deduct rest of it from player
# This will override behavior of DeductFromBank
DeductFromBankThenPlayer: false
Inform:
  # Informs players on rent time ending
  OnEnding: true
  # Time range in minutes when to start informing about ending rent
  Before: 1440
  # Time range in seconds for how long to wait after player logs in to inform about ending rents
  Delay: 60
DefaultValues:
  # Default values used when putting residence for rent
  AllowRenewing: true
  StayInMarket: true
  AllowAutoPay: true
  # If set to true, when player is not defining auto pay on renting, then this value will be used
  PlayerAutoPay: true
Schematics:
  # EXPERIMENTAL!!! If set to true, residence will be restored to state it was when backup flag was set to true
  # For securoty reassons only players with aditional residence.backup permission node can set backup flag
  RestoreAfterRentEnds: true
  # When set to true, area state will be saved only when setting backup to true value
  # When set to false, area state will be saved before each renting to have always up to date area look
  # Keep in mind that when its set to false, there is slightly bigger server load as it has to save area each time when some one rents it
  SaveOnFlagChange: true

The interval, in minutes, between residence rent expiration checks (if the rent system is enabled).

RentCheckInterval: 10

Enable or disable residence chat channels.

ResidenceChatEnable: true Messages:

Defines where you want to send residence enter/leave/deny move and similar messages. Possible options: ActionBar, TitleBar, ChatBox

# TitleBar can have %subtitle% variable to define second line
GeneralMessages: ActionBar

ActionBar: ShowOnSelection: true

Color of residence chat.

ResidenceChatColor: DARK_PURPLE ResidenceChatPrefixLength: 16

Whether or not to ignore the usual Permission flags and only allow OPs and groups with 'residence.admin' to change residences.

AdminOnlyCommands: false

Setting this to true makes server OPs admins.

AdminOPs: true

Setting this to true server administration wont need to use /resadmin command to access admin command if they are op or have residence.admin permission node.

AdminFullAccess: false

This is the name of the plugin you use for multiworld, if you dont have a multiworld plugin you can safely ignore this.

The only thing this does is check to make sure the multiworld plugin is enabled BEFORE Residence, to ensure properly loading residences for other worlds.

MultiWorldPlugin: Multiverse-Core

Setting this to true causes subzones to inherit flags from their parent zones.

ResidenceFlagsInherit: true

Setting this to false will allow rented residences to be modified by the renting player.

PreventRentModify: true

Setting this to true will prevent subzone deletion when subzone owner is not same as parent zone owner.

PreventSubZoneRemoval: true

Setting this to false will cause residence to continue to load even if a error is detected in the save file.

StopOnSaveFault: true ResidenceNameRegex: '[^a-zA-Z0-9-_]'

Setting this to true sends a message to the console every time Residence does a rent expire check or a lease expire check.

ShowIntervalMessages: false

Setting this to true sends a tutorial message to the new player when he places chest on ground.

ShowNoobMessage: true

Setting this to true creates residence around players placed chest if he don't have any.

Only once every server restart if he still don't have any residence

NewPlayer: Use: false

Setting this to true, residence will be created for free

# By setting to false, money will be taken from player, if he has them
Free: true
# Range from placed chest o both sides. By setting to 5, residence will be 5+5+1 = 11 blocks wide
Range:
  X: 5
  Y: 5
  Z: 5

Experimental - The following settings are lists of block IDs to be used as part of the checks for the 'container' and 'use' flags when using mods.

CustomContainers: