https://github.com/BonnyAD9/uamp
Universal Advanced Music Player written in Rust.
https://github.com/BonnyAD9/uamp
audio-player audio-server music-player music-server rust
Last synced: about 2 months ago
JSON representation
Universal Advanced Music Player written in Rust.
- Host: GitHub
- URL: https://github.com/BonnyAD9/uamp
- Owner: BonnyAD9
- License: gpl-3.0
- Created: 2023-05-12T16:25:52.000Z (about 2 years ago)
- Default Branch: master
- Last Pushed: 2025-05-06T16:04:43.000Z (2 months ago)
- Last Synced: 2025-05-06T16:42:04.918Z (2 months ago)
- Topics: audio-player, audio-server, music-player, music-server, rust
- Language: Rust
- Homepage: https://bonnyad9.github.io/uamp
- Size: 950 KB
- Stars: 13
- Watchers: 1
- Forks: 0
- Open Issues: 0
-
Metadata Files:
- Readme: README.md
- Changelog: CHANGELOG.md
- License: LICENSE
Awesome Lists containing this project
README
# uamp
[![version][aur-badge]][aur]
Universal Advanced Music Player written in Rust.
Uamp is a minimal music player that doesn't get in your way. It is fast,
reliable, and powerful.
Uamp currently works as playback server controled with CLI.
## Configuration
The configuration is saved in the efault configuration folder on your
platform. You can use `uamp config` to open the config file with your default
editor.
## CLI
See short help of uamp:
```sh
uamp -h
```
### Examples
Show help with all the options (shortest version):
```sh
uamp h all
```
To play/pause you can use the command:
```sh
uamp instance play-pause
```
or the short version
```sh
uamp i pp
```
To start uamp in backgound:
```sh
uamp run -d
```
or short:
```sh
uamp -R-d
```
Stop the running instance:
```sh
uamp i x
```
Show info about now playing:
```sh
uamp -Info
```
Set the playlist to all songs, shuffle and play:
```sh
uamp i sp sort=rng pj pp=play
```
Play file in the currently running instance:
```sh
uamp i play='path/to/file.flac'
```
## How it looks
Currently uamp has no GUI or TUI. The closest thing to gui that uamp has is the
output of `uamp -Info`:
## Possible uamp setup
This is the way that I have confugred and use uamp:
Make uamp start on startup with your cmomputer with the command `uamp`
(or `uamp -R-d` to make it detached).
Use your OS settings to bind global shortcuts to commands for controlling uamp.
For example:
- **`Ctrl` + `Alt` + `Home`:** `uamp i pp` (play/pause)
- **`Ctrl` + `Alt` + `PgUp`:** `uamp i ps` Previous song
- **`Ctrl` + `Alt` + `PgDown`:** `uamp i ns` Next song
- **`Ctrl` + `Alt` + `Up`:** `uamp i vu` Volume up
- **`Ctrl` + `Alt` + `Down`:** `uamp i vd` Volume down
- **`Ctrl` + `Alt` + `Left`:** `uamp i rw` Rewind
- **`Ctrl` + `Alt` + `Right`:** `uamp i ff` Fast forward
Now you can just start playing when you want to by using your global shortcut.
### Endless playback
If you want to setup endless playback of your songs shuffled you can also:
create alias in `config.json`:
```json
{
// ...
"control_aliases": {
// ...
"reset-playlist": "sp sort=rng pj pp=play pap=m spea=reset-playlist"
}
}
```
Now you can start the playback with `uamp i al=reset-playlist` and you never
have to worry about it. It will shuffle all your songs into a playlist and when
the playlist ends it will reshuffle the playlist and start from the start.
When you will load new songs, they will also be automatically mixed in the
playlist after the currently playing song.
### Custom tab complete
Uamp can also provide custom tab completion for any bash like shell (works in
zsh). To do that add this to your `.bashrc`/`.zshrc`/...:
```sh
`uamp sh tab`
```
And that is it. Uamp will now have custom tab completion.
## How to get it
### Arch linux
If you have arch, you can install it from [aur][aur].
### Linux single line install
This install script will ask for sudo privilages to move the build files to
their apropriate locations.
```sh
wget -nv -O - https://raw.githubusercontent.com/BonnyAD9/uamp/master/packages/script/install.sh | sh
```
### Build from source
If you don't have arch, you have to compile it yourself, but that shouldn't be
any problem because all you need is `cargo`:
```sh
cargo build -r
```
the binary will be `./target/release/uamp`. It doesn't depend on any other
files.
## Links
- **Author:** [BonnyAD9][author]
- **GitHub repository:** [BonnyAD9/uamp][github]
- **My website:** [bonnyad9.github.io][my-web]
- **Project website:** [bonnyad9.github.io/uamp][uamp-web]
- **Aur package:** [aur.archlinux.org][aur]
[author]: https://github.com/BonnyAD9
[github]: https://github.com/BonnyAD9/uamp
[my-web]: https://bonnyad9.github.io/
[uamp-web]: https://bonnyad9.github.io/uamp/
[aur]: https://aur.archlinux.org/packages/uamp
[aur-badge]: https://img.shields.io/aur/version/uamp