https://github.com/techno-coder/pmu
Unobtrusive terminal music player written in Rust
https://github.com/techno-coder/pmu
discord lastfm music osu rust stepmania terminal
Last synced: 23 days ago
JSON representation
Unobtrusive terminal music player written in Rust
- Host: GitHub
- URL: https://github.com/techno-coder/pmu
- Owner: Techno-coder
- License: mit
- Created: 2022-01-02T08:26:52.000Z (over 3 years ago)
- Default Branch: master
- Last Pushed: 2022-01-04T14:12:33.000Z (over 3 years ago)
- Last Synced: 2025-02-08T18:12:36.038Z (3 months ago)
- Topics: discord, lastfm, music, osu, rust, stepmania, terminal
- Language: Rust
- Homepage:
- Size: 241 KB
- Stars: 0
- Watchers: 2
- Forks: 0
- Open Issues: 0
-
Metadata Files:
- Readme: README.md
- License: LICENSE.md
Awesome Lists containing this project
README
# pmu
**P**lay **mu**sic in your terminal!
## Features
### Play past songs from any directory
After you play a song, run the same command to play the same song even if you're in a different directory! Playback
history is stored in an SQLite database.
### Extract metadata from supported song folders
Metadata is automatically extracted from special song folders. Supported folders include those from:
- osu!
- Stepmania
### Discord Rich Presence
Show off the song you're playing in Discord!
### Last.fm scrobbling
Track the music you play on [last.fm](https://www.last.fm/)!
## Installation
```
$ cargo install --locked --git https://github.com/Techno-coder/pmu
```
## Usage
### Play a song
```
$ pmu play path/to/song.mp3
```
### Print help
```
$ pmu help
```
### Print configuration directory
```
$ pmu config
```
## Configuration
The configuration file is named `config.json`. The documentation for each option can be found [here](src/config.rs).
## Recommended additions
### [fzf](https://github.com/junegunn/fzf)
fzf lets you quickly search for audio files and past command history.
## Hotkey terminal
Some terminal emulators such as [iTerm2](https://iterm2.com) allow you to set a keyboard shortcut to instantly activate
a terminal window.
## Shell aliases
You can set aliases in your `~/.bashrc` or `~/.zshrc` profile to play songs faster:
```shell
alias song="pmu play --now"
alias pause="pmu pause"
alias stop="pmu stop"
```
## Troubleshooting
The daemon can be spawned manually with `pmu daemon`:
