Updated Readme

pull/37/head v0.9.0
Trivernis 6 years ago
parent b1ef9459b6
commit 3609561b80

@ -12,6 +12,9 @@ The arguments are optional because the token and youtube-api-key that the bot ne
"prefix": "_",
"presence": "STRING", // this will be shown when no presences are set in data/presences.txt
"presence_duration": 300000, // how long does the bot have one presence
"maxCmdSequenceLength": 10, // the maximum number of commands a sequence is allowed to have
"rateLimitCount": 5, // the number of messages a user is allowed to send in rateLimitTime seconds
"rateLimitTime": 10, // the time in which a user is allowed to send rateLimitCount messages (in seconds)
"api": {
"botToken": "YOUR DISCORD BOT TOKEN",
"youTubeApiKey": "YOUR YOUTUBE API KEY"
@ -58,6 +61,8 @@ At the moment the bot can...
- [x] ...play music (YouTube videos and playlists)
- [x] ...save songs/playlists with a given name
- [x] ...log stuff in a database
- [x] ...execute multiple commands as a sequence
- [x] ...save command sequences with a given name
- [ ] ...transform into a cow
Presences
@ -65,6 +70,18 @@ Presences
You can add presences to the bot either by owner command `addpresence` or by providing a presences.txt file in the data directory. Each line represents a presence. <p style='color: f00'> When all lines are loaded by the bot, the file gets deleted.</p>
Command Sequences
---
A command sequence is a single message with several commands seperated by a semicolon.
In a sequence the command can be ommitted if it is the same as the previous one.
That means you can add several videos to the queue and shuffle it afterwards with the sequence
`~play [video1]; [video2]; [video3]; ~shuffle`.
A command sequence can be saved with `~savecmd [sequence] [commandname]`.
In this case the semicolon must be escaped with a backslash so it won't get interpreted as a seperate command.
A saved command can be executed with `~execute [commandname]`.
Ideas
---
- command replies saved in file (server specific file and global file)

Loading…
Cancel
Save