ptgdp/README.md
Salt f35f8867f6 Add basic functional implementation
Mostly copied from another attempt at this
Time to bug hunt
2019-09-26 16:34:31 -05:00

48 lines
1.1 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`.
## Quickstart
Make a file containing a few download queries. For example:
myplaylist.gdp
```
alice in chains love hate love
megadeth high speed dirt
tool parabola
```
Then invoke `ptgdp`:
ptgdp myplaylist.gdp
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).