ptgdp/README.md

48 lines
1.2 KiB
Markdown

# ptgdp: Play the Goddamned Playlist
A tool to play a plaintext playlist composed entirely of youtube-dl search queries
## Installation
Put `ptgdp` somewhere in `$PATH` and install youtube-dl. Additionally, you need some implementation of `pgrep`, which is probably already on your system, and Bash.
## Quickstart
Make a file containing a few download queries. For example:
myplaylist
```
alice in chains love hate love
megadeth high speed dirt
tool parabola
```
Then invoke `ptgdp`:
ptgdp myplaylist
See below for more intricate usage.
## Configuration
Move `ptgdp.conf` from this repo to `~/.config/ptgdp.conf` and change the values as you see fit. Alternatively, invoke `ptgdp` with `-c` and point it at your config file.
## Return Codes
| Code | Meaning |
| --: | :-- |
| `1` | Syntax error |
| `50` | Misconfigured backend |
| `51` | Backend could not be set up (i.e. mpd failed to update) |
| `60` | Playlist does not exist |
| `61` | Playlist is unreadable |
## Idiosyncracies
* Because I haven't quite figured out how to into mpd sockets, this tool assumes that `$XDG_MUSIC_DIR` (`~/Music`) is the root of your library.
## License
See `LICENSE` (hint: it's MIT, just like the header says).