🎡 A simple, clean and cross-platform music player
Clone or download
Fetching latest commit…
Cannot retrieve the latest commit at this time.

README.md

museeks

Build Status Dependencies Github All Releases Gitter

A simple, clean and cross-platform music player. (museeks.io)

Screenshot

It uses:

Features

Museeks aims to be a simple and easy to use music player with a clean UI, you will not find tons of features. Here is a little preview though:

  • πŸ’» Cross-platform music player (Linux, macOS and Windows)
  • 🎧 Supported formats: mp3, mp4, m4a/aac, flac, wav, ogg, 3gpp
  • ✨ Clean and polished
  • 🌟 Playlists
  • 🎼 Queue management
  • ➰ Shuffle, loop
  • πŸŒ„ Covers support
  • πŸ€“ Dark theme
  • 🚀 Playback speed control
  • 😴 Sleep mode blocker
  • πŸ”Š Minimize to tray

Releases notes

Over here!

Installation

Classic

Builds and installers can be found on this page.

Build (advanced)

Please consider that master is unstable.

  • git clone git@github.com:martpie/museeks.git
  • cd museeks
  • npm install
  • npm run build or npm run dev
  • npm run museeks or npm run museeks:debug

Troubleshooting

Museeks is currently in development. This implies some things can break after an update (database schemes changes, config...).

If you encounter freezes or crashes when using the app, you can reset Museeks by following these steps:

  • Go to the Museeks folder directory
    • Windows: %AppData%\museeks
    • OSX: ~/Library/Application Support/museeks
    • Linux: ~/.config/museeks/ or $XDG_CONFIG_HOME/museeks
  • Delete:
    • IndexedDB folder
    • config.json file
  • Restart Museeks

If you still get problems after that, please open an issue :)

Bug report

If you want to report a bug, first, thanks a lot, that helps us a lot. Please open an issue and mention your OS, your Museeks version, and how to reproduce it. Adding a screen of the console (Menu -> View -> Toggle Developer Tools) is a big help too.

Contribute

  • Fork and clone
  • Master may be unstable, checkout to a tag to have a stable state of the app
  • npm install && npm run dev then run in a separate terminal npm run museeks:debug
  • npm run dev will watch for file changes using Webpack which will recompile JSX and SASS files.

Please respect a few rules:

  • Before making complex stuff, don't hesitate to open an issue first to discuss about it ;)
  • Make the code readable and comment if needed
  • Make sure your build pass

Then open a PR :)