| Name | endstone-welcome-message JSON |
| Version |
0.2.1
JSON |
| download |
| home_page | None |
| Summary | 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. |
| upload_time | 2025-08-03 17:13:54 |
| maintainer | None |
| docs_url | None |
| author | None |
| requires_python | >=3.9 |
| license | MIT License
Copyright (c) 2025 cenk
Permission is hereby granted, free of charge, to any person obtaining a copy
of this software and associated documentation files (the "Software"), to deal
in the Software without restriction, including without limitation the rights
to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
copies of the Software, and to permit persons to whom the Software is
furnished to do so, subject to the following conditions:
The above copyright notice and this permission notice shall be included in all
copies or substantial portions of the Software.
THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
SOFTWARE. |
| keywords |
bedrock
chat
endstone
form
message
minecraft
plugin
popup
tip
title
toast
welcome
|
| VCS |
 |
| bugtrack_url |
|
| requirements |
No requirements were recorded.
|
| Travis-CI |
No Travis.
|
| coveralls test coverage |
No coveralls.
|
# 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:
<img width="570" height="152" alt="chat" src="https://github.com/user-attachments/assets/06e80480-0e4a-4cba-90f7-bab561ecf356" />
### 2 - Tip message:
<img width="754" height="84" alt="tip" src="https://github.com/user-attachments/assets/7b8c4a09-625a-4cba-9fe7-7cc39e92cc70" />
### 3 - Popup message:
<img width="382" height="131" alt="popup" src="https://github.com/user-attachments/assets/fb04c737-584a-4d4b-8c24-ee1da29edda9" />
### 4 - Toast message:
<img width="841" height="123" alt="toast" src="https://github.com/user-attachments/assets/c6074f6f-6559-4e3f-adbf-ae52be206d10" />
### 5 - Title message:
<img width="1595" height="550" alt="title" src="https://github.com/user-attachments/assets/ea257934-d1a7-4e3f-ad9c-38effb958700" />
### 6 - Form message:
<img width="455" height="407" alt="form" src="https://github.com/user-attachments/assets/6198471b-82b1-4888-8bda-13af17a5d458" />
---
## 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](https://github.com/cenk/endstone-welcome-message/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 |
Raw data
{
"_id": null,
"home_page": null,
"name": "endstone-welcome-message",
"maintainer": null,
"docs_url": null,
"requires_python": ">=3.9",
"maintainer_email": null,
"keywords": "bedrock, chat, endstone, form, message, minecraft, plugin, popup, tip, title, toast, welcome",
"author": null,
"author_email": "cenk <cenk@cenk.app>",
"download_url": "https://files.pythonhosted.org/packages/81/da/f6d5992edff31e69137a9de09e9a6043d006f38590d4910d4b2c8294f13a/endstone_welcome_message-0.2.1.tar.gz",
"platform": null,
"description": "# endstone-welcome-message\n\nA 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.\n\n## Message types\n### 1 - Chat message:\n<img width=\"570\" height=\"152\" alt=\"chat\" src=\"https://github.com/user-attachments/assets/06e80480-0e4a-4cba-90f7-bab561ecf356\" />\n\n### 2 - Tip message:\n<img width=\"754\" height=\"84\" alt=\"tip\" src=\"https://github.com/user-attachments/assets/7b8c4a09-625a-4cba-9fe7-7cc39e92cc70\" />\n\n### 3 - Popup message:\n<img width=\"382\" height=\"131\" alt=\"popup\" src=\"https://github.com/user-attachments/assets/fb04c737-584a-4d4b-8c24-ee1da29edda9\" />\n\n### 4 - Toast message:\n<img width=\"841\" height=\"123\" alt=\"toast\" src=\"https://github.com/user-attachments/assets/c6074f6f-6559-4e3f-adbf-ae52be206d10\" />\n\n### 5 - Title message:\n<img width=\"1595\" height=\"550\" alt=\"title\" src=\"https://github.com/user-attachments/assets/ea257934-d1a7-4e3f-ad9c-38effb958700\" />\n\n### 6 - Form message:\n<img width=\"455\" height=\"407\" alt=\"form\" src=\"https://github.com/user-attachments/assets/6198471b-82b1-4888-8bda-13af17a5d458\" />\n\n---\n\n## Available Commands\n\nAll configuration is done via in-game commands:\n\n### `/wmset <key> <value>`\nUsed to update specific configuration options for the welcome message.\n\n- `/wmset type <value>`\n - Sets the message type.\n - Valid values: `chat`, `tip`, `popup`, `toast`, `title`, `form`\n - Example: `/wmset type title`\n\n- `/wmset header <value>`\n - Sets the message header.\n - Supports placeholders and Minecraft color codes.\n - Only used for `toast`, `title`, and `form` types.\n - Example: `/wmset header Welcome {player_name}!`\n\n- `/wmset body <value>`\n - Sets the message body.\n - Supports placeholders and Minecraft color codes.\n - Use `\\n` for new lines.\n - Note that the Toast message type does not support new lines.\n - Example: `/wmset body Hi {player_name}\\nWelcome to our server`\n\n- `/wmset button <value>`\n - Sets the form button text.\n - Only used for form type.\n - Example: `/wmset button Close`\n\n- `/wmset wait <0-5>`\n - Delays message for 0\u20135 seconds after player joins.\n - Example: `/wmset wait 2`\n\n### `/wmopts`\nDisplays the current configuration for the welcome message.\n\n- `/wmopts`\n\n### `/wmtest [value]`\nUsed to manually preview the welcome message for testing before enabling it server-wide.\n\n- `/wmtest`\n - Previews a test message using the currently active type.\n\n- `/wmtest [value]`\n - Previews a test message using the specified type.\n - Valid values: `chat`, `tip`, `popup`, `toast`, `title`, `form`\n - Example: `/wmtest popup`\n\n### `/wmenable` or `/wmon`\nEnables the welcome message system with the current configuration options.\n\n- `/wmenable` or `/wmon`\n\n### `/wmdisable` or `/wmoff`\nDisables the welcome message system.\n\n- `/wmdisable` or `/wmoff`\n\n---\n\n## Installation\n1. Download the latest `.whl` file from [GitHub Releases](https://github.com/cenk/endstone-welcome-message/releases) and place it into your `plugins/` folder.\n2. Restart or reload the server.\n\n---\n\n### Placeholders\nYou can use the following placeholders in your welcome message. \n| Placeholder | Description |\n| --- | --- |\n| {player_name} | Player's name |\n| {player_locale} | Player's current locale |\n| {player_device_os} | Player's operation system |\n| {player_device_id} | Player's current device id |\n| {player_hostname} | Player's hostname |\n| {player_port} | Player's port number |\n| {player_game_mode} | Player's current game mode |\n| {player_game_version} | Player's current game version |\n| {player_exp_level} | Player's current experience level |\n| {player_total_exp} | Player's total experience points |\n| {player_exp_progress} | Player's current experience progress towards the next level |\n| {player_ping} | Player's average ping |\n| {player_dimension_name} | Player's current dimension name |\n| {player_dimension_id} | Player's current dimension id |\n| {player_coordinate_x} | Player's current x coordinate |\n| {player_coordinate_y} | Player's current y coordinate |\n| {player_coordinate_z} | Player's current z coordinate |\n| {player_health} | Player's health |\n| {player_max_health} | Player's max health |\n| {player_xuid} | Player's XUID |\n| {player_uuid} | Player's UUID |\n| {server_level_name} | Server's level name |\n| {server_max_players} | The maximum amount of player's which can login to this server |\n| {server_online_players} | Current online players count |\n| {server_start_time} | Start time of the server |\n| {server_locale} | Server's current locale |\n| {server_endstone_version} | Server's Endstone version |\n| {server_minecraft_version} | Server's Minecraft version |\n| {server_port} | Server's IPv4 port |\n| {server_port_v6} | Server's IPv6 port |\n",
"bugtrack_url": null,
"license": "MIT License\n \n Copyright (c) 2025 cenk\n \n Permission is hereby granted, free of charge, to any person obtaining a copy\n of this software and associated documentation files (the \"Software\"), to deal\n in the Software without restriction, including without limitation the rights\n to use, copy, modify, merge, publish, distribute, sublicense, and/or sell\n copies of the Software, and to permit persons to whom the Software is\n furnished to do so, subject to the following conditions:\n \n The above copyright notice and this permission notice shall be included in all\n copies or substantial portions of the Software.\n \n THE SOFTWARE IS PROVIDED \"AS IS\", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR\n IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,\n FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE\n AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER\n LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,\n OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE\n SOFTWARE.",
"summary": "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.",
"version": "0.2.1",
"project_urls": {
"Documentation": "https://github.com/cenk/endstone-welcome-message/blob/main/README.md",
"Homepage": "https://github.com/cenk/endstone-welcome-message",
"Issues": "https://github.com/cenk/endstone-welcome-message/issues"
},
"split_keywords": [
"bedrock",
" chat",
" endstone",
" form",
" message",
" minecraft",
" plugin",
" popup",
" tip",
" title",
" toast",
" welcome"
],
"urls": [
{
"comment_text": null,
"digests": {
"blake2b_256": "da534241af8ce1deac49bb2a4c6732f71323777706726601d3632ac7d2cb4f7e",
"md5": "acbf33141e8d64c40b45d61c89bf25d3",
"sha256": "92b47eb754360b183ab42dc7a8107298eed72b480c80ded8b0956b8de0bcad9d"
},
"downloads": -1,
"filename": "endstone_welcome_message-0.2.1-py3-none-any.whl",
"has_sig": false,
"md5_digest": "acbf33141e8d64c40b45d61c89bf25d3",
"packagetype": "bdist_wheel",
"python_version": "py3",
"requires_python": ">=3.9",
"size": 8026,
"upload_time": "2025-08-03T17:13:53",
"upload_time_iso_8601": "2025-08-03T17:13:53.714057Z",
"url": "https://files.pythonhosted.org/packages/da/53/4241af8ce1deac49bb2a4c6732f71323777706726601d3632ac7d2cb4f7e/endstone_welcome_message-0.2.1-py3-none-any.whl",
"yanked": false,
"yanked_reason": null
},
{
"comment_text": null,
"digests": {
"blake2b_256": "81daf6d5992edff31e69137a9de09e9a6043d006f38590d4910d4b2c8294f13a",
"md5": "c706c020684732dd050d0226eb6f6b7c",
"sha256": "39596780934819fd5368f0eb57d2e3ce3eccbc180ec9a3bd1b9954f2c233e580"
},
"downloads": -1,
"filename": "endstone_welcome_message-0.2.1.tar.gz",
"has_sig": false,
"md5_digest": "c706c020684732dd050d0226eb6f6b7c",
"packagetype": "sdist",
"python_version": "source",
"requires_python": ">=3.9",
"size": 6631,
"upload_time": "2025-08-03T17:13:54",
"upload_time_iso_8601": "2025-08-03T17:13:54.986317Z",
"url": "https://files.pythonhosted.org/packages/81/da/f6d5992edff31e69137a9de09e9a6043d006f38590d4910d4b2c8294f13a/endstone_welcome_message-0.2.1.tar.gz",
"yanked": false,
"yanked_reason": null
}
],
"upload_time": "2025-08-03 17:13:54",
"github": true,
"gitlab": false,
"bitbucket": false,
"codeberg": false,
"github_user": "cenk",
"github_project": "endstone-welcome-message",
"travis_ci": false,
"coveralls": false,
"github_actions": true,
"lcname": "endstone-welcome-message"
}
