· 6 years ago · Mar 28, 2020, 03:52 PM
1
2#! IMPORTANT !
3#All config tables here starting with 'bot.*' will only be used as default values for each bot.
4#To make bot-instance specific changes go to the 'Bots' folder (configs.bots_path) and set your configuration values in the desired bot config.
5[bot]
6#This field will be automatically set when you call '!bot setup'.
7#The bot will use the specified group to set/update the required permissions and add himself into it.
8#You can set this field manually if you already have a preexisting group the bot should add himself to.
9bot_group_id = 0
10#Tries to fetch a cover image when playing.
11generate_status_avatar = true
12#Sets the description of the bot to the current song title.
13set_status_description = true
14#The language the bot should use to respond to users. (Make sure you have added the required language packs)
15language = "en"
16#Starts the instance when the TS3AudioBot is launched.
17run = false
18
19[bot.commands]
20#Defines how the bot tries to match your !commands. Possible types:
21# - exact : Only when the command matches exactly.
22# - substring : The shortest command starting with the given prefix.
23# - ic3 : 'interleaved continuous character chain' A fuzzy algorithm similar to hamming distance but preferring characters at the start.
24matcher = "ic3"
25#Defines how the bot handles messages which are too long for a single ts3 message. Options are:
26# - split : The message will be split up into multiple messages.
27# - drop : Does not send the message.
28long_message = "Split"
29#Limits the split count for long messages. When for example set to 1 the message will simply be trimmed to one message.
30long_message_split_limit = 1
31#Enables colors and text highlights for respones.
32color = true
33#Limits the maximum command complexity to prevent endless loops.
34command_complexity = 64
35
36[bot.commands.alias]
37
38[bot.connect]
39#The server password. Leave empty for none.
40server_password = { pw = "", hashed = false, autohash = false }
41#The default channel password. Leave empty for none.
42channel_password = { pw = "", hashed = false, autohash = false }
43#Overrides the displayed version for the ts3 client. Leave empty for default.
44client_version = { build = "3.5.1", platform = "Linux", sign = "YtR6uJ0zzFwlAXoV1ikV8DVD9y7ka0WCh46wvALArdCBw9zaBLE7ese6Uu3U2Dmg4//ook5cNvupeOlzHcGPDQ==" }
45#The address, ip or nickname (and port; default: 9987) of the TeamSpeak3 server
46address = ""
47#Default channel when connecting. Use a channel path or "/<id>".
48#Examples: "Home/Lobby", "/5", "Home/Afk \\/ Not Here".
49channel = ""
50#The client badges. You can set a comma seperated string with max three GUID's. Here is a list: http://yat.qa/ressourcen/abzeichen-badges/
51badges = ""
52#Client nickname when connecting.
53name = "TS3Bots24 | Bot"
54
55[bot.connect.identity]
56#||| DO NOT MAKE THIS KEY PUBLIC ||| The client identity. You can import a teamspeak3 identity here too.
57key = ""
58#The client identity offset determining the security level.
59offset = 0
60#The client identity security level which should be calculated before connecting
61#or -1 to generate on demand when connecting.
62level = -1
63
64[bot.reconnect]
65ontimeout = ["1s", "2s", "5s", "10s", "30s", "1m", "5m", "repeat last"]
66onkick = [20s]
67onban = [20s]
68onerror = ["30s", "repeat last"]
69onshutdown = ["5m"]
70
71[bot.audio]
72#When a new song starts the volume will be trimmed to between min and max.
73#When the current volume already is between min and max nothing will happen.
74#To completely or partially disable this feature, set min to 0 and/or max to 100.
75volume = { default = 50.0, min = 25.0, max = 75.0 }
76#The maximum volume a normal user can request. Only user with the 'ts3ab.admin.volume' permission can request higher volumes.
77max_user_volume = 100.0
78#Specifies the bitrate (in kbps) for sending audio.
79#Values between 8 and 98 are supported, more or less can work but without guarantees.
80#Reference values: 16 - very poor (~3KiB/s), 24 - poor (~4KiB/s), 32 - okay (~5KiB/s), 48 - good (~7KiB/s), 64 - very good (~9KiB/s), 96 - deluxe (~13KiB/s)
81bitrate = 48
82#How the bot should play music. Options are:
83# - whisper : Whispers to the channel where the request came from. Other users can join with '!subscribe'.
84# - voice : Sends via normal voice to the current channel. '!subscribe' will not work in this mode.
85# - !... : A custom command. Use '!xecute (!a) (!b)' for example to execute multiple commands.
86send_mode = "voice"
87
88[bot.playlists]
89
90[bot.history]
91#Enable or disable history features completely to save resources.
92enabled = true
93#Whether or not deleted history ids should be filled up with new songs.
94fill_deleted_ids = true
95
96[bot.events]
97#Called when the bot is connected.
98onconnect = ""
99#Called when the bot gets disconnected.
100ondisconnect = ""
101#Called when the bot does not play anything for a certain amount of time.
102onidle = ""
103#Specifies how long the bot has to be idle until the 'onidle' event gets fired.
104#You can specify the time in the ISO-8601 format "PT30S" or like: 15s, 1h, 3m30s
105idletime = "0s"
106#Called when the last client leaves the channel of the bot. Delay can be specified
107onalone = ""
108#Specifies how long the bot has to be alone until the 'onalone' event gets fired.
109#You can specify the time in the ISO-8601 format "PT30S" or like: 15s, 1h, 3m30s
110alone_delay = "0s"
111#Called when the bot was alone and a client joins his channel. Delay can be specified.
112onparty = ""
113#Specifies how long the bot has to be alone until the 'onalone' event gets fired.
114#You can specify the time in the ISO-8601 format "PT30S" or like: 15s, 1h, 3m30s
115party_delay = "0s"
116
117[configs]
118#Path to a folder where the configuration files for each bot template will be stored.
119bots_path = "bots"
120#Enable to contribute to the global stats tracker to help us improve our service.
121#We do NOT send/store any IPs, identifiable information or logs for this.
122#If you want to check how a stats packet looks like you can run the bot with 'TS3AudioBot --stats-example'.
123#To disable contributing without config you can run the bot with 'TS3AudioBot --stats-disabled'. This will ignore the config value.
124send_stats = true
125
126[db]
127#The path to the database file for persistent data.
128path = "ts3audiobot.db"
129
130[factories]
131#The default path to look for local resources.
132media = { path = "" }
133
134[tools]
135#Path to the youtube-dl binary or local git repository.
136youtube-dl = { path = "" }
137
138#The path to ffmpeg.
139[tools.ffmpeg]
140path = "ffmpeg"
141
142[rights]
143#Path to the permission file. The file will be generated if it doesn't exist.
144path = "rights.toml"
145
146[plugins]
147#The path to the plugins folder.
148path = "plugins"
149
150[plugins.load]
151
152[web]
153#An array of all urls the web api should be possible to be accessed with.
154hosts = ["*"]
155#The port for the web server.
156port = 58913
157
158[web.api]
159#If you want to enable the web api.
160enabled = true
161#Limits the maximum command complexity to prevent endless loops.
162command_complexity = 64
163#See: bot.commands.matcher
164matcher = "exact"
165
166[web.interface]
167#If you want to enable the webinterface.
168enabled = true
169#The webinterface folder to host. Leave empty to let the bot look for default locations.
170path = ""