## 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:
<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" />
### 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:
```toml
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:
```toml
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:
```toml
body = "§3Hello §6{player_name}§3. Welcome to our Minecraft Server."
```
Example with multiline 1:
```toml
body = "This is a\n multiline welcome message"
```
Example with multiline 2:
```toml
body = """This is a
multiline welcome message"""
```
#### ```form_button_text```
Form Button text
Effective only when type is 6 (Form)
Example:
```toml
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.
```toml
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 |
Raw data
{
"_id": null,
"home_page": null,
"name": "endstone-welcome-message",
"maintainer": null,
"docs_url": null,
"requires_python": null,
"maintainer_email": null,
"keywords": "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/69/45/98ca43cfcbadde13b45c5e8b729c057d9c274d78e71c7ab9adce27693d37/endstone_welcome_message-0.1.61.tar.gz",
"platform": null,
"description": "## endstone-welcome-message \n\nA 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.\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### Config file options\n#### ```type```\nWelcome message type.\n\nValid values are between 0 and 6.\n| Value | Description |\n| --- | --- |\n| 0 | Disables welcome message |\n| 1 | Chat message |\n| 2 | Tip message |\n| 3 | Popup message |\n| 4 | Toast message |\n| 5 | Title message |\n| 6 | Form message |\n\nExample:\n```toml\ntype = 1\n```\n\n#### ```header```\nToast, Title or Form message header\n\nEffective only when type is 4 (Toast), 5 (Title) or 6 (Form).\n\nYou can use ```\u00a7``` style Minecraft color codes and ```{}``` style placeholders like: ```{player_name}```, ```{player_ping}```\n\nExample:\n```toml\nheader = \"\u00a7u\u00a7lWelcome \u00a7s{player_name}\"\n```\n\n#### ```body```\nWelcome message body\n\nYou can use ```\u00a7``` style Minecraft color codes and ```{}``` style placeholders like: ```{player_name}```, ```{player_ping}```\n\nYou can use newlines within the welcome message body.\nTo do this, you can use ```\\n``` within a single line or break lines using triple quotes.\n\nNote that the Toast message type does not support newlines.\n\nExample:\n```toml\nbody = \"\u00a73Hello \u00a76{player_name}\u00a73. Welcome to our Minecraft Server.\"\n```\n\nExample with multiline 1:\n```toml\nbody = \"This is a\\n multiline welcome message\"\n```\n\nExample with multiline 2:\n```toml\nbody = \"\"\"This is a\nmultiline welcome message\"\"\"\n```\n\n#### ```form_button_text```\nForm Button text\n\nEffective only when type is 6 (Form)\n\nExample:\n```toml\nform_button_text = \"OK\"\n```\n\n#### ```wait_before```\nWait before the welcome message is displayed (in seconds).\n\nValid values are between 0 and 5.\n\n0 disables waiting.\n```toml\nwait_before = 0 \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": null,
"summary": "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.",
"version": "0.1.61",
"project_urls": {
"Homepage": "https://github.com/cenk/endstone-welcome-message"
},
"split_keywords": [
"chat",
" endstone",
" form",
" message",
" minecraft",
" plugin",
" popup",
" tip",
" title",
" toast",
" welcome"
],
"urls": [
{
"comment_text": null,
"digests": {
"blake2b_256": "383b2c8661a98dc27946fc22bddda51726c5c035288697c452dde907ac5a2916",
"md5": "87c8568c5074bac822c0866ba4a74a77",
"sha256": "9e59a3fa85b93399e173c1cdce6c032feceebbea1cdb31aa8f7a303de68835e8"
},
"downloads": -1,
"filename": "endstone_welcome_message-0.1.61-py2.py3-none-any.whl",
"has_sig": false,
"md5_digest": "87c8568c5074bac822c0866ba4a74a77",
"packagetype": "bdist_wheel",
"python_version": "py2.py3",
"requires_python": null,
"size": 6026,
"upload_time": "2025-07-23T00:19:10",
"upload_time_iso_8601": "2025-07-23T00:19:10.840892Z",
"url": "https://files.pythonhosted.org/packages/38/3b/2c8661a98dc27946fc22bddda51726c5c035288697c452dde907ac5a2916/endstone_welcome_message-0.1.61-py2.py3-none-any.whl",
"yanked": false,
"yanked_reason": null
},
{
"comment_text": null,
"digests": {
"blake2b_256": "694598ca43cfcbadde13b45c5e8b729c057d9c274d78e71c7ab9adce27693d37",
"md5": "a2e3a39f9574436605b80d9f6e56ffdf",
"sha256": "ab37f2f8a53418c6287f4092cf9cac11cad662d781bc9f0151b37ac2ea22b316"
},
"downloads": -1,
"filename": "endstone_welcome_message-0.1.61.tar.gz",
"has_sig": false,
"md5_digest": "a2e3a39f9574436605b80d9f6e56ffdf",
"packagetype": "sdist",
"python_version": "source",
"requires_python": null,
"size": 5562,
"upload_time": "2025-07-23T00:19:11",
"upload_time_iso_8601": "2025-07-23T00:19:11.865131Z",
"url": "https://files.pythonhosted.org/packages/69/45/98ca43cfcbadde13b45c5e8b729c057d9c274d78e71c7ab9adce27693d37/endstone_welcome_message-0.1.61.tar.gz",
"yanked": false,
"yanked_reason": null
}
],
"upload_time": "2025-07-23 00:19:11",
"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"
}
JSON
