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