Ecosyste.ms: Awesome
An open API service indexing awesome lists of open source software.
https://github.com/mamantoha/crympd
A minimalistic web-based MPD client
https://github.com/mamantoha/crympd
crystal mpd mpdclient music-player-daemon websocket
Last synced: 3 months ago
JSON representation
A minimalistic web-based MPD client
- Host: GitHub
- URL: https://github.com/mamantoha/crympd
- Owner: mamantoha
- License: mit
- Created: 2020-04-11T10:09:44.000Z (almost 5 years ago)
- Default Branch: master
- Last Pushed: 2024-10-01T14:28:29.000Z (4 months ago)
- Last Synced: 2024-10-04T15:45:29.067Z (4 months ago)
- Topics: crystal, mpd, mpdclient, music-player-daemon, websocket
- Language: Crystal
- Homepage:
- Size: 4.15 MB
- Stars: 15
- Watchers: 3
- Forks: 2
- Open Issues: 0
-
Metadata Files:
- Readme: README.md
- License: LICENSE
Awesome Lists containing this project
README
# cryMPD
[](https://crystal-lang.org/)
Control [Music Player Daemon](https://www.musicpd.org/) audio playing in the browser
## Features
- [x] Controlling playback (play, pause, skip next, and skip back)
- [x] Scroll current song
- [x] Playback options (shuffle, repeat, and repeat once)
- [x] Change volume
- [x] Change song in the playlist
- [x] A database update
- [x] Displays statistics
## Install
You can install `cryMPD` in different ways.
### Binaries
The project offers precompiled binary packages for Linux and macOS.
You can obtain the standalone binary for `cryMPD` from the [releases](https://github.com/mamantoha/cryMPD/releases) page, available for download.
```
./bin/crympd
[development] cryMPD is ready to lead at http://0.0.0.0:3001
```
### From sources
`cryMPD` requires [Crystal](https://crystal-lang.org/install/) and [Node.js](https://nodejs.org/en/download/) to be installed.
Clone this repository:
```console
https://github.com/mamantoha/cryMPD.git
cd cryMPD/
```
Install and build `npm` dependencies:
```console
npm install
npm run build
```
Install Crystal dependencies:
```console
shards install
```
Run server:
```console
crystal ./src/crympd.cr
[development] cryMPD is ready to lead at http://0.0.0.0:3001
```
```console
crystal ./src/crympd.cr --mpd_host 192.168.1.1 --mpd_port 6601
```
## Contributing
1. Fork it ()
2. Create your feature branch (`git checkout -b my-new-feature`)
3. Commit your changes (`git commit -am 'Add some feature'`)
4. Push to the branch (`git push origin my-new-feature`)
5. Create a new Pull Request
## Contributors
- [Anton Maminov](https://github.com/mamantoha) - creator and maintainer