Skip to main content

A simple plugin for Endstone that sends a welcome message to players when they join. The message can be shown in chat, tip, popup, toast, title, or form format.

Project description

endstone-welcome-message

A simple plugin for Endstone that sends a welcome message to players when they join. The message can be shown in chat, tip, popup, toast, title, or form format.

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

Available Commands

All configuration is done via in-game commands:

/wmset <key> <value>

Used to update specific configuration options for the welcome message.

  • /wmset type <value>

    • Sets the message type.
    • Valid values: chat, tip, popup, toast, title, form
    • Example: /wmset type title
  • /wmset header <value>

    • Sets the message header.
    • Supports placeholders and Minecraft color codes.
    • Only used for toast, title, and form types.
    • Example: /wmset header Welcome {player_name}!
  • /wmset body <value>

    • Sets the message body.
    • Supports placeholders and Minecraft color codes.
    • Use \n for new lines.
    • Note that the Toast message type does not support new lines.
    • Example: /wmset body Hi {player_name}\nWelcome to our server
  • /wmset button <value>

    • Sets the form button text.
    • Only used for form type.
    • Example: /wmset button Close
  • /wmset wait <0-5>

    • Delays message for 0–5 seconds after player joins.
    • Example: /wmset wait 2

/wmopts

Displays the current configuration for the welcome message.

  • /wmopts

/wmtest [value]

Used to manually preview the welcome message for testing before enabling it server-wide.

  • /wmtest

    • Previews a test message using the currently active type.
  • /wmtest [value]

    • Previews a test message using the specified type.
    • Valid values: chat, tip, popup, toast, title, form
    • Example: /wmtest popup

/wmenable or /wmon

Enables the welcome message system with the current configuration options.

  • /wmenable or /wmon

/wmdisable or /wmoff

Disables the welcome message system.

  • /wmdisable or /wmoff

Installation

  1. Download the latest .whl file from GitHub Releases and place it into your plugins/ folder.
  2. Restart or reload the server.

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.2.1.tar.gz (6.6 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.2.1-py3-none-any.whl (8.0 kB view details)

Uploaded Python 3

File details

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

File metadata

File hashes

Hashes for endstone_welcome_message-0.2.1.tar.gz
Algorithm Hash digest
SHA256 39596780934819fd5368f0eb57d2e3ce3eccbc180ec9a3bd1b9954f2c233e580
MD5 c706c020684732dd050d0226eb6f6b7c
BLAKE2b-256 81daf6d5992edff31e69137a9de09e9a6043d006f38590d4910d4b2c8294f13a

See more details on using hashes here.

Provenance

The following attestation bundles were made for endstone_welcome_message-0.2.1.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.2.1-py3-none-any.whl.

File metadata

File hashes

Hashes for endstone_welcome_message-0.2.1-py3-none-any.whl
Algorithm Hash digest
SHA256 92b47eb754360b183ab42dc7a8107298eed72b480c80ded8b0956b8de0bcad9d
MD5 acbf33141e8d64c40b45d61c89bf25d3
BLAKE2b-256 da534241af8ce1deac49bb2a4c6732f71323777706726601d3632ac7d2cb4f7e

See more details on using hashes here.

Provenance

The following attestation bundles were made for endstone_welcome_message-0.2.1-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