· 6 years ago · Nov 16, 2019, 08:22 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]
6playlists = { path = "Playlists" }
7#This field will be automatically set when you call '!bot setup'.
8#The bot will use the specified group to set/update the required permissions and add himself into it.
9#You can set this field manually if you already have a preexisting group the bot should add himself to.
10bot_group_id = 0
11#Tries to fetch a cover image when playing.
12generate_status_avatar = true
13#Sets the description of the bot to the current song title.
14set_status_description = true
15#The language the bot should use to respond to users. (Make sure you have added the required language packs)
16language = "en"
17#Starts the instance when the TS3AudioBot is launched.
18run = false
19
20[bot.commands]
21#Defines how the bot tries to match your !commands. Possible types:
22# - exact : Only when the command matches exactly.
23# - substring : The shortest command starting with the given prefix.
24# - ic3 : 'interleaved continuous character chain' A fuzzy algorithm similar to hamming distance but preferring characters at the start.
25matcher = "ic3"
26#Defines how the bot handles messages which are too long for a single ts3 message. Options are:
27# - split : The message will be split up into multiple messages.
28# - drop : Does not send the message.
29long_message = "Split"
30#Limits the split count for long messages. When for example set to 1 the message will simply be trimmed to one message.
31long_message_split_limit = 1
32#Enables colors and text highlights for respones.
33color = true
34
35[bot.connect]
36#The server password. Leave empty for none.
37server_password = { pw = "", hashed = false, autohash = false }
38#The default channel password. Leave empty for none.
39channel_password = { pw = "", hashed = false, autohash = false }
40#Overrides the displayed version for the ts3 client. Leave empty for default.
41client_version = { build = "", platform = "", sign = "" }
42#The address, ip or nickname (and port; default: 9987) of the TeamSpeak3 server
43address = ""
44#Default channel when connecting. Use a channel path or '/<id>'.
45#Examples: 'Home/Lobby', '/5', 'Home/Afk \\/ Not Here'.
46channel = ""
47#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/
48badges = ""
49#Client nickname when connecting.
50name = "TS3AudioBot"
51
52[bot.connect.identity]
53#||| DO NOT MAKE THIS KEY PUBLIC ||| The client identity. You can import a teamspeak3 identity here too.
54key = ""
55#The client identity offset determining the security level.
56offset = 0
57#The client identity security level which should be calculated before connecting
58#or -1 to generate on demand when connecting.
59level = -1
60
61[bot.audio]
62#When a new song starts the volume will be trimmed to between min and max.
63#When the current volume already is between min and max nothing will happen.
64#To completely or partially disable this feature, set min to 0 and/or max to 100.
65volume = { default = 10.0, min = 10.0, max = 50.0 }
66#The maximum volume a normal user can request. Only user with the 'ts3ab.admin.volume' permission can request higher volumes.
67max_user_volume = 30.0
68#Specifies the bitrate (in kbps) for sending audio.
69#Values between 8 and 98 are supported, more or less can work but without guarantees.
70#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)
71bitrate = 48
72#How the bot should play music. Options are:
73# - whisper : Whispers to the channel where the request came from. Other users can join with '!subscribe'.
74# - voice : Sends via normal voice to the current channel. '!subscribe' will not work in this mode.
75# - !... : A custom command. Use '!xecute (!a) (!b)' for example to execute multiple commands.
76send_mode = "voice"
77
78[bot.history]
79#Enable or disable history features completely to save resources.
80enabled = true
81#Whether or not deleted history ids should be filled up with new songs.
82fill_deleted_ids = true
83
84[bot.events]
85#Called when the bot is connected.
86onconnect = ""
87#Called when the bot gets disconnected.
88ondisconnect = ""
89#Called when the bot does not play anything for a certain amount of time.
90onidle = ""
91#Specifies how long the bot has to be idle until the 'onidle' event gets fired.
92#You can specify the time in the ISO-8601 format with quotation marks "PT30S" or like: 15s, 1h, 3m30s
93idletime = "PT5M"
94
95[configs]
96#Path to a folder where the configuration files for each bot template will be stored.
97bots_path = "Bots"
98
99[db]
100#The path to the database file for persistent data.
101path = "ts3audiobot.db"
102
103[factories]
104#The default path to look for local resources.
105media = { path = "" }
106
107[tools]
108#Path to the youtube-dl binary or local git repository.
109youtube-dl = { path = "" }
110
111#The path to ffmpeg.
112[tools.ffmpeg]
113path = "ffmpeg"
114
115[rights]
116#Path to the permission file. The file will be generated if it doesn't exist.
117path = "rights.toml"
118
119[plugins]
120#The path to the plugins folder.
121path = "Plugins"
122#Write to .status files to store a plugin enable status persistently and restart them on launch.
123write_status_files = false
124
125[plugins.load]
126
127[web]
128#An array of all urls the web api should be possible to be accessed with.
129hosts = ["localhost", "127.0.0.1", "185.239.237.230"]
130#The port for the web server.
131port = 58913
132
133[web.api]
134#If you want to enable the web api.
135enabled = true
136
137[web.interface]
138#If you want to enable the webinterface.
139enabled = true
140#The webinterface folder to host. Leave empty to let the bot look for default locations.
141path = "WebInterface"