Lyra Music Player

Lyra is a cross-platform music player app that can play songs on your computer and on YouTube.

This repository contains the code for the desktop and browser app versions of Lyra, written in Electron. Also check out the mobile app.

Check out the lightweight version built with Neutrino!

Features

• Songs
  • Add songs on your computer and play them (only on Electron)
  • Remove songs
• Playback
  • Volume control
  • Shuffle
  • Skip forward / back 10 seconds
  • Skip to previous / next song
  • Media button shortcuts (Play, Pause, Skip)
• Queue
  • Add to queue
  • Generates queue
• Song metadata
  • Parses title and artist metadata
  • Edit metadata within the player
• Playlists
  • Create and delete playlists
  • Add and remove songs to playlists
  • Play songs in a playlist
• YouTube
  • Search for YouTube videos
  • YouTube video playback (audio only)
  • Autoplay
  • Shows related videos
  • Add video to library
  • Download YouTube video as audio

Keyboard Shortcuts:

• K: Toggle play / pause
• J: Skip back 10 seconds
• L: Skip forward 10 seconds
• H: Skip to previous song / start of song
• (Semicolon): Skip to next song

Screenshots

Development

There are several ways to run Lyra:

Electron App

npm run electron       # Run locally in development mode

npm run electron:build # Build unpacked release

npm run electron:dist  # Create unpacked Electron app

npm run electron:pack  # Create packaged executable

Browser Web App

npm run browser       # Available on localhost:9000

npm run browser:build # Create release

npm run browser:serve # Serve built release on localhost:8080

This also requires lyra-server to be running (on localhost:5000).

Neutrino App (Experimental)

Until I get to uploading binaries, you will need to build Neutrino from source.

Clone Neutrino, then follow the build instructions in the Neutrino README. Place them in the same directory (or change the relative path in package.json for the package neutrinojs). Make sure to place the built executable inside neutrino/lib. If you use CMake, the provided config should already do it.

The build scripts use neutrino-webpack and neutrino-builder, which are provided along with Neutrino. Check Neutrino README for more details.

npm run neutrino       # Run locally with Neutrino in development mode

npm run neutrino:build # Create release

npm run neutrino:dist  # Create unpacked Neutrino app
                       # (Note: Windows won't be able to run the unpacked app; see Neutrino's README)

This also requires lyra-server to be running (on localhost:5000).

Note:

• Media button shortcuts don't work normally in Linux. To get around it, the player uses dbus to directly access shortcuts. dbus requires several other packages to install:
  • npm i -g node-gyp
  • sudo apt-get install libdbus-1-dev libglib2.0-dev
  • Upon installing dbus, node will build the package for use. However, there may be differences in Node and Electron NODE_MODULE_VERSIONs.
    • See more here: https://electronjs.org/docs/tutorial/using-native-node-modules
• On macOS Mojave (and higher), access to media keys requires accessibility permissions. In this case, Lyra will display a dialog requesting permissions.
• On Linux, running the AppImage for the first time will install the desktop file in ~/.local/share/applications/ for desktop integration. However, if the path to the AppImage has a space in it, the desktop file will have an incorrect value for TryExec, making it unable to run.
  • TryExec doesn't support quotes, so spaces in the path must be escaped. However, they are escaped with \\s rather than \s.
    • See AppImage/AppImageKit#948 and electron-userland/electron-builder#3547
  • My fix is to set the AppImage executable name to something without spaces. As long as the directories in the path don't have spaces, the integration should work normally.