storm/bragi
1
0
Fork 0
Code Issues Pull Requests Actions Packages Projects Releases Wiki Activity

improve documentation in example configuration file (#386)

Browse Source 
Improve sentence structure, general grammar, consistency and
correct some incorrect setting names. Also wrap lines at roughly
82 columns for easier viewing.
This commit is contained in:
Jeremy Baxter 2024-05-14 04:14:58 +12:00 committed by GitHub
parent 97d47d7073
commit 0977b56385
No known key found for this signature in database
GPG Key ID: B5690EEEBB952194
1 changed files with 119 additions and 102 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

221
configuration.example.ini
View File

@ -1,13 +1,13 @@
# ======================================================== # ========================================================
# botamusique Example Configuration File # botamusique example configuration file
# Version 6 # Version 6
# ======================================================== # ========================================================
# Rename this file into configuration.ini after editing. # Rename this file to configuration.ini after editing.
# Uncomment lines you needed, and carefully follow the # Uncomment lines you'd like to change, and carefully
# instructions. # follow the instructions.
# ======================================================== # ========================================================
# [server] section tells the bot how to connect to your murmur server. # The [server] section tells the bot how to connect to your Murmur server.
# This section will be overridden by command line arguments. # This section will be overridden by command line arguments.
[server] [server]
host = 127.0.0.1 host = 127.0.0.1
@ -17,203 +17,220 @@ port = 64738
#tokens = token1,token2 #tokens = token1,token2
#certificate = #certificate =
# [bot] section stores some basic settings of the behavior of the bot. # The [bot] section stores some basic settings for the bot.
[bot] [bot]
# 'username' is the user name of the bot. # 'username': The bot's username.
# 'comment' is the comment displayed by the bot. # 'comment': Comment displayed on the bot's profile.
# 'avatar' is the path to the avatar image shown on the bot (PNG recommended, 128 KB max). # 'avatar': Path to an image used for the bot's avatar (PNG recommended, 128 KB max).
#username = botamusique #username = botamusique
#comment = "Hi, I'm here to play radio, local music or youtube/soundcloud music. Have fun!" #comment = "Hi, I'm here to play radio, local music or youtube/soundcloud music. Have fun!"
#avatar = #avatar =
# 'language': Available languages can be found inside lang/ folder. # 'language': Language to use; available languages can be found inside
# the lang/ folder.
#language=en_US #language=en_US
# 'music_folder': Folder that stores your local songs. # 'music_folder': Folder that stores your local songs.
#music_folder = music_folder/ #music_folder = music_folder/
# 'database_path': The path of the database. The database will store things like your volume # 'database_path': The path of the database, which stores things like your
# set by command !volume, your playback mode and your playlist, banned URLs, etc. # volume set by the !volume command, your playback mode and your playlist,
# banned URLs, etc.
# This option will be overridden by command line arguments. # This option will be overridden by command line arguments.
# 'music_database_path': The path of database that stores the music library. Can be disabled by # 'music_database_path': The path of the database that stores the music library.
# setting 'save_music_library=False' # Can be disabled by setting 'save_music_library = False'
#database_path=settings.db #database_path=settings.db
#music_database_path=music.db #music_database_path=music.db
# 'admin': Users allowed to kill the bot, or ban URLs. Separated by ';' # 'admin': List of users allowed to kill the bot, or ban URLs.
# Separated by ';'.
#admin = User1;User2; #admin = User1;User2;
# 'stereo': After 1.4.0, mumble starts to support stereo stream. Enable this option for stereo # 'stereo': Enable stereo stream transmission, supported since Mumble 1.4.0.
# stream transmission. Otherwise the bot will down mix stereo sound into mono. # If this is not enabled, the bot will downgrade stereo sound into mono.
#stereo = True #stereo = True
# 'volume' is default volume from 0 to 1. # 'volume': The default volume, a number from 0 to 1.
# This option will be overridden by value in the database. # This option will be overridden by the value set in the database.
#volume = 0.1 #volume = 0.1
# 'bandwidth' is the number of bits per second used by the bot when streaming audio. Enabling this # 'bandwidth': The number of bits per second used by the bot when streaming audio.
# option will allow you to set it higher than the default value. If the value exceeds the servers # Enabling this option will allow you to set it higher than the default value.
# bitrate, the bitrate used by the bot will match the servers. # If the given value exceeds the server's bitrate, the bitrate used by the bot
# will match the server's.
#bandwidth = 200000 #bandwidth = 200000
# 'playback_mode' defined the playback mode of the bot. # 'playback_mode': The playback mode of the bot. It should be one of the below:
# it should be one of "one-shot" (remove item once played), "repeat" (looping through the playlist), # one-shot: remove item once it has finished playing
# or "random" (randomize the playlist), "autoplay" (randomly grab something from the music library). # repeat: repeat the playlist
# This option will be overridden by value in the database. # random: randomize the order of the playlist
# 'autoplay_length': how many songs the autoplay mode fills the playlist # autoplay: randomly pick a track from the music library
# 'clear_when_stop_in_oneshot': clear the playlist when stopping the bot in one-shot mode. # This option will be overridden by the value set in the database.
# 'autoplay_length': How many songs to fill the playlist with in autoplay mode.
# 'clear_when_stop_in_oneshot': Whether to clear the playlist when stopping the
# bot in one-shot mode.
#playback_mode = one-shot #playback_mode = one-shot
#autoplay_length = 5 #autoplay_length = 5
#clear_when_stop_in_oneshot = False #clear_when_stop_in_oneshot = False
# target version, stable or testing (testing needs to be installed with git) # 'target_version': version to fetch when updating:
# stable will use simple bash with curl command to get releases, testing will follow github master branch with git commands # stable: use the curl command to get stable releases
# testing: follow git master branch using the git command
#target_version = stable #target_version = stable
# 'tmp_folder': Folder that stores the downloaded music. # 'tmp_folder': Folder that music will be downloaded into.
# 'tmp_folder_max_size': in MB, 0 for no cache, -1 for unlimited size # 'tmp_folder_max_size': Maximum size of tmp_folder in MB, or 0 to not cache
# 'ignored_folders', 'ignored_files': files and folders that would be ignored during scanning. # at all, or -1 for unlimited size
# 'ignored_files', 'ignored_folders': Files and folders to ignore during scanning.
#tmp_folder = /tmp/ #tmp_folder = /tmp/
#tmp_folder_max_size = 10 #tmp_folder_max_size = 10
#ignored_folders = tmp #ignored_folders = tmp
#ignored_files = Thumbs.db #ignored_files = Thumbs.db
# 'download_attempts': how many times the bot will try to download an item # 'download_attempts': How many times to attempt a download.
#download_attempts = 2 #download_attempts = 2
# 'auto_check_update': check for updates every time the bot starts, post the changelog after an update was applied # 'auto_check_update': Whether to check for updates every time the bot starts,
# and post the changelog after an update was applied.
#auto_check_update = True #auto_check_update = True
#pip3_path = venv/bin/pip #pip3_path = venv/bin/pip
# 'logfile': write logs into this file. # 'logfile': File to write log messages to.
# 'redirect_strerr': capture outputs from stderr and write into the `logfile`, # 'redirect_stderr': Whether to capture outputs from standard error and write
# useful for capture the exception message when the bot crash. # it into the log file. Useful for capturing an exception message when the
# bot crashes.
#logfile = #logfile =
#redirect_strerr = False #redirect_stderr = False
#announce_current_music = True #announce_current_music = True
#allow_other_channel_message = False #allow_other_channel_message = False
#allow_private_message = True #allow_private_message = True
# 'delete_allowed': Allow users to delete a file from the library (hard disk). # 'delete_allowed': Whether to allow admins to delete a file from the library
# Works both for command and web interface. After enabling this option, only # stored on disk. Works for both command and web interfaces.
# admins are allowed to delete files.
#delete_allowed = True #delete_allowed = True
# 'save_music_library': If this is set True, the bot will save the metadata of music into the database. # 'save_music_library': Whether to save music metadata to the database.
#save_music_library = True #save_music_library = True
# 'refresh_cache_on_startup': If this is set true, the bot will refresh its music directory cache when starting up. # 'refresh_cache_on_startup': Whether to refresh the music directory's cache when
# But it won't reload metadata from each files. If set to False, it will used the cache last time. # starting up. Metadata from each file will not be refreshed. If this is False,
# the cache from last time will be used.
#refresh_cache_on_startup = True #refresh_cache_on_startup = True
# 'save_playlist': If save_playlist is set True, the bot will save current playlist before quitting # 'save_playlist': Whether to save the current playlist before quitting, so that
# and reload it the next time it start. It requires save_music_library to be True to function. # it may be reloaded next time. To use this, save_music_library must be True.
#save_playlist = True #save_playlist = True
# 'max_volume': Maximum volume able to be set by users. 0.0 - 1.0 # 'max_volume': Maximum volume users are allowed to set.
# Number between 0.0 - 1.0.
#max_volume = 0.8 #max_volume = 0.8
# 'max_track_playlist': Maximum track played when a playlist is added. # 'max_track_playlist': The maximum amount of tracks allowed in a playlist.
#max_track_playlist = 20 #max_track_playlist = 20
# 'max_track_duration': Maximum music duration (minutes) # 'max_track_duration': Maximum track duration in minutes.
#max_track_duration = 60 #max_track_duration = 60
# 'ducking': If ducking is enabled, the bot will automatically attenuate its # 'ducking': Whether to lower music volume when someone is talking.
# volume when someone is talking.
#ducking = False #ducking = False
#ducking_volume = 0.05 #ducking_volume = 0.05
#ducking_threshold = 3000 #ducking_threshold = 3000
# 'when_nobody_in_channel': Specify what the bot should do if nobody is in the channel. # 'when_nobody_in_channel': Behaviour of the bot when nobody is in the channel.
# Possible value of this options are: # Has to be one of:
# - "pause", # pause: pause the current track
# - "pause_resume" (pause and resume once somebody re-enters the channel) # pause_resume: pause the current track and resume it once someone joins
# - "stop" (also clears playlist) # stop: stop the bot, clearing its playlist
# - leave empty (do nothing) # Or you can leave it empty to take no action.
#when_nobody_in_channel = #when_nobody_in_channel =
# 'when_nobody_in_channel_ignore': Specify the list of users that should be ignored, from the list of active users. # 'when_nobody_in_channel_ignore': List of users that should be ignored.
# This is typically used when other bots are present in the channel. # This is typically used when other bots are present in the channel.
#when_nobody_in_channel_ignore = #when_nobody_in_channel_ignore =
# 'youtube_query_cookie': Sometimes youtube will block the request of our bot and # 'youtube_query_cookie': Sometimes YouTube will block the bot's request and ask
# request the bot to complete a captcha to verify the request is not made by a # the bot to complete a captcha to verify the request is made by a human. This
# bot. # can be solved if the bot has a valid cookie. If the bot complains "unable to
# This problem can be resolved if the bot bears a valid cookie. # query youtube", you should provide a value here.
# If the bot complains "unable to query youtube", you may try to add your cookie here.
#youtube_query_cookie = {"CONSENT": "paste your CONSENT cookie value here"} #youtube_query_cookie = {"CONSENT": "paste your CONSENT cookie value here"}
# [webinterface] stores settings related to the web interface. # The [webinterface] section stores settings related to the web interface.
[webinterface] [webinterface]
# 'enable': Set 'enabled' to True if you'd like to use the web interface to manage # 'enabled': Whether to enable the web interface to allow managing your playlist,
# your playlist, upload files, etc. # uploading tracks, etc.
# The web interface is disabled by default for security and performance reasons. # The web interface is disabled by default for security and performance reasons.
# 'access_address': Used when users are requesting the address to access the web interface. # 'access_address': URL provided to users when the public URL for the
# web interface is requested.
#enabled = False #enabled = False
#listening_addr = 127.0.0.1 #listening_addr = 127.0.0.1
#listening_port = 8181 #listening_port = 8181
#is_web_proxified = True #is_web_proxified = True
# This is the public URL
#access_address = http://127.0.0.1:8181 #access_address = http://127.0.0.1:8181
# 'web_logfile': write access logs of the web server into this file. # 'web_logfile': If this is provided, web server access logs are written to this file.
#web_logfile = #web_logfile =
# 'auth_method': Method used to authenticate users accessing the web interface. # 'auth_method': Method used to authenticate users accessing the web interface.
# Options are 'none', 'password' or 'token' (use unique token, see # One of 'none', 'password' or 'token'. If this is set to 'token', a unique token
# requests_webinterface_access command) # is used for authentication.
# 'max_attempts': Bad access attempts before being banned. Regenerating a token or # 'max_attempts': Amount of incorrect login attempts needed before being banned.
# rebooting the bot will reset this attempts tally. # Regenerating a token or rebooting the bot will reset this number.
#auth_method = token #auth_method = token
#max_attempts = 10 #max_attempts = 10
# 'user', 'password': If auth_method set to 'password', you need to set the default # 'user', 'password': If auth_method is set to 'password', you'll need to set
# username and password. You can add more users by '!webadduser' # the default username and password, which is set by these two options.
# You can add more users using the '!webadduser' command.
#user = botamusique #user = botamusique
#password = mumble #password = mumble
# 'flask_secret': To use a token, flask needs a password to encrypt/sign cookies. # 'flask_secret': To use a token, Flask needs a password to encrypt/sign cookies.
# !! YOU NEED TO CHANGE IT IF auth_method IS 'token'!! # This is absolutely necessary if auth_method is 'token'!
# flask_secret = ChangeThisPassword #flask_secret = ChangeThisPassword
# 'upload_enabled': Enable the upload function of the web interface. If disabled, # 'upload_enabled': Whether to enable the upload function of the web interface.
# only admins can upload files. # If this is False, only admins can upload files.
# 'maximum_upload_file_size': Unit can be 'B', 'KB', 'MB', 'GB', 'TB'. # 'maximum_upload_file_size': Maximum file size allowed for uploads.
# Can be specified in B, KB, MB, GB, or TB.
#upload_enabled = True #upload_enabled = True
#max_upload_file_size = 30MB #max_upload_file_size = 30MB
# [debug] stores some debug settings. # The [debug] section contains settings to enable debugging messaages.
[debug] [debug]
# Set ffmpeg to True if you want to display DEBUG level log of ffmpeg. # 'ffmpeg': Whether to display debug messages from ffmpeg.
#ffmpeg = False # 'mumble_connection': Whether to display debug messages for the
# Set to True if you need to debug mumble connection (pymumble lib) # connection to the Mumble server (from the pymumble library).
#mumble_connection = False # 'youtube_dl': Whether to display debug messages from youtube-dl.
# Set to True if you need debug log from youtube-dl #ffmpeg = False
#youtube_dl = False #mumble_connection = False
#youtube_dl = False
# [radio] is a list of default radio stations. # The [radio] section contains a list of default radio stations.
[radio] [radio]
# List of radio stations you want to have by default, one entry per line. # List of radio stations you want to have by default, one entry per line.
#jazz = http://jazz-wr04.ice.infomaniak.ch/jazz-wr04-128.mp3 "Jazz Yeah !" #jazz = http://jazz-wr04.ice.infomaniak.ch/jazz-wr04-128.mp3 "Jazz Yeah !"
# [youtube_dl] are options to customize youtube-dl (optional) # The optional [youtube_dl] section contains options to customize youtube-dl
[youtube_dl] [youtube_dl]
# source_address , use '::' to force ipv6, "0.0.0.0" to force ipv4, or put the ip addresse you want to use. # 'source_address': Set to '::' to force ipv6, "0.0.0.0" to force ipv4,
# or else put the IP address you want to use here.
# 'cookie_file': Path of the cookie file to use, useful if you are being rate limited:
# <https://github.com/ytdl-org/youtube-dl#http-error-429-too-many-requests-or-402-payment-required>
# 'user_agent': Set the User-Agent header when making requests to youtube.com.
# source_address = '::' # source_address = '::'
# cookie_file , path of the cookie file (usefull if you reach youtube limits https://github.com/ytdl-org/youtube-dl#http-error-429-too-many-requests-or-402-payment-required) # cookie_file = /tmp/youtube-dl-cookie
# cookie_file = '/tmp/cooke_ydl'
# user-agent allow the user to force the user-agent of youtube-dl
# user-agent = "Mozilla/5.0 (Windows NT 10.0; Win64; x64; rv:87.0) Gecko/20100101 Firefox/87.0" # user-agent = "Mozilla/5.0 (Windows NT 10.0; Win64; x64; rv:87.0) Gecko/20100101 Firefox/87.0"
# [commands] are settings related to user command sent via mumble message. # The [commands] section contains settings related to user commands sent via
# Mumble text messages.
[commands] [commands]
# 'command_symbol' is a list of characters the bot recognizes as command prefix. # 'command_symbol': List of characters recognized as a command prefix.
#command_symbol = !:！ # 'split_username_at_space': Whether usernames should be split by a space,
# 'split_username_at_space': This option split username, in case you use such kind of mumo plugins https://wiki.mumble.info/wiki/Mumo#Set_Status # in case you use these kinds of Mumo plugins:
# <https://wiki.mumble.info/wiki/Mumo#Set_Status>
#split_username_at_space = False #split_username_at_space = False
#command_symbol = !:！
# You may also customize commands recognized by the bot. For a full list of commands, # You may also customize commands recognized by the bot. For a full list of commands,
# see configuration.default.ini. Copy options you want to edit into this file. # see configuration.default.ini. Copy options you want to edit into this file.