]> git.0d.be Git - botaradio.git/blob - configuration.default.ini
fix: no admin check for dropdatabase
[botaradio.git] / configuration.default.ini
1 # ========================================================
2 #  botamusique Default Configuration File
3 #  Version 6
4 # ========================================================
5 #  WARNING:
6 #           ******************************
7 #           **DO NOT MODIFIED THIS FILE.**
8 #           ******************************
9 #
10 #           Please create your own configuration file, and
11 #           ONLY ADD ITEMS YOU WANT TO MODIFY into it. Other
12 #           items will be loaded from this file automatically.
13 #           DO NOT DIRECTLY COPY THIS FILE.
14 #
15 #           That is because this file will be overridden
16 #           during updates. New options will be added and
17 #           old options (like [strings]) will be updated.
18 # ========================================================
19
20 [server]
21 host = 127.0.0.1
22 port = 64738
23 password =
24 channel =
25 # example: token1,token2
26 tokens =
27 certificate =
28
29 [bot]
30 username = botamusique
31 comment = Hi, I'm here to play radio, local music or youtube/soundcloud music. Have fun!
32 # default volume from 0 to 1.
33 volume = 0.1
34 # playback mode should be one of "one-shot", "loop", "random", "autoplay"
35 playback_mode = one-shot
36
37 # target version, stable or testing (testing need to bot installed with git)
38 target_version = stable
39
40 # Users allowed to kill the bot, or ban URLs.
41 admin = User1;User2;
42 # Folder that stores your local songs.
43 music_folder = music_folder/
44 # Folder that stores the downloaded music.
45 tmp_folder = /tmp/
46 database_path = database.db
47 pip3_path = venv/bin/pip
48 auto_check_update = True
49 logfile =
50
51 # in MB, 0 for no cache, -1 for unlimited size
52 tmp_folder_max_size = 10
53
54 # how many times the bot will try to download an item
55 download_attempts = 2
56
57 ignored_folders = tmp
58 ignored_files = Thumbs.db
59
60 announce_current_music = True
61 allow_other_channel_message = False
62 allow_private_message = True
63
64 # 'save_music_library': If this is set True, the bot will save the metadata of music into the database.
65 save_music_library = True
66
67 # 'refresh_cache_on_startup': If this is set true, the bot will refresh its music directory cache when starting up.
68 #  But it won't reload metadata from each files. If set to False, it will used the cache last time.
69 refresh_cache_on_startup = True
70
71 # If save_playlist is set True, the bot will save current
72 # playlist before quitting and reload it the next time it start.
73 save_playlist = True
74
75 # Maximum track played when a playlist is added.
76 max_track_playlist = 20
77
78 # Maximum music duration (minutes)
79 max_track_duration = 60
80
81 # If ducking is enabled, the bot will automatically attenuate its volume when someone is talking.
82 ducking = False
83 ducking_volume = 0.05
84 ducking_threshold = 3000
85
86 [webinterface]
87 # Set enabled to True if you'd like to use the web interface to manage your playlist, upload files, etc.
88 enabled = False
89 is_web_proxified = True
90 listening_addr = 127.0.0.1
91 listening_port = 8181
92 web_logfile =
93
94 # Set this option to True to enable password protection for the web interface
95 require_auth = False
96 user = 
97 password =
98
99 [debug]
100 # Set ffmpeg to True if you want to display DEBUG level log of ffmpeg.
101 ffmpeg = False
102 mumbleConnection = False
103
104 # This is a list of default radio stations.
105 [radio]
106 ponyville = http://192.99.131.205:8000/stream.mp3 "Here a command of !radio comment"
107 luna = http://radio.ponyvillelive.com:8002/stream "calm and orchestra music"
108 radiobrony = http://62.210.138.34:8000/live "Borny music of a friend"
109 celestiaradio = http://celestia.aiverse.org:8000/mp3_256
110 jazz = http://jazz-wr04.ice.infomaniak.ch/jazz-wr04-128.mp3 "Jazz Yeah !"
111
112
113
114
115
116 # ========================================================
117 # WARNING: WE DO NOT SUGGEST YOU MODIFY THE FOLLOWING
118 #          PARTS, EXCEPT YOU KNOW WHAT YOU ARE DOING.
119 # ========================================================
120 [commands]
121 # This is a list of characters the bot recognizes as command prefix.
122 command_symbol = !:!
123 # This option split username, in case you use such kind of mumo plugins https://wiki.mumble.info/wiki/Mumo#Set_Status
124 split_username_at_space = False
125
126
127 play_file = file, f
128 play_file_match = filematch, fm
129 play_url = url
130 play_radio = radio
131 play_playlist = playlist
132
133 rb_query = rbquery
134 rb_play = rbplay
135
136 yt_search = ysearch
137 yt_play = yplay
138
139 help = help
140 pause = pause
141 play = p, play
142 stop = stop
143 remove = rm
144 clear = clear
145 skip = skip
146 last = last
147 current_music = np, now
148 volume = volume
149 kill = kill
150 stop_and_getout = oust
151 joinme = joinme
152 queue = queue
153 repeat = repeat
154 random = random
155 mode = mode
156 update = update
157 list_file = listfile
158
159 play_tag = tag
160 add_tag = addtag
161 remove_tag = untag
162 find_tagged = findtagged, ft
163
164 user_ban = userban
165 user_unban = userunban
166 url_ban = urlban
167 url_unban = urlunban
168
169 ducking = duck
170 ducking_threshold = duckthres
171 ducking_volume = duckv
172
173 drop_database = dropdatabase
174 rescan = rescan
175
176 [strings]
177 current_volume = Current volume: {volume}.
178 current_ducking_volume = Volume on ducking: {volume}.
179 change_volume = Volume set to {volume} by {user}.
180 change_ducking_volume = Volume on ducking set to {volume} by {user}.
181 bad_command = {command}: command not found.
182 bad_parameter = {command}: invalid parameter.
183 error_executing_command = {command}: Command failed with error: {error}.
184 not_admin = You are not an admin!
185 not_playing = Nothing is playing right now.
186 no_file = File not found.
187 wrong_pattern = Invalid regex: {error}.
188 file_added  = Added: {item}.
189 multiple_file_added  = Multiple files added:
190 multiple_file_found  = Found:
191 bad_url = Bad URL requested.
192 preconfigurated_radio = Preconfigurated Radio available:
193 unable_download = Error while downloading music...
194 which_command = Do you mean <br /> {commands}
195 multiple_matches = File not found! Possible candidates:
196 queue_contents = Items on the playlist:
197 queue_empty = Playlist is empty!
198 invalid_index = Invalid index <i>{index}</i>. Use '!queue' to see your playlist.
199 now_playing = Playing {item}
200 radio = Radio
201 file = File
202 url_from_playlist = URL
203 url = URL
204 radio_item = <a href="{url}"><b>{title}</b></a> <i>from</i> {name} <i>added by</i> {user}
205 file_item = <b>{artist} - {title}</b> <i>added by</i> {user}
206 url_from_playlist_item = <a href="{url}"><b>{title}</b></a> <i>from playlist</i> <a href="{playlist_url}">{playlist}</a> <i>added by</i> {user}
207 url_item = <a href="{url}"><b>{title}</b></a> <i>added by</i> {user}
208 not_in_my_channel = You're not in my channel, command refused!
209 pm_not_allowed = Private message aren't allowed.
210 too_long = <b>{song}</b> is too long, removed from playlist!
211 download_in_progress = Download of <b>{item}</b> in progress...
212 removing_item = Removed entry {item} from playlist.
213 user_ban = You are banned, not allowed to do that!
214 url_ban = This url is banned!
215 rb_query_result = This is the result of your query, send !rbplay 'ID' to play a station:
216 rb_play_empty = Please specify a radio station ID!
217 paused = Music paused.
218 stopped = Music stopped.
219 cleared = Playlist emptied.
220 database_dropped = Database dropped. All records have gone.
221 new_version_found = <h3>Update Available!</h3> New version of botamusique is available, send <i>!update</i> to update!
222 start_updating = Start updating...
223 file_missed = Music file '{file}' missed! This item has been removed from the playlist.
224 unknown_mode = Unknown playback mode '{mode}'. It should be one of <i>one-shot</i>, <i>loop</i>, <i>random</i>.
225 current_mode = Current playback mode is <i>{mode}</i>.
226 change_mode = Playback mode set to <i>{mode}</i> by {user}.
227 repeat = Repeat {song} for {n} times.
228 yt_result = Youtube query result: {result_table} Use <i>!ytplay</i> {{index}} to play the item you want. <br />
229             <i>!ytquery -n</i> for the next page.
230 yt_no_more = No more results!
231 yt_query_error = Unable to query youtube!
232 playlist_fetching_failed = Unable to fetch the playlist!
233 cache_refreshed = Cache refreshed!
234 added_tags = Added tags <i>{tags}</i> to <b>{song}</b>.
235 added_tags_to_all = Added tags <i>{tags}</i> to songs on the playlist.
236 removed_tags = Removed tags <i>{tags}</i> from <b>{song}</b>.
237 removed_tags_from_all = Removed tags <i>{tags}</i> from songs on the playlist.
238 cleared_tags = Removed all tags from <b>{song}</b>.
239 cleared_tags_from_all = Removed all tags from songs on the playlist.
240
241 help = <h3>Commands</h3>
242        <b>Control</b>
243        <ul>
244        <li> <b>!play </b> (or <b>!p</b>) [{num}] - resume from pausing / start to play (the num-th song is num is given) </li>
245        <li> <b>!<u>pa</u>use </b> - pause </li>
246        <li> <b>!<u>st</u>op </b> - stop playing </li>
247        <li> <b>!<u>sk</u>ip </b> - jump to the next song </li>
248        <li> <b>!<u>la</u>st </b> - jump to the last song </li>
249        <li> <b>!<u>v</u>olume </b> {volume} - get or change the volume (from 0 to 100) </li>
250        <li> <b>!<u>m</u>ode </b> [{mode}] - get or set the playback mode, {mode} should be one of <i>one-shot</i> (remove
251        item once played), <i>repeat</i> (looping through the playlist), <i>random</i> (randomize the playlist),
252        <i>autoplay</i> (randomly grab something from the music library).</li>
253        <li> <b>!duck </b> on/off - enable or disable ducking function </li>
254        <li> <b>!duckv </b> - set the volume of the bot when ducking is activated </li>
255        <li> <b>!<u>duckt</u>hres </b> - set the threshold of volume to activate ducking (3000 by default) </li>
256        <li> <b>!<u>o</u>ust </b> - stop playing and go to default channel </li>
257        </ul>
258        <b>Playlist</b>
259        <ul>
260        <li> <b>!<u>n</u>ow </b> (or <b>!np</b>) - display the current song </li>
261        <li> <b>!<u>q</u>ueue </b> - display items in the playlist </li>
262        <li> <b>!file </b>(or <b>!f</b>) {path/folder/index/keyword} - add a single file to the playlist by its path or index returned by !listfile </li>
263        <li> <b>!<u>filem</u>atch </b>(or <b>!fm</b>) {pattern} - add all files that match regex {pattern} </li>
264        <li> <b>!<u>ur</u>l </b> {url} - add Youtube or SoundCloud music </li>
265        <li> <b>!<u>playl</u>ist </b> {url} [{offset}] - add all items in a Youtube or SoundCloud playlist, and start with the {offset}-th item </li>
266        <li> <b>!<u>t</u>ag </b> {tags} - add all items with tags {tags}, tags separated by ",". </li>
267        <li> <b>!rm </b> {num} - remove the num-th song on the playlist </li>
268        <li> <b>!<u>rep</u>eat </b> [{num}] - repeat current song {num} (1 by default) times.</li>
269        <li> <b>!<u>ran</u>dom </b> - randomize the playlist.</li>
270        <li> <b>!<u>rad</u>io </b> {url} - append a radio {url} to the playlist </li>
271        <li> <b>!<u>li</u>stfile </b> [{pattern}] - display list of available files (that match the regex pattern if {pattern} is given) </li>
272        <li> <b>!<u>rbq</u>uery </b> {keyword} - query http://www.radio-browser.info for a radio station </li>
273        <li> <b>!<u>rbp</u>lay </b> {id} - play a radio station with {id} (eg. !rbplay 96746) </li>
274        <li> <b>!<u>ys</u>earch </b> {keyword} - query youtube. Use <i>!ytquery -n</i> to turn the page. </li>
275        <li> <b>!<u>yp</u>lay </b> {index/keywords} - play an item from the list returned by <i>!ytquery</i>, or add the
276        first search result of {keywords} into the playlist.</li>
277        </ul>
278        <b>Tag</b>
279        <ul>
280        <li> <b>!<u>addt</u>ag </b> {index} {tags} - add {tags} to {index}-th item on the playlist, tags separated by ",". </li>
281        <li> <b>!<u>addt</u>ag </b> * {tags} - add {tags} to all items on the playlist. </li>
282        <li> <b>!<u>un</u>tag </b> {index/*} {tags} - remove {tags} from {index}-th item on the playlist. </li>
283        <li> <b>!<u>un</u>tag </b> {index/*} * - remove all tags from {index}-th item on the playlist. </li>
284        <li> <b>!<u>fin</u>dtagged </b> (or <b>!ft</b>) {tags} - find item with {tags} in the music library. </li>
285        </ul>
286        <b>Other</b>
287        <ul>
288        <li> <b>!<u>j</u>oinme {token} </b> - join your own channel with {token}.</li>
289        </ul>
290
291 admin_help = <h3>Admin command</h3>
292              <ul>
293              <li><b>!<u>k</u>ill </b> - kill the bot</li>
294              <li><b>!<u>up</u>date </b> - update the bot</li>
295              <li><b>!<u>userb</u>an </b> {user}  - ban a user</li>
296              <li><b>!<u>useru</u>nban </b> {user}  - unban a user</li>
297              <li><b>!<u>urlb</u>an </b> {url}  - ban an url</li>
298              <li><b>!<u>urlu</u>nban </b> {url}  - unban an url</li>
299              <li><b>!<u>urlu</u>nban </b> {url}  - unban an url</li>
300              <li><b>!rescan </b> {url}  - rebuild local music file cache</li>
301              <li><b>!dropdatabase</b> - clear the entire database, you will lose all settings and music library.</li>
302              </ul>
303
304