0.8.11 • Published 3 years ago

stark-player v0.8.11

Weekly downloads
-
License
MIT
Repository
github
Last release
3 years ago

Mp3 Player Drone Running on the Stark Orchestrator in Browsers

Build and test status NPM version

UI package for playing .PLS playlists of MP3 files, running in the browser, on the Stark Orchestrator, built with Vue.js.

Getting Started

The Stark-Orchestrator project that runs the Core of the system needs to have been initialized for the server to respond to the browsng endpoint http://LAN_URL:STARK_PORT. Then, the following commands will use $STARK_HOME/.env to deploy the player package to the configured user:

  1. First, navigate to the packages folder of the Stark-Orchestrator project.

    cd $STARK_HOME/packages
  2. Clone or download the Stark-Player project.

    gh repo clone WeWatchWall/stark-player
  3. Run the deployment script.

    cd stark-player/bin
    watch-deploy.cmd
  4. This script will watch $STARK_HOME/packages/stark-player/dist until it is cancelled. Your prompt will return to $STARK_HOME.

Usage

First, use the left menu to navigate to the Control panel.

You can upload a .zip file containing:

  1. A .PLS file with Path, Title, Length for each track on the playlist.

  2. An .MP3 file for each entry in the .PLS file.

Two example copyright-free playlists are included in the /example_playlists folder. This link describes how to work with .PLS playlists.

For best results, keep all the files in the root level of the .zip archive.

Once the playlist is loaded, central playback controls will appear below the file selector input. Press play. Then, navigate to the Play panel. The user must press play at least once on the audio element on the Play panel to hear the playback on each browser window. Sync can be controlled per browser instance.