https://github.com/lukasdrsman/lwmp
A simple mp3 player written in POSIX shell
https://github.com/lukasdrsman/lwmp
Last synced: 7 months ago
JSON representation
A simple mp3 player written in POSIX shell
- Host: GitHub
- URL: https://github.com/lukasdrsman/lwmp
- Owner: LukasDrsman
- License: unlicense
- Created: 2021-09-05T09:25:27.000Z (about 4 years ago)
- Default Branch: main
- Last Pushed: 2021-09-15T15:12:48.000Z (about 4 years ago)
- Last Synced: 2025-01-28T19:45:28.510Z (9 months ago)
- Language: Shell
- Homepage:
- Size: 8.79 KB
- Stars: 0
- Watchers: 1
- Forks: 0
- Open Issues: 0
-
Metadata Files:
- Readme: README.md
- License: LICENSE
Awesome Lists containing this project
README
# lwmp
A simple mp3 player written in POSIX shell
## Dependencies
- `mpg123`
## Installation
Install with
```sh
git clone https://github.com/LukasDrsman/lwmp.git
cd lwmp
sudo ./install.sh
```
(Optional) Create a config file `lwmprc` in `$HOME/.config`, add the following entries and change them if needed
```sh
PREF="$HOME/music"
COL1="\u001b[31m"
COL2="\u001b[35m"
COL3="\u001b[34m"
```
- `PREF` - music folder location prefix
- `COL1`, `COL2`, `COL3` - color escape sequences for `lwmp_status`
## Usage
### Commands
| command | effect | args |
|---------|--------|------|
|`lwmp` |play album | playlist file, volume percentile |
|`lwmp_stop`|stop lwmp | none |
|`lwmp_skip`|skip song | none |
|`lwmp_status`|print status | none |
### Playlist file
Given the file structure
```
$PREF
└── artist
└── album
├── song1.mp3
├── song2.mp3
├── song3.mp3
└── song4.mp3
```
a playlist, containing `song1` and `song2` by artist `artist` from album `album` would contain
```
artist/album/song1
artist/album/song2
```