config.yml

Main configuration of the plugin

https://github.com/yL3oft/zHomes/blob/master/src/main/resources/config.yml

prefix: "&8[&4zHomes&8] "

# Edit your mysql database config here
database:
  # Here you can define how to store the plugin data.
  # OPTIONS:
  # - H2 (Preferred over SQLite)
  # - SQLite
  # - MariaDB (Preferred over MySQL)
  # - MySQL
  # DEFAULT: SQLite
  type: H2
  host: localhost
  port: 3306
  database: db
  username: root
  password: pass
  options:
    useSSL: false
    allowPublicKeyRetrieval: false
  # -------------------- #
  # WARNING: DO NOT CHANGE ANYTHING BELOW IF YOU DON'T KNOW WHAT YOU'RE DOING
  pool-size: 10
  table-prefix: zhomes

general:
  # Here you can define the language of the plugin, all languages can be found, edited and created on languages' directory.
  # DEFAULT OPTIONS: [de, en, es, fr, it, nl, pl, pt-br, ru, zhcn, <custom>] --- DEFAULT: en
  language: "en"
  # Define it the plugin should be updated automatically
  # OPTIONS: [true, false] --- DEFAULT: true
  auto-update: false
  # Should players with permissions be notified about plugin updates upon joining?
  # OPTIONS: [true, false] --- DEFAULT: true
  announce-update: true
  # Here you can define if metrics should be on or off.
  # !WARNING: This option does not work with reload.
  # OPTIONS: [true, false] --- DEFAULT: true
  metrics: true

# In this section you can change the teleport options for the players
teleport-options:
  # This option defines if the plugin should check for a safe location upon trying to teleport to a home.
  # OPTIONS: [true, false] --- DEFAULT: true
  enable-safe-teleport: true
  # This option defines if the players can teleport to other dimensions with homes.
  # OPTIONS: [true, false] --- DEFAULT: true
  dimensional-teleportation: true # There is also a permission to bypass in permissions.bypass.dimensional-teleportation in this file
  # Should the plugin play an enderman warp sound when the player teleports to a home?
  # OPTIONS: [true, false] --- DEFAULT: true
  play-sound: true

  restricted-worlds:
    # This option defines if the restricted worlds feature is enabled
    # OPTIONS: [true, false] --- DEFAULT: false
    enable: false
    # Here you can define the restriction mode and the worlds
    # OPTIONS: [blacklist, whitelist] --- DEFAULT: blacklist
    mode: blacklist
    worlds:
      - world_nether
      - world_the_end

  # Teleportation warmup options
  warmup:
    # This option defines if the warmup should be enabled or not.
    # OPTIONS: [true, false] --- DEFAULT: true
    enable: true
    # Defines the time of the warmup in seconds.
    # OPTIONS: [>=0 INT] --- DEFAULT: 5
    time: 5
    # Should the warmup be cancelled when the player moves?
    # OPTIONS: [true, false] --- DEFAULT: true
    cancel-on-move: true
    # Should the warmup be shown in the actionbar?
    # OPTIONS: [true, false] --- DEFAULT: true
    show-on-actionbar: true

limits:
  # This options defines if homes should have a limit or not.
  # OPTIONS: [true, false] --- DEFAULT: false
  enabled: false

  # The default limit of homes a player can have
  # OPTIONS: [>=0] --- DEFAULT: 10
  default: 10 # There is also a permission to bypass: zhomes.bypass.limit

  # Limit example:
  '15':
    - group.vip
    - group.mvp
  '999':
    - group.admin

commands:
  # Mostly everything below needs a restart to apply
  main:
    command: zhomes
    description: "The main command for the plugin"
    permission: zhomes.command.main # True by default
    cooldown: 0.0
    aliases:
      - zh
    # Sub command - Help (Admin)
    help:
      permission: "zhomes.command.main.help" # Only OP by default
    # Sub command - Info
    info:
      permission: "zhomes.command.main.info" # Only OP by default
    # Sub command - Version
    version:
      permission: "zhomes.command.main.version" # True by default
      update:
        permission: "zhomes.command.main.version.update" # Only OP by default
    # Sub command - Reload
    reload:
      permission: "zhomes.command.main.reload" # Only OP by default
    # Sub command - Nearhomes
    nearhomes:
      permission: "zhomes.command.main.nearhomes" # Only OP by default
      # Max limit of the radius to search for homes
      # Use -1 to have no limit (Not recommended)
      limit: 500.0
    # Sub command - Converter
    converter:
      permission: "zhomes.command.main.converter" # Only OP by default
    # Sub command - Import | Export
    importexport:
      permission: "zhomes.command.main.importexport" # Only OP by default
  sethome:
    command: sethome
    description: "Sethome"
    permission: "zhomes.command.sethome" # True by default
    cooldown: 0.0
    aliases:
      - seth
    command-cost: 0 # Requires Vault to work
  delhome:
    command: delhome
    description: "Delhome"
    permission: "zhomes.command.delhome" # True by default
    cooldown: 0.0
    aliases:
      - deletehome
      - delh
    command-cost: 0 # Requires Vault to work
    others:
      permission: "zhomes.command.delhome.others" # Only OP by default
  homes:
    command: homes
    description: "Homes"
    permission: "zhomes.command.homes" # True by default
    cooldown: 0.0
    aliases:
      - myhomes
    command-cost: 0  # Requires Vault to work
    # This option defines the return type of this command
    # OPTIONS: [text, menu] --- DEFAULT: menu
    type: menu
    others:
      permission: "zhomes.command.homes.others" # Only OP by default
  home:
    command: home
    description: "Home"
    permission: "zhomes.command.home" # True by default
    cooldown: 0.0
    aliases: []
    command-cost: 0  # Requires Vault to work
    others:
      permission: "zhomes.command.home.others" # Only OP by default
    # Sub command - Rename
    rename:
      permission: "zhomes.command.home.rename" # True by default
      command-cost: 0 # Requires Vault to work

# In this section you can define the permissions for the plugin
# Permissions for commands can be found on the commands section
permissions:
  bypass:
    # This permission allows the player to bypass the limit of homes
    # Default: zhomes.bypass.limit
    limit: "zhomes.bypass.limit" # Only OP by default
    # This permission allows the player to bypass the dimensional teleportation
    # Default: zhomes.bypass.dimensionalteleportation
    dimensional-teleportation: "zhomes.bypass.dimensionalteleportation" # Only OP by default
    # Allow player's to bypass safe teleportation
    # Default: zhomes.bypass.safeteleport
    safe-teleportation: "zhomes.bypass.safeteleport" # False by default
    # This permission allows the player to bypass the restricted worlds feature
    # Default: zhomes.bypass.restrictedworlds
    restricted-worlds: "zhomes.bypass.restrictedworlds" # Only OP by default
    # This permission allows the player to bypass the teleportation warmup
    # Default: zhomes.bypass.warmup
    warmup: "zhomes.bypass.warmup" # Only OP by default
    # This permission allows the player to bypass the cost of the command
    # Default: %command_permission%.command-cost
    command-cost: "%command_permission%.bypass.command-cost" # Only OP by default