anirudhb/neeko-issues

Issues for neeko bot

Neeko issues

This repository is for tracking issues for neeko bot. File issues here.

Please try to be descriptive when filing an issue and try to give as much information as possible.

Also provide reproduction steps if possible!!

neeko-issues's Issues

Avoid leaking implementation details

Is your feature request related to a problem? Please describe.
Don't make things like cogs/extensions visible to the user.

Describe the solution you'd like
Further privacy towards implementation details.

Proposal: Real-time caption playback for songs / lyrics

Is your feature request related to a problem? Please describe.
When playing songs of a different language / songs that are hard to hear, it would be very useful to have real-time caption playback for these songs so that they can be understood in real-time.

Proposal details

New command - $captions which should playback captions for the current song in real time. Additionally, a helper $lyrics command with slightly different semantics.

Subcommands:

• $captions [lang] Play back captions for the specified language (default English). If the -realtime flag is passed, the bot should update the message whenever a new sentence is supposed to be shown. Otherwise, the bot should print a full transcript without timestamps. Additionally, if the -transcript flag is passed, the bot should preserve the previous sentences that were shown in the same message (this flag is only allowed if -realtime is also passed), and also display previous subtitles if the command is invoked in the middle of a song. If the -generated flag is passed, the bot is allowed to retrieve auto-generated subtitles for the specified language. (Note that this flag has no effect if the underlying backend does not support it.)

• $captions translate <src-lang> [dst-lang] Identical to $captions, except subtitles should be extracted for <src-lang> and should be translated to the destination language (default English).

• $captions sidebyside <src-lang> <dst-lang> Identical to $captions, except subtitles should be extracted for both <src-lang> and <dst-lang>, and should be displayed side by side. If the -translate flag is passed, the subtitles for <src-lang> are allowed to be translated into <dst-lang> if there are no subtitles available for that language.

• $lyrics [lang] Retrieve lyrics for the current song in the specified language (default English). This is different from $captions in that the bot is allowed to use external lyric websites to satisfy this query. If the -captions flag is passed, all options that apply to $captions can be passed here. Subtitles will be preferred over external websites.

Subtitle language specifications will be fuzzy-filtered. That is, keywords will be matched to convert it into a standard country code, which is then passed to the appropriate source backend.

Additional context

• Subsystem: Music

Proposal - Options v1

Arguments v1

Describes a system for passing complex arguments to commands.

Format

The format of options can usually be like so

$command -flag -option value positional_arguments...

Work

Implement this for existing commands to augment and enrich their existing functionality, as well as creating a reusable core component for this.

better UX

Bot's functionality is esoteric enough to merit its own documetnation. loading cogs, how to get music working, loading exts, etc.

Also make a custom help command - the default takes up too much space in a channel, and is hard to read.

Music playback fails

When using Youtube to search for songs, music playback fails on certain songs (unreliable and inconsistent, hard to reproduce).