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