forked from zRitsu/MuseHeart-MusicBot
-
Notifications
You must be signed in to change notification settings - Fork 9
/
Copy path.example.env
308 lines (232 loc) · 13.9 KB
/
.example.env
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
258
259
260
261
262
263
264
265
266
267
268
269
270
271
272
273
274
275
276
277
278
279
280
281
282
283
284
285
286
287
288
289
290
291
292
293
294
295
296
297
298
299
300
301
302
303
304
305
306
307
308
############################################################################
### Attention, to use this file, you must rename it to .env ###
### If you use a space in any value, always enclose the value in quotes! ###
############################################################################
######################################################################################################
### Bot Token (Required) ###
### Note: You can include extra bots by adding more tokens in the value (separated by space) ###
### or by creating a config with any name (using only letters/numbers/underscore) and in the value ###
### put the token(s) (separated by spaces if you include more than 1 in the value). ###
### ###
### Examples: ###
### TOKEN='bbbbbbbbbcccDASDSAdeefff.gggghhhhiiii' ###
### MYBOT='asdsadbbc2cDASDSAdeef3ff.adew234411ax' ###
### ###
### Examples with multiple tokens in the value (separated by space): ###
### TOKEN='aaabbbbbccccddddeeeefff.gggghhhhiiii aaabbbbb324234dddeeeefff.gggghhhhiiii' ###
### MYBOT='bbbbbbbbbcccDASDSAdeefff.gggghhhhiiii 213bbabscccddeeeefff.gggghhhhiiii' ###
### COOLBOT='bbbbbbbbbcccDASDSAdeefff.gggghhhhiiii 213bbabscccddeeeefff.gggghhhhiiii' ###
######################################################################################################
# bot token(s) below (separate with space if adding more than 1 token)
TOKEN=''
# Bot's default prefix
DEFAULT_PREFIX='!!'
# Automatically download a list of public Lavalink servers.
# If hosted on squarecloud/discloud/repl.it/render on free plans (or any other hosting with limited CPU/RAM/traffic)
# I recommend leaving this setting as true.
AUTO_DOWNLOAD_LAVALINK_SERVERLIST=false
# URL of the MongoDB for the database (if not provided, it will use a database in a .json file). See how to get it: https://github.com/zRitsu/MuseHeart-MusicBot/wiki/MongoDB-Tutorial"
MONGO=''
# Save active player session data in MongoDB (MONGO field must be configured).
PLAYER_SESSIONS_MONGODB=false
# Warn about sensitive data that may be stored on hosts with public source.
SENSITIVE_INFO_WARN=true
##############################################
### Music system - Support for Spotify ###
##############################################
# Use your own key instead of an automatically obtained visitor key.
# If you have any doubts on how to obtain the data for the fields below, please refer to the tutorial: https://github.com/zRitsu/MuseHeart-MusicBot/wiki/Spotify-Keys
SPOTIFY_CLIENT_ID=''
SPOTIFY_CLIENT_SECRET=''
###############
### Intents ###
###############
BANS_INTENT='false'
DM_MESSAGES_INTENT='false'
DM_REACTIONS_INTENT='false'
DM_TYPING_INTENT='false'
GUILD_MESSAGES_INTENT='true'
GUILD_REACTIONS_INTENT='false'
GUILD_SCHEDULED_EVENTS_INTENT='false'
GUILD_TYPING_INTENT='false'
EMOJIS_AND_STICKERS_INTENT='true'
INTEGRATIONS_INTENT='true'
INVITES_INTENT='true'
VOICE_STATES_INTENT='true'
WEBHOOKS_INTENT='false'
##########################
### Privileged Intents ###
##########################
PRESENCES_INTENT='false'
MESSAGE_CONTENT_INTENT='true'
############################
### Other Optional Items ###
############################
# User ID for the list of bot owner(s), if using more than 1 ID, separate with || (Any ID placed in the list will allow the member full access to the bot, be careful!).
OWNER_IDS=''
# Force bot to exit on error 429 (too many requests)
KILL_ON_429=true
# Enable cooldown on commands (I recommend that leaves false / disabled only if the bot is used on friends or small servers)
# because the uncontrollable use of commands in very short interval of seconds in commands like skip can cause
# your lavalink servers take faster ratelimit of music platforms etc
ENABLE_COMMANDS_COOLDOWN=true
# Enable/Disable command logging.
COMMAND_LOG=false
# Support server invite (displayed in the about command and command errors).
SUPPORT_SERVER=''
# Automatically synchronize commands when bot is started.
AUTO_SYNC_COMMANDS=true
# Webhook link for sending logs when the bot is added/removed from a server.
BOT_ADD_REMOVE_LOG=''
# Webhook link for sending error reports (will be ignored if AUTO_ERROR_REPORT_WEBHOOK is used).
ERROR_REPORT_WEBHOOK=''
# Webhook link for automatic error reports
# Warning: it is highly recommended that the channel receiving these logs be private for the bot devs
# as it may contain confidential information like env/secret keys, etc.
AUTO_ERROR_REPORT_WEBHOOK=''
# Embed color of the player (if not set, it will use the color of the bot's role).
EMBED_COLOR=none
# Github link to be used in commands like update.
SOURCE_REPO='https://github.com/SeasonPhan/MuseHeart-MusicBot-EN.git'
# Do not allow the use of prefixed text commands.
INTERACTION_COMMAND_ONLY=false
# Time in seconds to change the bot's presence.
PRESENCE_INTERVAL=900
# Additional bot IDs to add their invites in the invite command (if using more than 1, separate with space)
ADDITIONAL_BOT_IDS=""
# Permissions ID to include in the bot's invite
INVITE_PERMISSIONS=332892794064
# Enable/Disable bot log/debugging.
ENABLE_LOGGER=false
# Default directory to be used in git
GIT_DIR="./.git"
####################
### Music System ###
####################
# Warn when the bot's audio is not disabled on the server.
GUILD_DEAFEN_WARN=true
# Link to download the list of Lavalink servers (lavalink.ini)
LAVALINK_SERVER_LIST='https://gist.githubusercontent.com/zRitsu/c3511e1da0440b94c126769dd40c9d91/raw/lavalink.ini'
# Number of attempts to reconnect to a Lavalink server
LAVALINK_RECONNECT_RETRIES=30
# Enable or disable the use of YTDL for some features such as support for integrating YouTube channels/profiles and SoundCloud
# Note: This feature requires a minimum of 200mb of RAM (its usage is only temporary until a better solution that does not use ytdl is found).
USE_YTDL=true
# Force the use of the internal Deezer client (in this case, requests for Deezer links will be ignored on the Lavalink server if it has support).
FORCE_USE_DEEZER_CLIENT=false
# Favorite limit per member (0 or less = no limits)
MAX_USER_FAVS=10
# Character limit in playlist names.
USER_FAV_MAX_NAME_LENGTH=35
# Character limit in playlist links.
USER_FAV_MAX_URL_LENGTH=90
# Time in seconds for the bot to wait for new songs in idle mode.
IDLE_TIMEOUT=180
# Time in seconds for the bot to wait for members to join the voice channel when it's empty.
WAIT_FOR_MEMBERS_TIMEOUT=180
# Default player skin in normal mode (you can copy the default skin and give it another name and edit the file to your liking, it will not be affected by my changes in updates of the original skins).
DEFAULT_SKIN='default'
# Default player skin in song-request mode (you can copy the default skin and give it another name and edit the file to your liking, it will not be affected by my changes in updates of the original skins).
DEFAULT_STATIC_SKIN='default'
# Ignore skins from the list in normal mode (filename without .py and if more than 1, separate with space)
IGNORE_SKINS=''
# Ignore skins from the list in song-request mode (filename without .py and if more than 1, separate with space)
IGNORE_STATIC_SKINS=''
# Include additional hints in the player (do not use line breaks and if including more than one, separate with ||)
EXTRA_HINTS=""
# Rate of displaying hints in the player (the higher the value, the lower the chance).
HINT_RATE=4
# Number of votes required for the voteskip command.
VOTE_SKIP_AMOUNT=3
# The waiting time for data cleaning of the event pool_payload_ready.
PREFIXED_POOL_TIMEOUT=4
# Enable support for discord links (and attachments) in music add commands.
ENABLE_DISCORD_URLS_PLAYBACK=true
# Interval (in seconds) to save player information in the database (minimum: 30).
PLAYER_INFO_BACKUP_INTERVAL=45
# Wait time (in seconds) to wait for a response from MongoDB.
MONGO_TIMEOUT=30
# Interval (in seconds) to save player information in the MongoDB database (minimum: 120).
PLAYER_INFO_BACKUP_INTERVAL_MONGO=300
# Maximum number of songs allowed in the queue (0 = unlimited)
QUEUE_MAX_ENTRIES=0
# Enable typing when using defer in some prefixed commands.
ENABLE_DEFER_TYPING=true
# Minimum ping for the bot to reconnect to the voice channel (in case of instability)
VOICE_CHANNEL_LATENCY_RECONNECT=200
################################################
### Music system - RPC (Rich Presence): ###
################################################
# Enable/Disable internal RPC/WEB Page server.
RUN_RPC_SERVER=false
# Enable/Disable the command to generate a token and display the link to use in the rich presence app (true or false)
ENABLE_RPC_COMMAND=false
# RPC server link (for member status), if not available, it will be used locally.
RPC_SERVER='ws://localhost:$PORT/ws'
# Link to be displayed in the /rich_presence command.
# Note: if not provided, the link of the RPC_SERVER will be displayed (if you consider the URL provided in RPC_SERVER to be accessible to members, you can leave the field below empty).
RPC_PUBLIC_URL=''
# Enable/Disable token authentication to access RPC (false or true)
ENABLE_RPC_AUTH=false
#############################################
### Music System - Local Lavalink stuffs: ###
#############################################
# Force initialization of the local Lavalink server (Note: Starting the Lavalink server on the same instance as the bot
# requires a VPS/host with a minimum of 512MB of RAM, if not enabled, ignore all items related to Lavalink below.
RUN_LOCAL_LAVALINK=false
# Connect to local Lavalink
CONNECT_LOCAL_LAVALINK=true
# default search providers (separate with space for multiple items preserving the original quotes).
# Note: If you want to disable YouTube support, you can remove ytsearch or ytmsearch from the list below (separating with space).
SEARCH_PROVIDERS="amsearch tdsearch spsearch scsearch ytsearch"
# Additional time to wait for the Lavalink server to start (currently not very necessary and may be removed soon).
LAVALINK_ADDITIONAL_SLEEP=0
# Initial RAM amount to be used in the Lavalink server process.
LAVALINK_INITIAL_RAM=30
# RAM limit to be used in the Lavalink server process.
LAVALINK_RAM_LIMIT=120
# Number of CPU cores to be used in the Lavalink server.
LAVALINK_CPU_CORES=1
# Link to download the Lavalink.jar file.
LAVALINK_FILE_URL='https://github.com/zRitsu/LL-binaries/releases/download/0.0.1/Lavalink.jar'
# Using Jabba to install Java on systems other than Windows.
# This can be used as an alternative when you can't use Jabba due to issues, etc.
USE_JABBA=false
##################################################
### Music system - Integration with Last.fm ###
##################################################
# You can obtain this data by accessing the link: https://www.last.fm/api
LASTFM_KEY=''
LASTFM_SECRET=''
####################################################################################################################
##### Bot Presences: #####
##### Status to display in the bot, if you want more than 1 for a specific type, separate with || #####
##### #####
##### Placeholders: #####
##### {users} -> number of users. #####
##### {guilds} -> number of servers. #####
##### {playing} -> number of active players. #####
##### {uptime} -> bot uptime. #####
##### {owner} -> bot owner's nickname/name (or team). #####
##### #####
##### About the placeholders below, the entire text that has them will be ignored if the count is zero. #####
##### #####
##### {players_count} -> number of active players. #####
##### {players_count_allbotchannels} -> number of active players summing all channels in all bots. #####
##### {players_count_allbotservers} -> number of active players summing all servers in all bots without #####
##### duplicating the count if more than 1 bot is in the same server). #####
##### #####
##### Ex: I've been online for {uptime} || playing music on {playing} servers #####
####################################################################################################################
LISTENING_PRESENCES=''
WATCHING_PRESENCES=''
PLAYING_PRESENCES=''
CUSTOM_STATUS_PRESENCES=''
# Note: for the streaming format, you must provide the name and URL (twitch or yt) separated by ||
# Eg: Demonstrating my commands || https://www.youtube.com/watch?v=OsJYB2W199k
# For more than one streaming option, you can separate each group using |||
# Eg: Demonstrating my commands || https://www.youtube.com/watch?v=OsJYB2W199k ||| Twin Saga runs || https://www.youtube.com/watch?v=sU-fmPFHzKA
STREAMING_PRESENCES=''
#####################
###### Extras #######
#####################