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:
2 - Tip message:
3 - Popup message:
4 - Toast message:
5 - Title message:
6 - Form message:
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, andformtypes. - Example:
/wmset header Welcome {player_name}!
-
/wmset body <value>- Sets the message body.
- Supports placeholders and Minecraft color codes.
- Use
\nfor 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.
/wmenableor/wmon
/wmdisable or /wmoff
Disables the welcome message system.
/wmdisableor/wmoff
Installation
- Download the latest
.whlfile from GitHub Releases and place it into yourplugins/folder. - 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
Release history Release notifications | RSS feed
Download files
Download the file for your platform. If you're not sure which to choose, learn more about installing packages.
Source Distribution
Built Distribution
Filter files by name, interpreter, ABI, and platform.
If you're not sure about the file name format, learn more about wheel file names.
Copy a direct link to the current filters
File details
Details for the file endstone_welcome_message-0.2.1.tar.gz.
File metadata
- Download URL: endstone_welcome_message-0.2.1.tar.gz
- Upload date:
- Size: 6.6 kB
- Tags: Source
- Uploaded using Trusted Publishing? Yes
- Uploaded via: twine/6.1.0 CPython/3.12.9
File hashes
| Algorithm | Hash digest | |
|---|---|---|
| SHA256 |
39596780934819fd5368f0eb57d2e3ce3eccbc180ec9a3bd1b9954f2c233e580
|
|
| MD5 |
c706c020684732dd050d0226eb6f6b7c
|
|
| BLAKE2b-256 |
81daf6d5992edff31e69137a9de09e9a6043d006f38590d4910d4b2c8294f13a
|
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
-
Statement:
-
Statement type:
https://in-toto.io/Statement/v1 -
Predicate type:
https://docs.pypi.org/attestations/publish/v1 -
Subject name:
endstone_welcome_message-0.2.1.tar.gz -
Subject digest:
39596780934819fd5368f0eb57d2e3ce3eccbc180ec9a3bd1b9954f2c233e580 - Sigstore transparency entry: 346316540
- Sigstore integration time:
-
Permalink:
cenk/endstone-welcome-message@f0dbe6b2dea87cc082289faa8f8d1e5d621a2c49 -
Branch / Tag:
refs/tags/0.2.1 - Owner: https://github.com/cenk
-
Access:
public
-
Token Issuer:
https://token.actions.githubusercontent.com -
Runner Environment:
github-hosted -
Publication workflow:
release-and-publish.yml@f0dbe6b2dea87cc082289faa8f8d1e5d621a2c49 -
Trigger Event:
push
-
Statement type:
File details
Details for the file endstone_welcome_message-0.2.1-py3-none-any.whl.
File metadata
- Download URL: endstone_welcome_message-0.2.1-py3-none-any.whl
- Upload date:
- Size: 8.0 kB
- Tags: Python 3
- Uploaded using Trusted Publishing? Yes
- Uploaded via: twine/6.1.0 CPython/3.12.9
File hashes
| Algorithm | Hash digest | |
|---|---|---|
| SHA256 |
92b47eb754360b183ab42dc7a8107298eed72b480c80ded8b0956b8de0bcad9d
|
|
| MD5 |
acbf33141e8d64c40b45d61c89bf25d3
|
|
| BLAKE2b-256 |
da534241af8ce1deac49bb2a4c6732f71323777706726601d3632ac7d2cb4f7e
|
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
-
Statement:
-
Statement type:
https://in-toto.io/Statement/v1 -
Predicate type:
https://docs.pypi.org/attestations/publish/v1 -
Subject name:
endstone_welcome_message-0.2.1-py3-none-any.whl -
Subject digest:
92b47eb754360b183ab42dc7a8107298eed72b480c80ded8b0956b8de0bcad9d - Sigstore transparency entry: 346316541
- Sigstore integration time:
-
Permalink:
cenk/endstone-welcome-message@f0dbe6b2dea87cc082289faa8f8d1e5d621a2c49 -
Branch / Tag:
refs/tags/0.2.1 - Owner: https://github.com/cenk
-
Access:
public
-
Token Issuer:
https://token.actions.githubusercontent.com -
Runner Environment:
github-hosted -
Publication workflow:
release-and-publish.yml@f0dbe6b2dea87cc082289faa8f8d1e5d621a2c49 -
Trigger Event:
push
-
Statement type: