Skip to content

typedcode/musikcube-webplayer

Repository files navigation

musikcube-webplayer

musikcube-webplayer is a free to use web-frontend for the musikcube streaming audio server. It is intendet to be installed alonside ones musikcube instance in the local network.

For now the musikcube-webplayer is in a version < 1.0.0. This means that stuff can change. If you update from a previous version and the player will not start, please doubleckeck the installation documentation to check if something has changed.

prerequisites

  • musikcube must be installed (get it here)
  • install the musikcube-webplayer-proxy (get it here)
  • node needs to be installed

installation

  • clone this repository
  • rename .env.template to .env
  • set at least the VITE_MUSIKCUBE_SERVER_ADDRESS and VITE_MUSIKCUBE_PROXY_ADDRESS to the appropriate values. Check the parameters table for additional parameters and default values.
  • run npm ci
  • run npm run start

parameters

Parameter Default Description
VITE_MUSIKCUBE_SERVER_ADDRESS IP-Adress where musikcube is running
VITE_MUSIKCUBE_PROXY_ADDRESS Address (inkl protocol) where the proxy is running
VITE_MUSIKCUBE_METADATASERVER_PORT 7905 Port for the musikcube metadata server. Can be found in musikcube -> settings -> server setup.
VITE_MUSIKCUBE_PASSWORD If the password for musikcube is set. Enter it here
VITE_MUSIKCUBE_PROXY_PORT 5000 Port to connect to the proxy

(planned) features

  • play tracks
  • play all tracks of an artist
  • play an album
  • add song to playqueue
  • adjust volume
  • pause/resume track
  • show artists
  • show albums of artist
  • pause/resume via multi media keys
  • show playqueue
  • show playlists
  • play playlist
  • add album to playqueue
  • create playlist
  • add track to playlist
  • add album to playlist
  • remove track from playlist
  • remoce track from playqueue
  • rename playlist
  • integrate album art to mediasession
  • save volume settings for next session
  • save last played artist/playlist/playqueue and track
  • repeat
  • shuffle
  • next track
  • previous track

About

No description, website, or topics provided.

Resources

License

Stars

Watchers

Forks

Releases

No releases published

Packages

No packages published