Dana
Welcomes players and announces when they join or leave

Supported Games

Features

  • Welcome players with private messages in chat and their F1 console.
  • Notify the server when players join or leave.
  • Notify the server of newcomers who play the server for the first time.
  • Incorporate a variety of placeholders, such as the player count, number of queued players, and more.

Permissions

  • welcomer.bypass - The server will not be notified of the entry or exit of the player with this permission. Beneficial to grant for admins.

Commands

  • welcomer.test - Chat command to help easily edit and customize your messages.
  • welcomer.clear - Console command to clear the data file containing the players' Steam IDs.

Configuration

{
  "Chat Avatar": 0,
  "Show Player Avatar": true,
  "Enable Chat Welcome Message": true,
  "Enable Console Welcome Message": true,
  "Enable Join Message": true,
  "Enable Newcomer Join Message": true,
  "Enable Leave Message": true,
  "Enable Rage Quit Message": true,
  "Clear Data On Wipe": true,
  "Log To Console": true
}
  • "Enable Newcomer Join Message" - The player whose ID is in the data file will not trigger this message.
  • "Clear Data On Wipe" - Whether or not to clear the players' data on each wipe.
  • "Chat Avatar" - Allows you to change the default Rust avatar for chat messages to a custom Steam avatar. Only accepts Steam IDs, and a value of 0 will keep the default avatar.

Localization

{
  "Welcome.Chat": "There are currently {0} active players, {1} joining, {2} sleepers, and {3} in the queue",
  "Welcome.Console": "There are currently {0} active players, {1} joining, {2} sleepers, and {3} in the queue",
  "Join": "{0} joined from {1}",
  "Join.Newcomer ": "{0} joined for the very first time from {1}",
  "Leave": "{0} left the server for the reason {1}",
  "Test": "Test message",
  "Leave.RageQuit": "{0} rage quitted"
}

FAQ

Can I use special symbols in chat?

Not entirely. Rust has a very limited set of supported symbols for chat. However, you can try and find out which works.

Can I use Welcomer in Vanilla servers?

Yes. FacePunch has confirmed this plugin is allowed in Vanilla servers. For more details, check the community servers Guidelines.

How to add support for another language?

To add support for another language, create a new language folder under oxide/lang if not already created, copy the default language file to the new folder and then customize the messages. Finally, change the server default language using the command lang <language>

If you're still having difficulty, watch this Tutorial.

Credits

Tricky, the original author of this plugin (version 1.4)

MIT License


Copyright (c) 2020 Tricky


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.