henrymxu / evebot Goto Github PK

• Add option to shuffle queue
• Add this option to queueing playlists / albums as well

• Errors on command execution should be thrown with an acknowledgement type or string
• This error should be handled by the dispatcher
• Execution function should return a Promise, that contains an appropriate acknowledgement type or string

• Missing detailed installation guide
• Troubleshooting
• Improve keys setup

• Curious to see how long command execution takes (from message to response)
• Should be straight forward to implement using dispatcher and command execution
• Would be nice to store these execution times in order to find improvements

Is your feature request related to a problem? Please describe.
Want to skip multiple songs at once

Describe the solution you'd like
Allow skip command to skip multiple songs at once

Describe context of feature
Command improvement

Is your feature request related to a problem? Please describe.
Some people may not wish to have the bot always be listening to them

Describe the solution you'd like
Provide a way to opt out of the bot listening to them

Describe context of feature
Configuration command (i.e add user ids to array)

Additional context
Users would not be able to access voice commands

Is your feature request related to a problem? Please describe.
No way for bot to ask user to do something (i.e if radio is done, allow user to react to a message and bot will retrieve some more songs)

Describe the solution you'd like
Allow commands to request users to acknowledge a response in order to complete a commnad

Describe context of feature
Bot responds with a message, user reacts to it, bot then performs an action based on reaction

Additional context

Is your feature request related to a problem? Please describe.
After playing a song with the play command with nothing in queue, the discord channel the bot was playing is filled with awkward silence

Describe the solution you'd like
I would like to have the option to start a spotify radio after my requested song is played to fill in this void.

Describe context of feature
Add an option to start a spotify radio in the play command
ex. -play blackpink lovesick girls -radio

Additional context
u mam

• Use eslint and prettier to format the project

Is your feature request related to a problem? Please describe.
Users are sometimes cut off when saying a voice command, this is due to the voice command prompt only allowing a fixed length.

Describe the solution you'd like
Allow dynamic voice command length (potentially up to a maximum to prevent extremely long speech to text streams).

Describe context of feature
Changes to the ConnectionHandler to implement this.

Describe the bug
DiscordJS attempts to decode corrupted packet (from user joining from browser). This error is not handled to the bot crashes

To Reproduce
Have user join on browser and say something, bot will then crash with error:

/evebot/node_modules/prism-media/src/opus/Opus.js:64
    return this.encoder.decode(buffer, Opus.name === 'opusscript' ? null : this._options.frameSize);
                        ^
TypeError: The compressed data passed is corrupted
    at Decoder._decode (evebot/node_modules/prism-media/src/opus/Opus.js:64:25)
    at Decoder._transform (evebot/node_modules/prism-media/src/opus/Opus.js:189:20)
    at Decoder.Transform._read (_stream_transform.js:191:10)
    at Decoder.Transform._write (_stream_transform.js:179:12)
    at doWrite (_stream_writable.js:403:12)
    at writeOrBuffer (_stream_writable.js:387:5)
    at Decoder.Writable.write (_stream_writable.js:318:11)
    at Readable.ondata (_stream_readable.js:695:22)
    at Readable.emit (events.js:310:20)
    at Readable.EventEmitter.emit (domain.js:482:12)

Expected behaviour
Should not crash

Bot Configuration:

• OS: [e.g. macOS, Ubuntu]
• SpeechEngines (if applicable)
• HotwordEngines (if applicable)
• Database (if applicable)

Additional context

Created Issue on DiscordJS Repo here

• Check if the guild config contains all required properties by comparing against default config when loaded.
• This allows E.V.E bot to have updates to the config and ensure that previously generated configs will be updated properly

• Some bot responses are extremely long, they should be truncated in order to improve the overall visual quality
• Some user inputs are not restricted in text length (e.g macro command name, alias, etc.), these should also be limited

With Snowboy deprecation coming soon, and Porcupine's introduction of Alexa / OK Google / Hey Siri, Snowboy likely does not to be included / used in the library.

Pros:

• Reduce node dependencies
• Reduce linux dependencies

Cons:

• One less reference for hotword detection

• Large table messages are split across multiple messages, this is unappealing and might be considered spammy in some servers
• Once #28 has been closed, add an option to scroll through the table by reacting to the message (similar to Groovy)

Describe the bug
If a command has an alias, and the alias is used in the help command, the help command returns an incorrect description

To Reproduce
e.g play is aliased with test, help test is used, the following message will use test as the keyword instead of play

Expected behaviour
help message uses the correct keyword (maybe it should show aliases in the message as well)

Issue

Currently when a playlist / album is queued, every song is passed through YTDL-core to determine whether or not a valid song can be found. This can cause issues when large playlists / albums are queued as it takes a while to resolve all these songs.

Fix

Possibly only resolve the first 5? or so songs in the playlist / album, then as songs are removed from the queue, resolve another one in the background

Is your feature request related to a problem? Please describe.
More standardized bot acknowledgement (i.e reacting with emojis)

Describe the solution you'd like
Define different acknowledgement types, allow users to customize the emojis that represent each acknowledgement type

Describe context of feature
Improvement to existing feature

Additional context
Users should be able to customize the emojis through configs

• Add unit tests (using jest?)
• Mocking discordjs might be hard
• Some helpful articles / documentation for implementing tests

https://medium.com/@RupaniChirag/writing-unit-tests-in-typescript-d4719b8a0a40
https://jestjs.io/docs/en/getting-started
https://medium.com/codeclan/mocking-es-and-commonjs-modules-with-jest-mock-37bbb552da43
https://flaviocopes.com/jest/#mocking
https://dev.to/jackcaldwell/mocking-es6-class-methods-with-jest-bd7