U-Beautiful-Chat

---

✨Introductions

17 types of variables

• Health
• Device
• Money
• Mode
• Dimension
• Ping
• Level
• Online-time
• Break
• Place
• Death
• PVP
• PVE
• KD
• Pick-up
• Drop
• Move-distance

• 2 types of nicknames
  • Nickname
  • Unique nickname (operators)
• History messages recorder
• Simplify join/left prompts
• Free of tedious file editing
• Support with full GUI forms
• Support with hot reloading
• Support with localized multi-language

---

📦Installation

Check your Endstone's version

• Endstone 0.10.5+
  • 251220

Check your pre-plugins

• Optional pre-plugins
  • ZX_UI
• Required pre-plugins
  • UMoney
  • UStatistic

1. Ensure you have downloaded the correct version and installed all required pre-plugins
2. Place the .whl file into your server's plugins folder
3. Restart your server
4. Enter the command /ubc to call out the main form of U-Beautiful-Chat

---

📄File structure

plugins/
├─ u-beautiful-chat/
│  ├─ config.json
│  ├─ nickname.json
│  ├─ lang/
│  │  ├─ zh_CN.json
│  │  ├─ en_US.json

---

⚙️Configuration

config.json

{
    "variables_order": "",
    "is_set_or_update_nickname_enabled": true, // If set to true, all players can set/update their nickname
    "set_or_update_nickname_cost": 10,
    "max_nickname_len": 10, // The max num of chars a nickname can achieve
    "is_record_history_message_enabled": true,
    /**
    If set to true,
    players' messages will be recorded by the server,
    and the server will send all recorded history messages to a newly joined player
    **/
    "max_history_message_num_recorded": 15, // The max num of players' messages will be stored by the server
    "is_simplify_join_or_left_prompt_enabled": true,
    /**
    If set to true,
    player join prompts will be displayed as "[+] {player_name}",
    and player left prompts will be displayed as "[-] {player_name}".
    
    In addition, the server will play sound to all players,
    note.bell for join event, and note.guitar for left event
    **/
}

nickname.json

{
    "umaru rize": {
        "nickname": "doge_cmd",
        "unique_nickname": "Server owner"
    }
}

---

🌎Localized multi-language

• Currently supported localized languages for U-Beautiful-Chat:

• zh_CN
• en_US

• How to add more languages to U-Beautiful-Chat? Here we use Japanese for an example.
  • Create a file named ja_JP.json and place it into lang folder
  • Copy all key-value pairs from en_US.json and paste them into ja_JP.json
  • Refer to the English values and translate them all into Japanese, then save the file.
  • Restart your server, and you're all done!
• If you'd like your translated language to be included as one of the official languages of this plugin, feel free to shoot over a PR.

---

💪API

# Read only
# Get the specified players' nickname
self.server.plugin_manager.get_plugin("u_beautiful_chat").api_get_player_nickname(player_name: str) -> str

# Get the specified players' unique nickname
self.server.plugin_manager.get_plugin("u_beautiful_chat").api_get_player_unique_nickname(player_name: str) -> str

---

🎨Screenshots

You can view related screenshots of U-Beautiful-Chat from images folder of this repo.