# Config file of the JTS3ServerMod
# http://www.stefan1200.de
# This file must be saved with the ANSI encoding ISO-8859-1!
# Tea*Speak 3 server address
ts3_server_address = 127.0.0.1
# Tea*Speak 3 server query port, default is 10011 (raw) and 10022 (ssh)
ts3_server_query_port = 10101
# Tea*Speak 3 server query admin account name
ts3_server_query_login = XXXXXXX
# Tea*Speak 3 server query admin password
ts3_server_query_password = XXXXXXX
# Tea*Speak 3 server query mode, possible values: raw and ssh
# raw = The default unencrypted way to connect to the TS3 server.
# ssh = The communication to the TS3 server will be encrypted. Possible since TS3 server version 3.3.0 and needs to be activated at the TS3 server.
ts3_server_query_mode = raw
# Tea*Speak 3 virtual server ID or -1 to use ts3_virtualserver_port
ts3_virtualserver_id = 6
# Tea*Speak 3 virtual server port, only needed if ts3_virtualserver_id is set to -1
ts3_virtualserver_port = 9999
# Channel id, the bot will join into it after connecting. If not wanted, use a negative number like -1.
# Don't set the default channel here, because the bot is already in the default channel after connecting.
bot_channel_id = 11
# Activate the slow mode of the bot, 0 = disable, 1 = enable.
# If slow mode is activated, the bot connects slower to the server
# and disables some bot features to reduce the amount of needed commands.
# This feature may allow you to use the bot without whitelist the bot IP address.
# Slow mode disables the client database list cache and do not allow the bot check interval to be lower than 3 seconds.
bot_slowmode = 0
# Check every X seconds, default is 1. Values between 1 and 30 are allowed.
# If slow mode is activated, 3 is the lowest possible value.
bot_check_interval = 1
# A different encoding of the messages config files.
# Default is UTF-8 which should be good for all EU and US languages.
# Change this only if you know what you are doing!
# For English or German language you can also use the encoding ISO-8859-1
# A list of all valid ones: http://docs.oracle.com/javase/1.5.0/docs/guide/intl/encoding.doc.html
bot_messages_encoding = UTF-8
# This enables the client database list cache. This cache is needed for commands like !searchip or !searchdesc. 1 = Enable, 0 = Disable
bot_clientdblist_cache = 1
# This enables the global message variables. See readme file for a list of variables. 1 = Enable, 0 = Disable
# If enabled, you can use all server variables in all messages. If not needed, disable this to save performance.
bot_global_message_vars = 0
# Server Query name, this will be displayed as name of the connection.
bot_server_query_name = XXXXXX_JTS3
# Second Server Query name, this will be displayed as name of the connection.
# This name will be used, if the first name is already in use.
bot_server_query_name_2 = XXXXXX_AdminBot
# Change the date pattern, which will be used to format a date in chat functions and welcome message.
# To get help how to make such a pattern, look here: http://docs.oracle.com/javase/1.5.0/docs/api/java/text/SimpleDateFormat.html
bot_date_pattern = yyyy-MM-dd HH:mm:ss
# Change the timezone of the bot, which will be used for the date of the chat functions and welcome message.
# If nothing is set here, the default timezone of the operating system will be used.
# To get a list of valid timezones, look at the TZ column on the following page:
# https://en.wikipedia.org/wiki/List_of_tz_database_time_zones#List
bot_timezone =
# Should the bot try to connect forever if the Tea*Speak server or the bot is offline? 0 = disable, 1 = enable
bot_connect_forever = 1
# Minimum log level, how much details you want to be written to the bot log files? Default is 1.
# Higher log levels will be also written, as an example: You set log level to 2, level 2, 3 and critical errors will be written to bot log file.
# 0 = Debug
# 1 = Information (recommended and default)
# 2 = Warning (recommended for smaller log files)
# 3 = Error (experts only)
bot_log_level = 1
# A comma separated list (without spaces) of unique user ids, which should be able to use bot admin commands.
# The unique user ids looks like this: mBbHRXwDAG7R19Rv3PorhMwbZW4=
bot_admin_list =
# A comma separated list (without spaces) of server group ids, which should be able to use the following bot admin commands:
# !channellist, !listchannelgroups, !listinactiveclients, !listinactivechannels, !listservergroups, !msgchannelgroup, !msgservergroup, !pokechannelgroup,
# !pokeservergroup, !removeservergroups, !removechannelgroups, !searchclient, !searchdesc, !searchip, !setchannelgroup and !setchannelname.
# All other bot admin commands are not allowed!
bot_lightadmingroup_list =
# Set a comma separated list (without spaces) of needed bot functions here.
# Each function needs the function class (or plugin filename) and the function name, both separated with a colon.
# All possible function classes are listed below, that class is case sensitive!
# You can use external functions, they have to be in the plugins directory and you have to use the filename
# including the jar file extension as function class, as an example: AutoKickTimer.jar:akt
# That function name you choose is important and has to be unique. It will be used as prefix for the configuration key names and chat commands.
# Don't use spaces in the function names, only use letters, numbers, minus and underscore!
# Most functions allow multiple usage, that allows you to set as many welcome messages or idle check rules, as you want.
# Don't forget that you have to put all settings of the functions in this file.
# Hint: Start the bot with the argument -updateconfig after adding bot functions, that writes the configuration for all functions into this file!
# Whole command: java -jar JTS3ServerMod.jar -updateconfig
# Notice: This -updateconfig will also delete all lines of removed or renamed functions in this config file!
# For more information about the functions read documents/ConfigHelp.html or documents/ConfigHelp_deutsch.html!
#
# Example: IdleCheck:idle,IdleCheck:idle_guest,MuteMover:mute,WelcomeMessage:welcome,WelcomeMessage:welcome_guest
# This example gives you the following:
# - Two IdleCheck with the name idle and idle_guest
# - One MuteMover with the name mute
# - Two WelcomeMessage with the name welcome and welcome_guest
#
# Function list (multiple use possible):
# Advertising - Send messages to channel or server chat every X minutes
# AutoMove - Move connecting clients of a specified server group to a specified channel
# AwayMover - Move the client as soon as away status is set for longer than X seconds
# BadChannelNameCheck - Checking for bad channel names, can delete the channel and punish the client
# BadNicknameCheck - Checking for bad nicknames and can punish the client
# ChannelNotify - Notify specified server groups about clients joining a specified channel
# IdleCheck - Move or kick an idle client, can also send an idle warning message
# InactiveChannelCheck - Delete channels if empty for more than X hours
# InactiveClientsCleaner - Deletes clients (including permissions) from the TS3 database after X days inactivity (client database list cache must be enabled!)
# LastSeen - Chat command to check the last online time of a client
# MuteMover - Move the client as soon as the specified mute status is set for longer than X seconds
# RecordCheck - Move or kick a recording client (of course only the record function of the Tea*Speak client is detected)
# ServerGroupNotify - Notify specified server groups about clients of specified server groups connecting to the TS3 server
# ServerGroupProtection - Make sure that only specified clients are members of the specified server groups
# WelcomeMessage - Sends a message to new connected clients
bot_functions = AwayMover:away,BadNicknameCheck:badnickname,IdleCheck:idle,InactiveClientsCleaner:cleaner,LastSeen:lastseen,MuteMover:mute,
# Set a comma separated list (without spaces) of needed but disabled bot functions here.
# Same format as bot_functions!
# All functions you set here are not activated at bot start, but you can switch on functions using chat commands.
bot_functions_disabled =
# Move client back if not away anymore? Set yes or no here!
away_moveback = yes
# Channel id to move away clients into it
away_channel_id = 297
# Idle time in seconds after the client with away status will be moved to the channel.
# Has between 0 and 10000 seconds!
away_delay = 30
# A comma separated list (without spaces) of channel ids.
# Depends on the given mode, this channels can be ignored or only this channels will be checked!
# If no channels should be ignored, set no channels here and select the channel list mode ignore!
away_channel_list =
# Select one of the two modes for the channel list.
# ignore = The selected channels will be ignored.
# only = Only the selected channels will be checked.
away_channel_list_mode = ignore
# A comma separated list (without spaces) of server group ids.
# Depends on the given mode, this server groups can be ignored or only this server groups will be checked!
# If no server groups should be ignored, set no server groups here and select the group list mode ignore!
away_group_list =
# Select one of the two modes for the server group list.
# ignore = The selected server groups will be ignored.
# only = Only the selected server groups will be checked.
away_group_list_mode = ignore
# Select the message mode, how the client should get the message.
# poke, chat or none are valid values!
away_message_mode = none
# Path to file which contains the away mover message
away_file = %apphome%config/server1/awaymessages.cfg
# Kick client with a bad nickname? Set yes or no here!
badnickname_kick = yes
# Add complain entry to the user? Set yes or no here!
badnickname_add_complain = no
# A comma separated list (without spaces) of server group ids.
# Depends on the given mode, this server groups can be ignored or only this server groups will be checked!
# If no server groups should be ignored, set no server groups here and select the group list mode ignore!
badnickname_group_list =
# Select one of the two modes for the server group list.
# ignore = The selected server groups will be ignored and can have bad nicknames.
# only = Only the selected server groups will be checked.
badnickname_group_list_mode = ignore
# Select the message mode, how the client should get the message.
# poke or chat are valid values!
# If client kick is activated, the message will be always used as kick message!
badnickname_message_mode = poke
# Path to file which contains the bad nickname message and check rules.
badnickname_file = %apphome%config/server1/badnickname.cfg
# Set the idle warn time in minutes or set -1 to disable this feature.
idle_warn_time = -1
# Set the idle group time in minutes or set -1 to disable this feature.
# Clients will be added to the specified server group after being idle for this time!
idle_group_time = -1
# Set the idle move time in minutes or set -1 to disable this feature.
# Clients will be moved to the specified channel after being idle for this time!
idle_move_time = -1
# Set the idle kick time in minutes or set -1 to disable this feature.
# Clients will be kicked from the server after being idle for this time!
idle_kick_time = 240
# If the clients should be put into a temporary server group, set the server group id here.
# You should use a server group, which adds the server group name to the client name, so everyone can quickly see, that someone is away.
# Notice: That server group only need the following permissions (first three are set by default):
# i_group_needed_modify_power, i_group_needed_member_add_power, i_group_needed_member_remove_power and i_group_show_name_in_tree
# Important: Make sure, that the specified server group don't has set the permission b_group_is_permanent!
# You can also set -6 (sg name on the left side) or -9 (sg name on the right side) to create a new server group with the name AFK.
# This will update the bot configuration and the bot needs the permission b_virtualserver_servergroup_create one time!
idle_group_id = -1
# If the clients should be moved, set channel id to move idle clients into it.
idle_channel_id =
# If the clients got moved, move client back if not idle anymore? Set yes or no here!
idle_moveback = no
# A comma separated list (without spaces) of channel ids.
# Depends on the given mode, this channels can be ignored or only this channels will be checked!
# If no channels should be ignored, set no channels here and select the channel list mode ignore!
idle_channel_list =
# Select one of the two modes for the channel list.
# ignore = The selected channels will be ignored.
# only = Only the selected channels will be checked.
idle_channel_list_mode = ignore
# A comma separated list (without spaces) of server group ids.
# Depends on the given mode, this server groups can be ignored or only this server groups will be checked!
# If no server groups should be ignored, set no server groups here and select the group list mode ignore!
idle_group_list =
# Select one of the two modes for the server group list.
# ignore = The selected server groups will be ignored.
# only = Only the selected server groups will be checked.
idle_group_list_mode = ignore
# A minimum client count to activate the idle check (Query clients are not counted).
# If less clients are in the channel or on the server, idle check does nothing.
idle_min_clients = 2
# Select if the minimum client count is needed in the channel or on the server.
# channel or server are valid values!
idle_min_clients_mode = server
# Select the message mode, how the client should get the warning message.
# poke or chat are valid values!
idle_warn_message_mode = chat
# If the clients should be put into the specified server group, select the message mode, how the client should get the message.
# poke, chat or none are valid values!
idle_group_message_mode = chat
# If the clients should be moved to the specified channel, select the message mode, how the client should get the message.
# poke, chat or none are valid values!
idle_move_message_mode = chat
# Path to file which contains the idle messages
idle_file = %apphome%config/server1/idlecheckmessages.cfg
# How many days a client has to be inactive to get deleted from the TS3 server database?
# Possible values are between 30 and 730.
# Notice: After the client was deleted, the client can connect again to the server, but all permissions are lost!
cleaner_inactivity_days = 180
# A comma separated list (without spaces) of server group ids.
# Depends on the given mode, this server groups can be ignored or only this server groups will be checked!
# If no server groups should be ignored, set no server groups here and select the group list mode ignore!
cleaner_group_list =
# Select one of the two modes for the server group list.
# ignore = The selected server groups will be ignored.
# only = Only the selected server groups will be checked.
cleaner_group_list_mode = ignore
# Who should be able to use the last seen command? Possible values: all, botadmin, servergroup
lastseen_user = all
# A comma separated list (without spaces) of server group ids.
# Depends on the given mode, this server groups can be ignored or only this server groups will be allowed to use the !lastseen command!
# This is only needed, if user servergroup is selected!
lastseen_group_list =
# Select one of the two modes for the server group list.
# ignore = The selected server groups will be ignored.
# only = Only the selected server groups are allowed to use the !lastseen command!
lastseen_group_list_mode = ignore
# Move client back if not muted anymore? Set yes or no here!
mute_moveback = yes
# Enable move, if the headphone was muted using the Tea*Speak Client, yes or no
mute_headphone = yes
# Enable move, if the microphone was muted using the Tea*Speak Client, yes or no
mute_microphone = no
# Enable move, if the sound output hardware (for speakers/headphone) is missing or a disabled hardware is selected in the client settings.
# Set yes or no here!
mute_headphone_hardware = no
# Enable move, if the sound input hardware (for a microphone) is missing or a disabled hardware is selected in the client settings.
# This also happen, if someone is speaking on another Tea*Speak server. Set yes or no here!
mute_microphone_hardware = yes
# Move the client if the client has all selected conditions or at least one? Set all or one here!
mute_condition_mode = one
# Channel id to move muted clients into it
mute_channel_id = 297
# Idle time in seconds after the client with a specified mute status will be moved to the channel.
# Has between 0 and 10000 seconds!
mute_delay = 60
# A comma separated list (without spaces) of channel ids.
# Depends on the given mode, this channels can be ignored or only this channels will be checked!
# If no channels should be ignored, set no channels here and select the channel list mode ignore!
mute_channel_list =
# Select one of the two modes for the channel list.
# ignore = The selected channels will be ignored.
# only = Only the selected channels will be checked.
mute_channel_list_mode = ignore
# A comma separated list (without spaces) of server group ids.
# Depends on the given mode, this server groups can be ignored or only this server groups will be checked!
# If no server groups should be ignored, set no server groups here and select the group list mode ignore!
mute_group_list = 2,1,90
# Select one of the two modes for the server group list.
# ignore = The selected server groups will be ignored.
# only = Only the selected server groups will be checked.
mute_group_list_mode = ignore
# Select the message mode, how the client should get the message.
# poke, chat or none are valid values!
mute_message_mode = none
# Path to file which contains the mute mover message
mute_file = %apphome%config/server1/mutemessages.cfg
