Pack: Homes - teakivy/teaks-tweaks GitHub Wiki

Pack: Homes (homes)

Allows players to set, delete, and teleport back to home locations set around the world!

Showcase

homes

Config

The config for this pack can be found in the config.yml file for the plugin.

# Homes
# Allows you to set homes ('/home set <name>') and teleport back to them ('/home <name>')
#
# Commands:
# /home <name> (Permission: teakstweaks.command.home)
# /home set <name> (Permission: teakstweaks.command.home.set)
# /home delete <name> (Permission: teakstweaks.command.home.delete)
# /sethome <name> (Permission: teakstweaks.command.home.set)
# /deletehome <name> (Permission: teakstweaks.command.delete)
homes:
  enabled: false
  # Enter how many homes a player can have. Use 0 for unlimited homes.
  max-homes: 0
  # Enter the number of seconds required to wait between uses of the home command
  teleport-cooldown: 0

Options

enabled

  • Type - boolean
  • Default - false
  • Description - Controls whether the pack is enabled.

max-homes

  • Type - int
  • Default - 0
  • Description - Sets the maximum amount of homes a player can have. If 0, the player has unlimited homes.

teleport-cooldown

  • Type - int
  • Default - 0
  • Description - How long (in seconds) required to wait between teleporting to another home.

Linked Commands

Permissions

teakstweaks.command.home

  • Default - true
  • Description - Controls whether the player can use the /home command to teleport.

teakstweaks.command.home.set

  • Default - true
  • Description - Controls whether the player can use the /home set or /sethome command.

teakstweaks.command.home.delete

  • Default - true
  • Description - Controls whether the player can use the /home delete or /deletehome command.

Messages

"homes.name": "Homes",
"homes.description": "Allows you to set and teleport to homes.<newline>Command: /home",
"homes.error.on_cooldown": "<red>You must wait <time> seconds before teleporting again!",
"homes.teleporting_in": "<yellow>Teleporting in <time> seconds...",
"homes.teleported": "<green>Teleported to home <home>!",
"homes.deleted": "<green>Home <home> has been deleted!",
"home.error.missing_home_name": "<red>Please specify a name for your home!",
"home.error.home_already_exists": "<red>The home <name> already exists!",
"home.error.home_dne": "<red>The home <name> does not exist!",
"home.error.max_homes": "<red>You cannot have more than <max_homes> homes!",
"home.error.cant_set_home": "<red>An unknown error has occurred while setting your home!",
"home.error.cant_delete_home": "<red>An unknown error has occurred while deleting your home!",
"home.error.no_homes_yet": "<red>You don't have any homes set! Use <gold>/home set <name></gold> to set one!",
"home.set_home": "<green>Set your home <name>!",
"home.deleted_home": "<green>Deleted your home <name>!",

homes.name

  • Default - Homes

homes.description

  • Default - Allows you to set and teleport to homes.<newline>Command: /home

homes.error.on_cooldown

  • Default - <red>You must wait <time> seconds before teleporting again!
  • Placeholders
    • time - The amount of seconds left on cooldown.

homes.teleporting_in

  • Default - <yellow>Teleporting in <time> seconds...
  • Placeholders
    • time - The amount of seconds until teleportation.

homes.teleported

  • Default - <green>Teleported to home <home>!
  • Placeholders
    • home - The name of the home teleported to.

homes.deleted

  • Default - <green>Home <home> has been deleted!
  • Placeholders
    • home - The name of the home deleted.

home.error.missing_home_name

  • Default - <red>Please specify a name for your home!

home.error.home_already_exists

  • Default - <red>The home <name> already exists!
  • Placeholders
    • home - The name of the home.

home.error.home_dne

  • Default - <red>The home <name> does not exist!
  • Placeholders
    • home - The name of the home.

home.error.max_homes

  • Default - <red>You cannot have more than <max_homes> homes!
  • Placeholders
    • max_homes - The maximum amount of homes the player can have.

home.error.cant_set_home

  • Default - <red>An unknown error has occurred while setting your home!

home.error.cant_delete_home

  • Default - <red>An unknown error has occurred while deleting your home!

home.error.no_homes_yet

  • Default - <red>You don't have any homes set! Use <gold>/home set <name></gold> to set one!

home.set_home

  • Default - <green>Set your home <name>!
  • Placeholders
    • name - The name of the home set.

home.deleted_home

  • Default - <green>Deleted your home <name>!
  • Placeholders
    • name - The name of the home deleted.
⚠️ **GitHub.com Fallback** ⚠️