Skip to content

Latest commit

 

History

History
87 lines (63 loc) · 4.43 KB

README.md

File metadata and controls

87 lines (63 loc) · 4.43 KB

About

This plugin extends your bot with the feature to automatically move clients to an AFK channel, when they are idle for a specific amount of time.

Available Commands

The following table shows all available arguments for the command !idlemover of this plugin:

Argument Description
version Sends a text message with the version of this plugin.
start Start this plugin
stop Stop this plugin
restart Restarts this plugin

Configuration

Enable this plugin by adding the following line under the Plugins section to your config.ini:

[Plugins]
IdleMover: idle_mover.main

Options

This plugin supports the following options:

Option Default Description
auto_start True Either if the plugin should automatically start when the Bot starts and it's configured or not.
enable_dry_run False Set to True, if you want to test the plugin without executing the actual tasks. Instead it logs what it would have done.
frequency 30.0 The frequency in seconds how often (and fast) the plugin should react (e.g. somebody is idle, every 30 seconds the bot would notice this and do something).
exclude_channels None Provide a comma seperated list of channel names, where clients should be ignored by the bot.
exclude_servergroups None Provide a comma seperated list of servergroup names, which should never get moved by the bot.
auto_move_back True Either if clients, which are no longer idle should be moved back to their original channel or not.
min_idle_time_seconds 600 The minimum time in seconds a client must be idle to get moved to the channel channel.
resp_channel_settings True Either if the channel settings like max. clients and password should be respected or not, even when the ServerQuery user could ignore them.
fallback_channel None Either to move a client, which could not be moved to the old channel due to an error (e.g. channel does not exist anymore or is full) to a different channel (provide the channel name pattern here) or leave him in the channel (set to None).
channel AFK The name of your AFK channel, where clients should be moved to while they are idle.

This plugin supports the following channel options:

NOTE: <alias> can be anything - it's only used to differentiate between multiple channel configurations. Supported characters for the alias: a-z, A-Z, 0-9_

Option Default Description
<alias>.channel_name None The channel name, where you want to override the global min_idle_time_seconds. The name can be a pattern.
<alias>.min_idle_time_seconds None The minimum time in seconds a client must be idle to get moved to the channel channel.

If you need to change some of these default options, simply add them to your config.ini under the respective ModuleName section:

[idle_mover]
frequency: 60.0
exclude_channels: Netflix,Poke me,Meeting
exclude_servergroups: Server Admin,Bot
min_idle_time_seconds: 300
channel: Away

lobby.channel_name: Lobby
lobby.min_idle_time_seconds: 120

pubg.channel_name: PUBG
pubg.min_idle_time_seconds: 2700

Please keep in mind, that you need to reload the plugin afterwards. Either by restarting the entire bot or by using a plugin command, if it has one.

Required Permissions

This plugin requires the following permissions on your TeamSpeak server:

Permission Explanation
b_virtualserver_client_list Allow the bot to get a list of all connected clients on your virtual server.
i_channel_subscribe_power The bot must be able to subscribe channels, so that clients can be found in those channels.
b_virtualserver_channel_list Allow the bot to get the list of available channels on your virtual server.
b_virtualserver_servergroup_list Allow the bot to get the list of available servergroups on your virtual server.
b_virtualserver_channel_search Allow the bot to find a channel based on a name pattern.
b_virtualserver_channel_list Allow the bot to list all channels.
b_channel_info_view Allow the bot to view channel information.
i_client_move_power Allow the bot to move clients.
i_client_private_textmessage_power The bot will send in specific cases a private message to the client. If somebody wants to know the plugin version for example.