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

Fix an option, cleanup typos & wording.

Browse Source 
Merge pull request #361 from Irets/typo_cleanup
This commit is contained in:
azlux
2023-05-10 14:47:44 +02:00
committed by GitHub
parent bf321cfda4 fa7ca16aa6
commit e313d4ef0d
3 changed files with 18 additions and 16 deletions
Download Patch File Download Diff File Expand all files Collapse all files

6
README.md
View File

@@ -50,7 +50,7 @@ Predicted functionalities will be those people would expect from any classic mus
### Docker
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
@@ -120,7 +120,7 @@ host = 127.0.0.1
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]
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
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 git, you need to update manually:

2
configuration.default.ini
View File

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

26
configuration.example.ini
View File

@@ -61,7 +61,7 @@ port = 64738
# or "random" (randomize the playlist), "autoplay" (randomly grab something from the music library).
# This option will be overridden by value in the database.
# '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
#autoplay_length = 5
#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).
# Works both for command and web interface. After enabling this option, only
# 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 = True
@@ -145,8 +145,8 @@ port = 64738
[webinterface]
# 'enable': Set 'enabled' to True if you'd like to use the web interface to manage
# your playlist, upload files, etc.
# The web interface is disable by default for security and performance reason.
# 'access_address': Used when user are questing the address to access the web interface.
# 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.
#enabled = False
#listening_addr = 127.0.0.1
#listening_port = 8181
@@ -170,7 +170,7 @@ port = 64738
#user = botamusique
#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'!!
# flask_secret = ChangeThisPassword
@@ -182,17 +182,19 @@ port = 64738
# [debug] stores some debug settings.
[debug]
#ffmpeg = False # 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)
#youtube_dl = False # Set to True if you need debug log from youtube-dl
# Set ffmpeg to True if you want to display DEBUG level log of ffmpeg.
#ffmpeg = False
# 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]
# List of radio you want to have by default
# one line by entrie
# 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 !"
# [youtube_dl] are option to custom youtube-dl (optionnal)
# [youtube_dl] are options to customize youtube-dl (optional)
[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 = '::'
@@ -201,7 +203,7 @@ port = 64738
# 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"
# [commands] is settings related to user command sent via mumble message.
# [commands] are settings related to user command sent via mumble message.
[commands]
# 'command_symbol' is a list of characters the bot recognizes as command prefix.
#command_symbol = !:！