Museeks
A simple, clean and cross-platform music player. (museeks.io)
Features
Museeks aims to be a simple and easy to use music player with a clean UI. You will not find tons of features, as its goals is not to compete with more complete and more famous music players. 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π .m3u
import/export
Want more? Open a new issue or
Releases notes
Installation
Classic
Builds and installers can be found on this page.
Build (advanced)
Museeks is built upon:
- Node.js
- Electron (formerly atom-shell)
- React.js as UI library and Flux with Redux as data-flow pattern
Requirements:
node
> 10npm
> 6
Please consider that master
is unstable.
git clone git@github.com:martpie/museeks.git
cd museeks
npm ci
npm run modules:rebuild
npm run build
ornpm run dev
npm run museeks
ornpm run museeks:debug
Package (advanced)
rm -rf node_modules dist build
npm ci
npm run modules:rebuild
npm run build
npm run package:lmw
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
- Windows:
- Delete:
IndexedDB
folderconfig.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 terminalnpm run museeks:debug
npm run dev
will watch for file changes using Webpack which will recompile JSX and CSS 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 :)