https://github.com/pimusicbox/mopidy-musicbox-webclient

Web Client for Mopidy Music Server and the Pi MusicBox
https://github.com/pimusicbox/mopidy-musicbox-webclient

mopidy mopidy-web-ext

Last synced: 4 months ago
JSON representation

Web Client for Mopidy Music Server and the Pi MusicBox

• Host: GitHub
• URL: https://github.com/pimusicbox/mopidy-musicbox-webclient
• Owner: pimusicbox
• License: apache-2.0
• Created: 2012-12-27T23:42:21.000Z (over 13 years ago)
• Default Branch: develop
• Last Pushed: 2021-04-10T12:41:13.000Z (over 5 years ago)
• Last Synced: 2025-10-08T23:59:04.992Z (10 months ago)
• Topics: mopidy, mopidy-web-ext
• Language: JavaScript
• Homepage:
• Size: 9.77 MB
• Stars: 396
• Watchers: 38
• Forks: 103
• Open Issues: 26
• Metadata Files:
  • Readme: README.rst
  • Changelog: CHANGELOG.rst
  • License: LICENSE

Awesome Lists containing this project

• awesome-starred - pimusicbox/mopidy-musicbox-webclient - Web Client for Mopidy Music Server and the Pi MusicBox (others)
• awesome-selfhosted - Mopidy MusicBox - Web Client for Mopidy Music Server. `Apache-2.0` `HTML5` (Media Streaming / Audio Streaming)
• awesome-selfhosted123 - Mopidy MusicBox - Web Client for Mopidy Music Server. `Apache-2.0` `HTML5` (Media Streaming / Audio Streaming)
• awesome-selfhosted-cn - Mopidy MusicBox - Web Client for Mopidy Music Server `Apache` `Javascript` (媒体流 / 语音流)

README

          
*************************

Mopidy-MusicBox-Webclient

*************************

.. image:: https://img.shields.io/pypi/v/Mopidy-MusicBox-Webclient.svg

    :target: https://pypi.org/project/Mopidy-MusicBox-Webclient/

    :alt: Latest PyPI version

.. image:: https://img.shields.io/circleci/project/pimusicbox/mopidy-musicbox-webclient/develop.svg

    :target: https://circleci.com/gh/pimusicbox/mopidy-musicbox-webclient

    :alt: CircleCI build status

.. image:: https://img.shields.io/codecov/c/github/pimusicbox/mopidy-musicbox-webclient/develop.svg

    :target: https://codecov.io/gh/pimusicbox/mopidy-musicbox-webclient

    :alt: Test coverage

.. image:: https://img.shields.io/badge/code%20style-standard-brightgreen.svg

    :target: http://standardjs.com/

    :alt: JavaScript Standard Style

Mopidy MusicBox Webclient (MMW) is a frontend extension and JavaScript-based web client especially written for

`Mopidy `_.

Features

========

- Responsive design that works equally well on desktop and mobile browsers.

- Browse content provided by any Mopidy backend extension.

- Add one or more tracks or entire albums to the queue.

- Save the current queue to an easily accessible playlist.

- Search for tracks, albums, or artists from specific backends or all of Mopidy.

- Shows detailed track and album information during playback, with album cover retrieval from Last.fm.

- Support for all of the Mopidy playback controls (consume mode, repeat, shuffle, etc.)

- Deep integration with, and additional features for, the `Pi MusicBox `_.

- Fullscreen mode.

.. image:: https://github.com/pimusicbox/mopidy-musicbox-webclient/raw/develop/screenshots/overview.png

    :width: 1312

    :height: 723

Dependencies

============

- MMW has been tested on the major browsers (Chrome, IE, Firefox, Safari, iOS). It *may* also work on other browsers

  that support websockets, cookies, and JavaScript.

- ``Mopidy`` >= 3.0.0. An extensible music server that plays music from local disk, Spotify, SoundCloud, Google

  Play Music, and more.

Installation

============

Install by running::

    sudo python3 -m pip install Mopidy-MusicBox-Webclient

Or, if available, install the Debian/Ubuntu package from

`apt.mopidy.com `_.

Configuration

=============

MMW is shipped with default settings that should work straight out of the box for most users::

    [musicbox_webclient]

    enabled = true

    musicbox = false

    websocket_host =

    websocket_port =

    on_track_click = PLAY_ALL

The following configuration values are available should you wish to customize your installation further:

- ``musicbox_webclient/enabled``: If the MMW extension should be enabled or not. Defaults to ``true``.

- ``musicbox_webclient/musicbox``: Set this to ``true`` if you are connecting to a Mopidy instance running on a

  Pi Musicbox. Expands the MMW user interface to include system control/configuration functionality.

- ``musicbox_webclient/websocket_host``: Optional setting to specify the target host for Mopidy websocket connections.

- ``musicbox_webclient/websocket_port``: Optional setting to specify the target port for Mopidy websocket connections.

- ``musicbox_webclient/on_track_click``: The action performed when clicking on a track. Valid options are: 

  ``PLAY_ALL`` (default), ``PLAY_NOW``, ``PLAY_NEXT``, ``ADD_THIS_BOTTOM``, ``ADD_ALL_BOTTOM``, and ``DYNAMIC`` (repeats last action).

Usage

=====

Enter the address of the Mopidy server that you are connecting to in your browser (e.g. http://localhost:6680/musicbox_webclient)

Project resources

=================

- `Source code `_

- `Issue tracker `_

- `Changelog `_

Credits

=======

- Original author: `Wouter van Wijk `__

- Current maintainer: `Nick Steel `__

- `Contributors `_