Skip to main content

A simple Endstone plugin that allows you to send players a welcome message via chat, tip, toast, title, popup or form when they join the server.

Project description

endstone-welcome-message

A simple Endstone plugin that allows you to send players a welcome message via chat, tip, toast, title, popup or form when they join the server.

Message types

1 - Chat message:

chat

2 - Tip message:

tip

3 - Popup message:

popup

4 - Toast message:

toast

5 - Title message:

title

6 - Form message:

form

Config file options

type

Welcome message type.

Valid values are between 0 and 6.

Value Description
0 Disables welcome message
1 Chat message
2 Tip message
3 Popup message
4 Toast message
5 Title message
6 Form message

Example:

type = 1

header

Toast, Title or Form message header

Effective only when type is 4 (Toast), 5 (Title) or 6 (Form).

You can use § style Minecraft color codes and {} style placeholders like: {player_name}, {player_ping}

Example:

header = "§u§lWelcome §s{player_name}"

body

Welcome message body

You can use § style Minecraft color codes and {} style placeholders like: {player_name}, {player_ping}

You can use newlines within the welcome message body. To do this, you can use \n within a single line or break lines using triple quotes.

Note that the Toast message type does not support newlines.

Example:

body = "§3Hello §6{player_name}§3. Welcome to our Minecraft Server."

Example with multiline 1:

body = "This is a\n multiline welcome message"

Example with multiline 2:

body = """This is a
multiline welcome message"""

form_button_text

Form Button text

Effective only when type is 6 (Form)

Example:

form_button_text = "OK"

wait_before

Wait before the welcome message is displayed (in seconds).

Valid values are between 0 and 5.

0 disables waiting.

wait_before = 0 

Placeholders

You can use the following placeholders in your welcome message.

Placeholder Description
{player_name} Player's name
{player_locale} Player's current locale
{player_device_os} Player's operation system
{player_device_id} Player's current device id
{player_hostname} Player's hostname
{player_port} Player's port number
{player_game_mode} Player's current game mode
{player_game_version} Player's current game version
{player_exp_level} Player's current experience level
{player_total_exp} Player's total experience points
{player_exp_progress} Player's current experience progress towards the next level
{player_ping} Player's average ping
{player_dimension_name} Player's current dimension name
{player_dimension_id} Player's current dimension id
{player_coordinate_x} Player's current x coordinate
{player_coordinate_y} Player's current y coordinate
{player_coordinate_z} Player's current z coordinate
{player_health} Player's health
{player_max_health} Player's max health
{player_xuid} Player's XUID
{player_uuid} Player's UUID
{server_level_name} Server's level name
{server_max_players} The maximum amount of player's which can login to this server
{server_online_players} Current online players count
{server_start_time} Start time of the server
{server_locale} Server's current locale
{server_endstone_version} Server's Endstone version
{server_minecraft_version} Server's Minecraft version
{server_port} Server's IPv4 port
{server_port_v6} Server's IPv6 port

Project details


Download files

Download the file for your platform. If you're not sure which to choose, learn more about installing packages.

Source Distribution

endstone_welcome_message-0.1.62.tar.gz (5.1 kB view details)

Uploaded Source

Built Distribution

If you're not sure about the file name format, learn more about wheel file names.

endstone_welcome_message-0.1.62-py2.py3-none-any.whl (6.2 kB view details)

Uploaded Python 2Python 3

File details

Details for the file endstone_welcome_message-0.1.62.tar.gz.

File metadata

File hashes

Hashes for endstone_welcome_message-0.1.62.tar.gz
Algorithm Hash digest
SHA256 033ec6cc93335e26c461fb08a42303a446bf4e102ba8361ca40671074c107f97
MD5 3b01d05b63a0772114c41e37ed61e266
BLAKE2b-256 75ac6fa8b6217518616d8f65e7c3493c5e55156b5d2aa4bc13fa470a5686812e

See more details on using hashes here.

Provenance

The following attestation bundles were made for endstone_welcome_message-0.1.62.tar.gz:

Publisher: release-and-publish.yml on cenk/endstone-welcome-message

Attestations: Values shown here reflect the state when the release was signed and may no longer be current.

File details

Details for the file endstone_welcome_message-0.1.62-py2.py3-none-any.whl.

File metadata

File hashes

Hashes for endstone_welcome_message-0.1.62-py2.py3-none-any.whl
Algorithm Hash digest
SHA256 9788770004fc57b0a023668a88dc4055a587380563ea84716632dc5e7922c2c3
MD5 67ed9a473c5ae409be776996926eab91
BLAKE2b-256 8388aa4cc8f2e23a0d1f6e6478835de7033f4ddd542a85db15c0f6423287bb5a

See more details on using hashes here.

Provenance

The following attestation bundles were made for endstone_welcome_message-0.1.62-py2.py3-none-any.whl:

Publisher: release-and-publish.yml on cenk/endstone-welcome-message

Attestations: Values shown here reflect the state when the release was signed and may no longer be current.

Supported by

AWS Cloud computing and Security Sponsor Datadog Monitoring Depot Continuous Integration Fastly CDN Google Download Analytics Pingdom Monitoring Sentry Error logging StatusPage Status page