Web interface walk through

Warning: This page is outdated.

The web interface comprises two sections: Playlist and Music Library.

Playlist section

A screenshot of the Playlist section is shown here:

As seen from the screenshot, the main body is the playlist the bot is playing, with the song being played marked by a grey background.

• Three controls button in the box "1" can be used to resume, pause and stop playing.

• Buttons in box (2) are playback mode options, from left to right are one-shot mode, random mode, repeat mode, and auto-play mode. Their differences are noted in Playback mode explained

• Buttons in box (3) are volume control buttons. Each of them will increase or decrease the volume by 5.

• Buttons in box (4) can be used to let the bot jump to a song or remove a song from the playlist.

• Clicking button (5) will activate a tag editing window, where you can edit tags for this song.

• Button (6) will empty the playlist, as its name indicates.

Music Library

The music library consists of two parts. The first part is a browser: Files listed in the body of the browser are all files that match the criteria set by the filters in the Filter section. All of these filters are connected by AND logic.

• Type Filter (1) decides the type of items that pass through the filter. You can select multiple types.

• Directory Filter (2) only applies to "File" type items. All files under the directory selected will pass through the filter, includes files in all sub-directories under that directory. Please be noted that the root directory that stores all your music files needs to be set in the configuration file.

[bot]
music_folder = music_folder/

• Keyword Filter (3) specifies the keywords items need to have. Both the title or the artist can be used as keywords.

• Tag Filter (4) specifies the tags items need to match. Selected tags will be highlighted.

Actions you can do to an item are shown near (5). They are, from left to right,

• Add this item to the playlist, right below the item being played now, which means this item becomes the next song to be played.

• Add this item to the bottom of the playlist.

• Download this item.

• Remove this item from the library. This will directly remove the song file of an item from your hard drive by invoking the rm of your file system.

If you move your cursor to the thumbnail (6) of an item, it will become a play button. This button is served as a "preview" function. Once you click, it will add this item below the item being played now on the playlist, and start playing this item immediately.

If more than 10 files match your criteria, the browser will display them in a 10-item-per-page manner. You can switch between pages through pagination in (7).

Button group (8) lists actions that apply to all items that match your criteria, include items on all pages, not just the current page. The "Download All" button will pack all files into a zip file, while "Delete All" will delete all matched items.

The rest of the Music Library is forms used to add items into the music library.

• The Upload File form allows one to upload files to your music folder. You can select multiple files in the file selection dialog. The Upload To input box specifies where to store these files. It can be an existed folder, or the bot will create one if it does not exist.

• The Add URL and Add Radio forms are used to add youtube, SoundCloud links (or other types of links, as long as youtube-dl supports) and radio links. It will be added to the library and the bottom of the playlist. However, you need to refresh the webpage to see them in the library.

Change the theme

Currently, the web interface supports two themes: Light and Dark. You can switch between then by clicking the lightbulb button on the bottom right corner.