teamspeak-query-plugin-framework / tsqpf-plugin-welcomemessage

Plugin for the Java based Teamspeak Query Plugin Framework, enabling you to send out custom welcome messages with placeholders.

WelcomeMessage

Customize your servers welcome message with this simple plugin. It also allows you to add server variables to your welcome message, such as online users, online administrators, etc.

💡 How does it work?

If a client joins your server, this plugin sends him a custom welcome message, which can be configured in the plugins config.

🚀 Gettings started

Just download the latest release that's compatible with your TSQPF version and copy it into its plugin directory. After you've done that, either reload or restart your framework instance in order to get it loaded and initiated.

⚙️ Configuration

Here's a list of all config keys, value datatypes and a description:

KEY | DATATYPE | DESCRIPTION

• messageWelcome : [String] Defines the welcome message.
• messageWelcomePoke : [String] Defines the poke message on client join (leave empty to disable feature).
• messageFirstJoin : [String] Defines the message sent to client on first join (leave empty to disable feature).
• messageFirstJoinPoke : [String] Defines the poke message sent to client on first join (leave empty to disable feature).
• staffGroups : [Integer] Staff groups of your server (separated by comma with no whitespaces).

⚙️ Message Placeholder

Here's a list of all placeholders that can be used in the welcome message:

KEY | DESCRIPTION

• onlineUsers : Total count of online users, minus the framework.
• onlineOtherUsers : Count of other online users, minus own client and framework.
• totalUniqueUsers : Count of unique users in the database.
• servergroupCount : Count of server groups.
• channelCount : Count of channels.
• channelgroupCount : Count of channel groups.
• onlineStaffCount : Count of online staff members.
• bannedClientCount : Count of banned clients.
• lastIssuedBanDate : Date of last issues ban.
• clientNickname : The clients nickname.

📁 Directory Tree

AntiAFK/
└── plugin.conf

📜 Vortexdata Certification

This plugin is developed by VortexdataNET for the Teamspeak Query Plugin Framework. Every release is being tested for any bugs, its performance or security issues. You are free to use, modify or redistribute the plugin.

tsqpf-plugin-welcomemessage's Issues

Improve performance / response time

Inclusion of new placeholders have drastically slowed down response times.

JoinEventListener throwing exception on quick login / logout

This occurs if eg. query crawler quickly connects and disconnect from a server running this plugin. This is due to the fact that the sendPrivateMessage method can not be completed in time. The query has already disconnection when the method has been completed, rendering the client id invalid.

Add more placeholder values

%onlineOtherUsers% [Integer]: Returns the currently connected user count minus one (the user receiving the welcome message).
%totalUniqueUsers% [Integer]: Returns the total user count of the server database.
%servergroupCount% [Integer]: Returns the total count of current server groups.
%channelCount% [Integer]: Returns the current number of channels.
%channelgroupCount% [Integer]: Returns the current number of channel groups.
%onlineStaffCount% [Integer]: Returns the current count of online staff members.
%bannedPlayersCount% [Integer]: Returns the number of banned clients (only uses clients from ban list).
%lastIssuedBanDate% [String]: Returns the date and time of the last issued ban (Requires AdminTools).
%lastIssuedKickDate% [String]: Returns the date and time of the last issued kick (Requires AdminTools).
%onlineLivestreamersCount% [Integer]: Returns a count of all live streamers currently online (Requires LivestreamManager).
%currentlyStreamingLivestreamers% [Integer]: Return a count of all live streamers currently streaming (Requires LivestreamManager).

%clientNickname% [String]: Return the client's nickname.