ptgdp/README.md

48 lines
1.1 KiB
Markdown
Raw Normal View History

2019-09-26 13:59:42 -05:00
# ptgdp: Play the Goddamned Playlist
A tool to play a plaintext playlist composed entirely of youtube-dl search queries
2019-09-26 14:40:37 -05:00
## Installation
Put `ptgdp` somewhere in `$PATH` and install `youtube-dl`.
## Quickstart
2019-09-26 13:59:42 -05:00
Make a file containing a few download queries. For example:
2019-09-26 14:01:02 -05:00
myplaylist.gdp
2019-09-26 13:59:42 -05:00
```
alice in chains love hate love
megadeth high speed dirt
tool parabola
```
Then invoke `ptgdp`:
ptgdp myplaylist.gdp
See below for more intricate usage.
2019-09-26 14:40:37 -05:00
## Configuration
2019-09-26 14:41:11 -05:00
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.
2019-09-26 14:40:37 -05:00
## 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.
2019-09-26 13:59:42 -05:00
## License
See `LICENSE` (hint: it's MIT, just like the header says).