1
0
mirror of https://github.com/azlux/botamusique synced 2024-11-23 13:56:17 +00:00

Compare commits

...

6 Commits

Author SHA1 Message Date
e313d4ef0d
Fix an option, cleanup typos & wording.
Merge pull request #361 from Irets/typo_cleanup
2023-05-10 14:47:44 +02:00
irets
fa7ca16aa6 Edit to keep form with rest of the file 2023-05-09 19:59:25 +03:00
Irets
34b1df4150
Update README.md 2023-05-09 14:15:12 +00:00
irets
f437bd25bf Fix option name in README & improve wording. 2023-05-09 16:54:01 +03:00
Irets
0533a68b48
Update configuration.example.ini 2023-05-09 13:15:57 +00:00
irets@navi
b21b54ac9f Fix an option, cleanup typos & wording. 2023-05-09 13:23:36 +03:00
3 changed files with 18 additions and 16 deletions

View File

@ -50,7 +50,7 @@ Predicted functionalities will be those people would expect from any classic mus
### Docker ### Docker
See https://github.com/azlux/botamusique/wiki/Docker-install See https://github.com/azlux/botamusique/wiki/Docker-install
Both stable and nightly (developing) build are available! Both stable and nightly (developing) builds are available!
### Manual install ### Manual install
@ -120,7 +120,7 @@ host = 127.0.0.1
port = 64738 port = 64738
``` ```
2. You need to specify a folder that stores your music files. The bot will look for music and upload files into that folder. You also need to specify a temporary folder to store music files download from URLs. 2. You need to specify a folder that stores your music files. The bot will look for music and upload files into that folder. You also need to specify a temporary folder to store music file downloads from URLs.
``` ```
[bot] [bot]
music_folder = music_folder/ music_folder = music_folder/
@ -200,7 +200,7 @@ The web interface can be used if you'd like an intuitive way of interacting with
## Update ## Update
If you enable `audo_check_update`, the bot will check for updates every time it starts. If you enable `auto_check_update`, the bot will check for updates every time it starts.
If you are using the recommended install, you can send `!update` to the bot (command by default). If you are using the recommended install, you can send `!update` to the bot (command by default).
If you are using git, you need to update manually: If you are using git, you need to update manually:

View File

@ -4,7 +4,7 @@
# ======================================================== # ========================================================
# WARNING: # WARNING:
# ****************************** # ******************************
# **DO NOT MODIFIED THIS FILE.** # ** DO NOT MODIFY THIS FILE. **
# ****************************** # ******************************
# #
# Please create your own configuration file, and # Please create your own configuration file, and

View File

@ -61,7 +61,7 @@ port = 64738
# or "random" (randomize the playlist), "autoplay" (randomly grab something from the music library). # or "random" (randomize the playlist), "autoplay" (randomly grab something from the music library).
# This option will be overridden by value in the database. # This option will be overridden by value in the database.
# 'autoplay_length': how many songs the autoplay mode fills the playlist # 'autoplay_length': how many songs the autoplay mode fills the playlist
# 'clear_when_stop_in_oneshot': clear the playlist when stop the bot in one-shot mode. # 'clear_when_stop_in_oneshot': 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
@ -98,7 +98,7 @@ port = 64738
# 'delete_allowed': Allow users to delete a file from the library (hard disk). # 'delete_allowed': Allow users to delete a file from the library (hard disk).
# Works both for command and web interface. After enabling this option, only # Works both for command and web interface. After enabling this option, only
# admins are allowed to delete files. # admins are allowed to delete files.
#delete_allowded = 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': If this is set True, the bot will save the metadata of music into the database.
#save_music_library = True #save_music_library = True
@ -145,8 +145,8 @@ port = 64738
[webinterface] [webinterface]
# 'enable': Set 'enabled' to True if you'd like to use the web interface to manage # 'enable': Set 'enabled' to True if you'd like to use the web interface to manage
# your playlist, upload files, etc. # your playlist, upload files, etc.
# The web interface is disable by default for security and performance reason. # The web interface is disabled by default for security and performance reasons.
# 'access_address': Used when user are questing the address to access the web interface. # 'access_address': Used when users are requesting the address to access the web interface.
#enabled = False #enabled = False
#listening_addr = 127.0.0.1 #listening_addr = 127.0.0.1
#listening_port = 8181 #listening_port = 8181
@ -170,7 +170,7 @@ port = 64738
#user = botamusique #user = botamusique
#password = mumble #password = mumble
# 'flask_secret': To use token, flask need 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'!! # !! YOU NEED TO CHANGE IT IF auth_method IS 'token'!!
# flask_secret = ChangeThisPassword # flask_secret = ChangeThisPassword
@ -182,17 +182,19 @@ port = 64738
# [debug] stores some debug settings. # [debug] stores some debug settings.
[debug] [debug]
#ffmpeg = False # Set ffmpeg to True if you want to display DEBUG level log of ffmpeg. # Set ffmpeg to True if you want to display DEBUG level log of ffmpeg.
#mumble_connection = False # Set to True if you need to debug mumble connection (pymumble lib) #ffmpeg = False
#youtube_dl = False # Set to True if you need debug log from youtube-dl # Set to True if you need to debug mumble connection (pymumble lib)
#mumble_connection = False
# Set to True if you need debug log from youtube-dl
#youtube_dl = False
# [radio] is a list of default radio stations. # [radio] is a list of default radio stations.
[radio] [radio]
# List of radio you want to have by default # List of radio stations you want to have by default, one entry per line.
# one line by entrie
#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 option to custom youtube-dl (optionnal) # [youtube_dl] are options to customize youtube-dl (optional)
[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 , use '::' to force ipv6, "0.0.0.0" to force ipv4, or put the ip addresse you want to use.
# source_address = '::' # source_address = '::'
@ -201,7 +203,7 @@ port = 64738
# user-agent allow the user to force the user-agent of youtube-dl # 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] is settings related to user command sent via mumble message. # [commands] are settings related to user command sent via mumble message.
[commands] [commands]
# 'command_symbol' is a list of characters the bot recognizes as command prefix. # 'command_symbol' is a list of characters the bot recognizes as command prefix.
#command_symbol = !: #command_symbol = !: