👋Welcome

Overview

Let your virtual players be polite and greets new players on your server.

Configuration

This module is definitively the most simple one to configure, in most cast the default configuration would work for your server.

Delay section

# Manage how long a player must be online before they can be welcomed.
delay:
  # The minimum delay between the first
  # player connection and the poof player greeting.
  # This is in seconds.
  minimum: 2

  # The maximum delay between the first
  # player connection and the poof player greeting.
  # This is in seconds.
  maximum: 10

This section allows you to configure the delay between the moment where a new player join the server and the moment where the virtual players greet him.

As for the other modules, you can configure the a delay range and the module will pick a random value within that range.

Note that both options are in seconds.

Chance section

# Control the probability of a poof player greeting a new player.
#
# This is being disabled by setting the probability to -1.
# It can be useful if you use a command to welcome players.
chance:
  # The minimum probability of a poof player greeting a new player.
  # This is a percentage.
  minimum: 10

  # The maximum probability of a poof player greeting a new player.
  # This is a percentage.
  maximum: 50

This section allows you to tweak the percentage of chance that a virtual players greets a new player.

The module will pick a random value within that range and compares it to a random generated number, if it's above that number, the virtual players will greet the new player.

Both options are percentages.

Command & Message

# Only use if you have a custom welcome command.
# This option can be disabled by typing "none".
command: "/welcome"

# This option allows you to set the welcome message.
# You can use the following placeholder:
#   %player% - The player's name.
#
# This option will be disabled if you have a custom welcome command.
messages:
  - "&7Welcome to the server, &f%player%&7!"

In this section you can configure how players should greet new players.

If you define a command such as /welcome, the messages are not taken in count by the module.

If the command field is filled, virtual players will execute this command themselves on new player join.

Otherwise you can configure a set of messages, and the module will pick a random one when a new player join your server.