Getting Started

This guide is aimed more at the end user than the instance administrator

Installation

There are two main ways of using MusicPlayer:

• Use the paid, hosted version, available at https://music.janishutz.com
• See the official Installation Guide to install it on your own hardware. You need access to an Apple Developer Account for the full feature set

Usage

Playlists

MusicPlayer allows you to create Playlists that combine songs from multiple sources into a single playlist. Create one using the "Add Playlist" button in the main user interface. Be sure to save your changes to the playlist whenever you made some. Changes are not auto-saved by design, to allow you to undo all unsaved changes with just a click of the button. You will be warned if you have made changes to your playlists since last saving them and are closing the page.

Player

The MusicPlayer player interface allows you to add new songs and reorder the current playlist using drag and drop. You can also control the player using the keyboard, press Space to play / pause and the left and right arrow keys to go to the previous or next song.

Shares

When using a share, you will get a public link to your current playback progress and playlist. Users can see what song you are currently playing, what your playback progress is and what your upcoming songs are.

Anti-Tamper

Anti-Tamper is a feature that allows you to be notified when a device on which the share is loaded with Anti-Tamper enabled is tampered with. On that device, it is highly recommended that you allow notifications to allow MusicPlayer to display a warning when people are tampering.

When Anti-Tamper is enabled and a connected device is tampered with, a full-window notification is displayed on your player panel.

More information here

Client Display Pages

A Client Display is a share page. On these pages you are limited to just three themes: Dark Mode, Flashbang Mode (aka Light Mode) and the fancy mode. The first two can easily be toggled in the top right corner, whereas the fancy mode is enabled by either toggling it in the settings menu in the top left corner or by visiting the fancy-by-default share page.

Limitations

• Mobile design is not completed for the MusicPlayer UI
• You can either use OpenID Connect for sign in or no sign in at all. There are plans to eventually also add local authentication, but that is low priority (since ProxyAuth is a thing).
• In Anti-Tamper mode, only websockets can be used for the clients with Anti-Tamper enabled.
• As an intentional design choice, users on the default share settings, or all users on shares without Anti-Tamper, cannot use websockets and must instead rely on the polling or SSE options.
• The player that created the share must use WebSockets.
• If you want to offer a hosted service for MusicPlayer, currently only my store is supported for ownership check. Implementing your own solution is fairly easy however.