· 6 years ago · Nov 28, 2019, 04:42 PM
1#! IMPORTANT !
2#All config tables here starting with 'bot.*' will only be used as default values for each bot.
3#To make bot-instance specific changes go to the 'Bots' folder (configs.bots_path) and set your configuration values in the desired bot config.
4[bot]
5#This field will be automatically set when you call '!bot setup'.
6#The bot will use the specified group to set/update the required permissions and add himself into it.
7#You can set this field manually if you already have a preexisting group the bot should add himself to.
8bot_group_id = 0
9#Tries to fetch a cover image when playing.
10generate_status_avatar = true
11#Sets the description of the bot to the current song title.
12set_status_description = true
13#The language the bot should use to respond to users. (Make sure you have added the required language packs)
14language = "en"
15#Starts the instance when the TS3AudioBot is launched.
16run = false
17
18[bot.commands]
19#Defines how the bot tries to match your !commands. Possible types:
20# - exact : Only when the command matches exactly.
21# - substring : The shortest command starting with the given prefix.
22# - ic3 : 'interleaved continuous character chain' A fuzzy algorithm similar to hamming distance but preferring characters at the start.
23matcher = "ic3"
24#Defines how the bot handles messages which are too long for a single ts3 message. Options are:
25# - split : The message will be split up into multiple messages.
26# - drop : Does not send the message.
27long_message = "Split"
28#Limits the split count for long messages. When for example set to 1 the message will simply be trimmed to one message.
29long_message_split_limit = 1
30#Enables colors and text highlights for respones.
31color = true
32#Limits the maximum command complexity to prevent endless loops.
33command_complexity = 64
34
35[bot.commands.alias]
36
37[bot.connect]
38#The server password. Leave empty for none.
39server_password = { pw = "", hashed = false, autohash = false }
40#The default channel password. Leave empty for none.
41channel_password = { pw = "", hashed = false, autohash = false }
42#Overrides the displayed version for the ts3 client. Leave empty for default.
43client_version = { build = "", platform = "", sign = "" }
44#The address, ip or nickname (and port; default: 9987) of the TeamSpeak3 server
45address = ""
46#Default channel when connecting. Use a channel path or "/<id>".
47#Examples: "Home/Lobby", "/5", "Home/Afk \\/ Not Here".
48channel = ""
49#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/
50badges = ""
51#Client nickname when connecting.
52name = "Welcome by. o-net.eu"
53
54[bot.connect.identity]
55#||| DO NOT MAKE THIS KEY PUBLIC ||| The client identity. You can import a teamspeak3 identity here too.
56key = ""
57#The client identity offset determining the security level.
58offset = 0
59#The client identity security level which should be calculated before connecting
60#or -1 to generate on demand when connecting.
61level = -1
62
63[bot.reconnect]
64ontimeout = ["1s", "2s", "5s", "10s", "30s", "1m", "5m", "repeat last"]
65onkick = []
66onban = []
67onerror = ["30s", "repeat last"]
68onshutdown = ["5m"]
69
70[bot.audio]
71#When a new song starts the volume will be trimmed to between min and max.
72#When the current volume already is between min and max nothing will happen.
73#To completely or partially disable this feature, set min to 0 and/or max to 100.
74volume = { default = 50.0, min = 25.0, max = 75.0 }
75#The maximum volume a normal user can request. Only user with the 'ts3ab.admin.volume' permission can request higher volumes.
76max_user_volume = 100.0
77#Specifies the bitrate (in kbps) for sending audio.
78#Values between 8 and 98 are supported, more or less can work but without guarantees.
79#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)
80bitrate = 48
81#How the bot should play music. Options are:
82# - whisper : Whispers to the channel where the request came from. Other users can join with '!subscribe'.
83# - voice : Sends via normal voice to the current channel. '!subscribe' will not work in this mode.
84# - !... : A custom command. Use '!xecute (!a) (!b)' for example to execute multiple commands.
85send_mode = "voice"
86
87[bot.playlists]
88max_item_count = 1000
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 with quotation marks "PT30S" or like: 15s, 1h, 3m30s
105idletime = "5m"
106
107[configs]
108#Path to a folder where the configuration files for each bot template will be stored.
109bots_path = "bots"
110
111[db]
112#The path to the database file for persistent data.
113path = "ts3audiobot.db"
114
115[factories]
116#The default path to look for local resources.
117media = { path = "" }
118
119[tools]
120#Path to the youtube-dl binary or local git repository.
121youtube-dl = { path = "/usr/local/bin/youtube-dl" }
122
123#The path to ffmpeg.
124[tools.ffmpeg]
125path = "ffmpeg"
126
127[rights]
128#Path to the permission file. The file will be generated if it doesn't exist.
129path = "rights.toml"
130
131[plugins]
132#The path to the plugins folder.
133path = "plugins"
134#Write to .status files to store a plugin enable status persistently and restart them on launch.
135write_status_files = false
136
137[plugins.load]
138
139[web]
140#An array of all urls the web api should be possible to be accessed with.
141hosts = ["*"]
142#The port for the web server.
143port = 58914
144
145[web.api]
146#If you want to enable the web api.
147enabled = true
148#Limits the maximum command complexity to prevent endless loops.
149command_complexity = 64
150#See: bot.commands.matcher
151matcher = "exact"
152
153[web.interface]
154#If you want to enable the webinterface.
155enabled = true
156#The webinterface folder to host. Leave empty to let the bot look for default locations.
157path = ""