General settings

Next, I will present each feature of the general configuration. This configuration is available in the config.yml file.

update_config:
  notify: true

  auto_update:
    enabled: true
    check_interval: 6h

    restart:
      enabled: true
      only_on_start: true

  update_configs: true
  update_messages: true
  update_permissions: true

Update settings

I recommend that you leave this configuration as is, since it is designed so that you can get updates without having to worry about it, but if you wish, you can modify it to your liking

auto_update:
  # If this option is true, every time a new version is available it will be
  # Automatically downloads when the server is turned on.
  enabled: true
  # Time interval to check for new updates while the server is on (leave this at 0 to disable it)
  check_interval: 6h

Restart options after an update

  restart:
    # If this is set to true every time a new update is downloaded the server will restart
    enabled: true
    # If this setting is true and restart.enabled is true, downloading an update while the server is powered on will not restart.
    only_on_start: true

Update configuration files

  # If this is true, if a missing configuration is detected in the configuration files, it will be updated
  # automatically (this does not affect existing configurations, new ones are simply added)
  # WARNING: If you disable this you are likely to receive errors after an update, I recommend that you leave it enabled
  update_configs: true
  update_messages: true
  update_permissions: true

lang: es-ES

Select here the message file to be used in the plugin. Available languages ​​are:

• en-EN - Inglés

• es-ES - Español

replaced_messages:
  console: "&bConsola"

In this section, you can change or replace certain plugin messages.

Customize the messages to suit your needs.

commands_alias:
  - dt
  - teleport

In this section, you can add aliases for DeluxeTeleport commands in addition to the main /deluxeteleport command. Aliases allow you to use shorter or custom commands to make interacting with the plugin easier.

Remember to restart your server after adding or removing an alias for the changes to take effect.

database:
  type: localhost
  address: 00.00.000
  port: 3306
  database: DeluxeTeleport
  username: user
  password: 'password'
  table_name: deluxeteleport_

Database Configuration

Currently, Deluxe Teleport does not have any database-based functionality implemented. However, this functionality is planned to be added in future updates.

Storage Options

You can select the storage type in the following section:

database:
  # Storage type, available options:
  #
  # localhost: plugin file storage (playerdata file)
  # MySQL: storage in a MySQL database
  # WARNING: Restart your server when changing from localhost to MySQL
  type: localhost

MySQL Configuration

If you choose to use a MySQL database, you will need to provide the following information:

# MySQL database data
  address: 00.00.000          # IP address or server name
  port: 3306                  # Connection port
  database: DeluxeTeleport    # Database name
  username: user              # Username to access the database
  password: 'password'        # User Password

Table Name

Specifies the name of the table to use to store the data:

# MySQL table name
  # WARNING: Do not leave this field empty or with the name of an existing table
  # Don't change this if you don't know what it is
  table_name: deluxeteleport_

Please note that when making changes to the database configuration, it is important to restart the server for the changes to take effect.

teleport_on_join:
  enabled: false
  destination_place_settings:
    destination_place: Spawn
    destination: world
  teleport_conditions:
    conditions: []  
  teleport_actions:
    actions: []

Setting Teleportation when Joining Server

Teleport Options

This section allows you to enable or disable automatic teleportation of players upon joining the server, as well as adjust where they will be teleported to. The available options are described below:

teleport_on_join:
  # Will teleport be enabled upon joining?
  enabled: false

  # Adjustments to where the player will be teleported to when joining
  destination_place_settings:
    # Where will the player be teleported to when joining?
    # Available options: Spawn, Lobby
    destination_place: Spawn
    # If destination_place is Lobby and multiple_lobbies is true, this will be the lobby to consider.
    # If destination_place is Spawn and by_world is true, this will be the spawn to consider.
    destination: world

Conditions

In this section you can check conditions before making the teleport and execute actions if they are met or not. Learn how to use conditions [HERE].

Actions

In this section, you can define actions that will be executed after the player teleports. These actions allow you to further customize the teleportation process. You can learn how to configure actions in detail in the corresponding section of this documentation. [HERE].

teleport_conditions:
  conditions: []
teleport_actions:
  actions: []

teleport_on_join:  
  only_first_join:
    enabled: true
    destination_place_settings:
      destination_place: Spawn
      destination: world
    teleport_conditions:
      conditions: []  
    teleport_actions:
      actions: []

Teleport Setup for New Players

Teleport Settings

