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.
    • 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
    • Sends a test message using the currently active type.
  • /wmtest [value]
    • Sends 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

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

Installation

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

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.0.tar.gz (6.4 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.0-py2.py3-none-any.whl (7.3 kB view details)

Uploaded Python 2Python 3

File details

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

File metadata

File hashes

Hashes for endstone_welcome_message-0.2.0.tar.gz
Algorithm Hash digest
SHA256 ff40b5d77227a32600ba5e67510fa53043ac1ba062de4aa0c3153c52b199a7b5
MD5 d8cb25dfe19dc3574852be8dc29014bc
BLAKE2b-256 76fe3f77142bdb71b1775b74df3c9ccd28c394484d2ce9f3eca39ef6b8ef9819

See more details on using hashes here.

Provenance

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

File metadata

File hashes

Hashes for endstone_welcome_message-0.2.0-py2.py3-none-any.whl
Algorithm Hash digest
SHA256 cac8878ab0135af2628a6a42049ca0588df9edec42e43adbd64356544d6025d7
MD5 d44dd11ae73c0916ff1b2c8fa3cc8651
BLAKE2b-256 eb6dd438b25772179c60facb8d3c7270907bb278eb9b82a4625d9835db468764

See more details on using hashes here.

Provenance

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