Skip to content

Latest commit

 

History

History
239 lines (160 loc) · 5.97 KB

README.rst

File metadata and controls

239 lines (160 loc) · 5.97 KB

Mopidy-Mowecl

Latest PyPI version

Web client providing a clean and ergonomic interface to Mopidy.

Presentation

  • Dual panel library / tracklist
  • Library / playlists / search results displayed as a single tree view
  • Reorder tracklist with drag and drop
  • Uses the bookmarks extension
  • Configurable hotkeys for playback and volume control
  • Basic color theming
  • Both global and per-client configuration
Preview

Implementation

Mopidy-Mowecl is written in Javascript, and is built upon React, Redux and Material-ui.

Installation

Depending on your setup, install either by running:

# When mopidy was installed with pip
python3 -m pip install Mopidy-Mowecl

or:

# When mopidy was installed as a package or pip using sudo
sudo python3 -m pip install Mopidy-Mowecl

Configuration

Mowecl can both be configured in-app, and through the mopidy configuration file. Values set in the configuration files will act as default values for the clients, that can then override theme as they wish (clients configuration is stored in the browser data).

Here is are the available settings (and default values) of Mowecl in the Mopidy configuration file:

[mowecl]
enabled = true

# generic config
seek_update_interval = 500
search_history_length = 10
## set to true for touch_screens
disable_dnd = false
small_screen = false

# theme config
## light or dark
theme_type = light
background_color = #fdf6e3
text_color = #002b36
primary_color = #268bd2

# Hotkeys, use web config to find the right parameters
key_play_pause = space+Control
key_next_track = ArrowRight
key_previous_track =
key_rewind_track = ArrowLeft
key_volume_up = ArrowUp
key_volume_down = ArrowDown

Theming

Basic theming is available in the configuration, with the following options:

  • Background color
  • Text color
  • Highlight color

For example, you can use the following settings:

  Solarized (light) Blueberry (dark)
Background color #fdf6e3 #232937
Text color #002b36 #7390aa
Highlight color #268bd2 #27e8a7

Building

Mowecl is a React application served by a python app. Building the application thus requires tools from both the javascript and the python ecosystem.

Requirements

  • The yarn program
  • The setuptools and wheel python packages (installable via pip)

Steps

From the root of Mowecl directory, running the following commands will build the web application,, and then build the mowecl python package in the dist folder.

cd mowecl_react
yarn install
yarn build
cd ..
python3 setup.py sdist bdist_wheel
ls dist

You can then install the built package with pip, e.g.

pip3 install dist/Mopidy_Mowecl-X.X.X-py3-none-any.whl

Development

To run Mowecl in develop mode, do the following:

cd mowecl_react
yarn install
yarn start

Changelog

v0.4.3

  • fix release

v0.4.2

Note: release file on pypi is bugged, do not install this version from pypi !

  • update javascript dependancies

v0.4.0

  • Favorites
  • repeat/single/random playback buttons
  • Option to disable drag'n drop (usefull for touch screens)
  • Small screen option (single panel, smaller buttons). Far from perfect but better than nothing.
  • Many performance optimizations

v0.3.6

  • Use mopidy-bookmarks extension
  • Confirm dialog for playlist delete and overwrite
  • Some UI improvements

v0.3.5

  • Parse configuration from mopidy
  • Add uri button
  • Fix volume increase/decrease

v0.3.4

  • Configurable hotkeys for playback and volume control
  • Some performance improvements

v0.3.3

  • Color theming

v0.3.2

  • Global hotkeys: space for play/pause
  • Display track length in tracklist
  • Light/dark theme
  • New version notification

v0.3.1

  • Search history
  • Highlight of hovered library / tracklist item
  • Some fixes

v0.2.0

  • Initial release.

PROJECT resources

Credits