This section allows you to define specific settings for teleporting players who join the server for the first time. The available options are described below:

teleport_on_join:
  # Teleportation settings for players joining the server for the first time
  only_first_join:
    # Will teleportation be enabled for the player's first login?
    enabled: true
    # Setting the place where the player will be teleported the first time
    destination_place_settings:
      # Destination location where the player will be teleported for the first time
      # Available options: Spawn, Lobby
      destination_place: Spawn
      # If destination_place is Lobby and multiple_lobbies is true, this will be the lobby to consider.
      # If destination_place is Spawn and by_world is true, this will be the spawn to consider.
      destination: world

Considerations

• If this option is enabled, players who log in for the first time will be automatically teleported to the specified location (by default, the Spawn).

• Make sure the destination and destination_place are set correctly.

Conditions

In this section you can check conditions before making the teleport and execute actions if they are met or not. Learn how to use conditions [HERE].

Actions

In this section, you can define actions that will be executed after the player teleports. These actions allow you to further customize the teleportation process. You can learn how to configure actions in detail in the corresponding section of this documentation. [HERE].

teleport_conditions:
  conditions: []
teleport_actions:
  actions: []

teleport_on_void:
  enabled: false
  ignored_worlds:
    - IgnoredWorld
  destination_place_settings:
    destination_place: Spawn
    destination: world
  teleport_conditions:
    conditions: []  
  teleport_actions:
    actions: []

Void Teleportation Setup

Teleport Settings

This section allows you to define how teleportation of players who fall into the void will be handled. The available options are detailed below:

teleport_on_void:
  # Is this feature enabled?
  enabled: false
  # Worlds where this feature will not be enabled
  ignored_worlds:
    - IgnoredWorld

  # Setting the place where the player will be teleported the first time
  destination_place_settings:
    # Destination location where the player will be teleported for the first time
    # Available options: Spawn, Lobby
    destination_place: Spawn
    # If destination_place is Lobby and multiple_lobbies is true, this will be the lobby to consider.
    # If destination_place is Spawn and by_world is true, this will be the spawn to consider.
    destination: world

Considerations

• If enabled is activated, players who fall into the void will be automatically teleported to the specified location (by default, the Spawn).

• Worlds listed in ignored_worlds will be excluded from this functionality.

Conditions

In this section you can check conditions before making the teleport and execute actions if they are met or not. Learn how to use conditions [HERE].

Actions

In this section, you can define actions that will be executed after the player teleports. These actions allow you to further customize the teleportation process. You can learn how to configure actions in detail in the corresponding section of this documentation. [HERE].

teleport_conditions:
  conditions: []
teleport_actions:
  actions: []

teleport_on_respawn:
  enabled: true
  ignored_worlds:
    - IgnoredWorld
  ignore_bed: false

  destination_place_settings:
    destination_place: Spawn
    destination: world
  teleport_conditions:
    conditions: []  
  teleport_actions:
    actions: [] 

Respawn Teleport Settings

Teleport Settings

This section allows you to define how player teleportation will be handled when respawning after death. The available options are detailed below:

teleport_on_respawn:
  # Is this feature enabled?
  enabled: true
  # Worlds where this feature will not take effect upon player death
  ignored_worlds:
    - IgnoredWorld
  # Whether to ignore if the player has a bed (includes any kind of respawn save)
  # false means the player will go to their own spawn point
  ignore_bed: false

  # Setting the place where the player will be teleported the first time
  destination_place_settings:
    # Destination location where the player will be teleported for the first time
    # Available options: Spawn, Lobby
    destination_place: Spawn
    # If destination_place is Lobby and multiple_lobbies is true, this will be the lobby to consider.
    # If destination_place is Spawn and by_world is true, this will be the spawn to consider.
    destination: world

Considerations

• If enabled is checked, players will be teleported to the specified location (by default, the Spawn) upon respawning.

• The ignored_worlds list allows you to exclude specific worlds from this functionality.

• The ignore_bed option determines whether the player's bed should be ignored. If set to false, the player will respawn at their assigned spawn point, rather than being teleported.

Conditions

In this section you can check conditions before making the teleport and execute actions if they are met or not. Learn how to use conditions [HERE].

Actions

In this section, you can define actions that will be executed after the player teleports. These actions allow you to further customize the teleportation process. You can learn how to configure actions in detail in the corresponding section of this documentation. [HERE].

teleport_conditions:
  conditions: []
teleport_actions:
  actions: []