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 # If save_playlist is set True, the bot will save current
  65 # playlist before quitting and reload it the next time it start.
  66 save_playlist = True
  67
  68 # Maximum track played when a playlist is added.
  69 max_track_playlist = 20
  70
  71 # Maximum music duration (minutes)
  72 max_track_duration = 60
  73
  74 # If ducking is enabled, the bot will automatically attenuate its volume when someone is talking.
  75 ducking = False
  76 ducking_volume = 0.05
  77 ducking_threshold = 3000
  78
  79 [webinterface]
  80 # Set enabled to True if you'd like to use the web interface to manage your playlist, upload files, etc.
  81 enabled = False
  82 is_web_proxified = True
  83 listening_addr = 127.0.0.1
  84 listening_port = 8181
  85 web_logfile =
  86
  87 # Set this option to True to enable password protection for the web interface
  88 require_auth = False
  89 user =
  90 password =
  91
  92 [debug]
  93 # Set ffmpeg to True if you want to display DEBUG level log of ffmpeg.
  94 ffmpeg = False
  95 mumbleConnection = False
  96
  97 # This is a list of default radio stations.
  98 [radio]
  99 ponyville = http://192.99.131.205:8000/stream.mp3 "Here a command of !radio comment"
 100 luna = http://radio.ponyvillelive.com:8002/stream "calm and orchestra music"
 101 radiobrony = http://62.210.138.34:8000/live "Borny music of a friend"
 102 celestiaradio = http://celestia.aiverse.org:8000/mp3_256
 103 jazz = http://jazz-wr04.ice.infomaniak.ch/jazz-wr04-128.mp3 "Jazz Yeah !"
 104
 105
 106
 107
 108
 109 # ========================================================
 110 # WARNING: WE DO NOT SUGGEST YOU MODIFY THE FOLLOWING
 111 #          PARTS, EXCEPT YOU KNOW WHAT YOU ARE DOING.
 112 # ========================================================
 113 [commands]
 114 # This is a list of characters the bot recognizes as command prefix.
 115 command_symbol = !:！
 116 # This option split username, in case you use such kind of mumo plugins https://wiki.mumble.info/wiki/Mumo#Set_Status
 117 split_username_at_space = False
 118
 119
 120 play_file = file, f
 121 play_file_match = filematch, fm
 122 play_url = url
 123 play_radio = radio
 124 play_playlist = playlist
 125
 126 rb_query = rbquery
 127 rb_play = rbplay
 128
 129 yt_search = ysearch
 130 yt_play = yplay
 131
 132 help = help
 133 pause = pause
 134 play = p, play
 135 stop = stop
 136 remove = rm
 137 clear = clear
 138 skip = skip
 139 last = last
 140 current_music = np, now
 141 volume = volume
 142 kill = kill
 143 stop_and_getout = oust
 144 joinme = joinme
 145 queue = queue
 146 repeat = repeat
 147 random = random
 148 mode = mode
 149 update = update
 150 list_file = listfile
 151
 152 user_ban = userban
 153 user_unban = userunban
 154 url_ban = urlban
 155 url_unban = urlunban
 156
 157 ducking = duck
 158 ducking_threshold = duckthres
 159 ducking_volume = duckv
 160
 161 drop_database = dropdatabase
 162
 163 [strings]
 164 current_volume = Current volume: {volume}.
 165 current_ducking_volume = Volume on ducking: {volume}.
 166 change_volume = Volume set to {volume} by {user}.
 167 change_ducking_volume = Volume on ducking set to {volume} by {user}.
 168 bad_command = {command}: command not found.
 169 bad_parameter = {command}: invalid parameter.
 170 error_executing_command = {command}: Command failed with error: {error}.
 171 not_admin = You are not an admin!
 172 not_playing = Nothing is playing right now.
 173 no_file = File not found.
 174 wrong_pattern = Invalid regex: {error}.
 175 file_added  = Added: {item}.
 176 multiple_file_added  = Multiple files added:
 177 bad_url = Bad URL requested.
 178 preconfigurated_radio = Preconfigurated Radio available:
 179 unable_download = Error while downloading music...
 180 which_command = Do you mean <br /> {commands}
 181 multiple_matches = Track not found! Possible candidates:
 182 queue_contents = Items on the playlist:
 183 queue_empty = Playlist is empty!
 184 invalid_index = Invalid index <i>{index}</i>. Use '!queue' to see your playlist.
 185 now_playing = Playing <br />{item}
 186 radio = Radio
 187 file = File
 188 url_from_playlist = URL
 189 url = URL
 190 radio_item = <a href="{url}">{title}</a> <i>from</i> {name} <i>added by</i> {user}
 191 file_item = {artist} - {title} <i>added by</i> {user}
 192 url_from_playlist_item = <a href="{url}">{title}</a> <i>from playlist</i> <a href="{playlist_url}">{playlist}</a> <i>added by</i> {user}
 193 url_item = <a href="{url}">{title}</a> <i>added by</i> {user}
 194 not_in_my_channel = You're not in my channel, command refused!
 195 pm_not_allowed = Private message aren't allowed.
 196 too_long = {song} is too long, removed from playlist!
 197 download_in_progress = Download of {item} in progress...
 198 removing_item = Removed entry {item} from playlist.
 199 user_ban = You are banned, not allowed to do that!
 200 url_ban = This url is banned!
 201 rb_query_result = This is the result of your query, send !rbplay 'ID' to play a station:
 202 rb_play_empty = Please specify a radio station ID!
 203 paused = Music paused.
 204 stopped = Music stopped.
 205 cleared = Playlist emptied.
 206 database_dropped = Database dropped. All records have gone.
 207 new_version_found = <h3>Update Available!</h3> New version of botamusique is available, send <i>!update</i> to update!
 208 start_updating = Start updating...
 209 file_missed = Music file '{file}' missed! This item has been removed from the playlist.
 210 unknown_mode = Unknown playback mode '{mode}'. It should be one of <i>one-shot</i>, <i>loop</i>, <i>random</i>.
 211 current_mode = Current playback mode is <i>{mode}</i>.
 212 change_mode = Playback mode set to <i>{mode}</i> by {user}.
 213 repeat = Repeat {song} for {n} times.
 214 yt_result = Youtube query result: {result_table} Use <i>!ytplay</i> {{index}} to play the item you want. <br />
 215             <i>!ytquery -n</i> for the next page.
 216 yt_no_more = No more results!
 217 yt_query_error = Unable to query youtube!
 218 playlist_fetching_failed = Unable to fetch the playlist!
 219
 220 help = <h3>Commands</h3>
 221        <b>Control</b>
 222        <ul>
 223        <li> <b>!play </b> (or <b>!p</b>) [{num}] - resume from pausing / start to play (the num-th song is num is given) </li>
 224        <li> <b>!<u>pa</u>use </b> - pause </li>
 225        <li> <b>!<u>st</u>op </b> - stop playing </li>
 226        <li> <b>!<u>sk</u>ip </b> - jump to the next song </li>
 227        <li> <b>!<u>la</u>st </b> - jump to the last song </li>
 228        <li> <b>!<u>v</u>olume </b> {volume} - get or change the volume (from 0 to 100) </li>
 229        <li> <b>!<u>m</u>ode </b> [{mode}] - get or set the playback mode, {mode} should be one of <i>one-shot</i> (remove
 230        item once played), <i>repeat</i> (looping through the playlist), <i>random</i> (randomize the playlist),
 231        <i>autoplay</i> (randomly grab something from the music library).</li>
 232        <li> <b>!duck </b> on/off - enable or disable ducking function </li>
 233        <li> <b>!duckv </b> - set the volume of the bot when ducking is activated </li>
 234        <li> <b>!<u>duckt</u>hres </b> - set the threshold of volume to activate ducking (3000 by default) </li>
 235        <li> <b>!<u>o</u>ust </b> - stop playing and go to default channel </li>
 236        </ul>
 237        <b>Playlist</b>
 238        <ul>
 239        <li> <b>!<u>n</u>ow </b> (or <b>!np</b>) - display the current song </li>
 240        <li> <b>!<u>q</u>ueue </b> - display items in the playlist </li>
 241        <li> <b>!file </b>(or <b>!f</b>) {path/folder/index/keyword} - append file to the playlist by its path or index returned by !listfile </li>
 242        <li> <b>!<u>filem</u>atch </b>(or <b>!fm</b>) {pattern} - add all files that match regex {pattern} </li>
 243        <li> <b>!<u>ur</u>l </b> {url} - append youtube or soundcloud music to the playlist </li>
 244        <li> <b>!<u>playl</u>ist </b> {url} [{offset}] - append items in a youtube or soundcloud playlist, and start with the {offset}-th item </li>
 245        <li> <b>!rm </b> {num} - remove the num-th song on the playlist </li>
 246        <li> <b>!<u>rep</u>eat </b> [{num}] - repeat current song {num} (1 by default) times.</li>
 247        <li> <b>!<u>ran</u>dom </b> - randomize the playlist.</li>
 248        <li> <b>!<u>rad</u>io </b> {url} - append a radio {url} to the playlist </li>
 249        <li> <b>!<u>li</u>stfile </b> [{pattern}] - display list of available files (that match the regex pattern if {pattern} is given) </li>
 250        <li> <b>!<u>rbq</u>uery </b> {keyword} - query http://www.radio-browser.info for a radio station </li>
 251        <li> <b>!<u>rbp</u>lay </b> {id} - play a radio station with {id} (eg. !rbplay 96746) </li>
 252        <li> <b>!<u>ys</u>earch </b> {keyword} - query youtube. Use <i>!ytquery -n</i> to turn the page. </li>
 253        <li> <b>!<u>yp</u>lay </b> {index/keywords} - play an item from the list returned by <i>!ytquery</i>, or add the
 254        first search result of {keywords} into the playlist.</li>
 255        </ul>
 256        <b>Other</b>
 257        <ul>
 258        <li> <b>!<u>j</u>oinme {token} </b> - join your own channel with {token}.</li>
 259        </ul>
 260
 261 admin_help = <h3>Admin command</h3>
 262              <ul>
 263              <li><b>!<u>k</u>ill </b> - kill the bot</li>
 264              <li><b>!<u>up</u>date </b> - update the bot</li>
 265              <li><b>!<u>userb</u>an </b> {user}  - ban a user</li>
 266              <li><b>!<u>useru</u>nban </b> {user}  - unban a user</li>
 267              <li><b>!<u>urlb</u>an </b> {url}  - ban an url</li>
 268              <li><b>!<u>urlu</u>nban </b> {url}  - unban an url</li>
 269              <li><b>!dropdatabase</b> - clear the entire database, YOU SHOULD KNOW WHAT YOU ARE DOING.</li>
 270              </ul>
 271
 272