id       = "pyradio"
name     = "PyRadio"
homepage = "https://github.com/coderholic/pyradio"
# The project's own repository description.
description = "Curses based internet radio player"
# The icon PyRadio ships with itself, from pyradio/icons in its repository.
icon     = "https://raw.githubusercontent.com/coderholic/pyradio/master/pyradio/icons/pyradio.png"
executables   = ["pyradio"]

[dotfiles]

# The project's own documentation (docs/index.md) writes the configuration file
# as "typically ~/.config/pyradio/config" and the stations file as
# "e.g. ~/.config/pyradio/stations.csv", and its Windows section puts the same
# directory under %APPDATA%\pyradio. PyRadio reads the variable rather than
# assuming the default — pyradio/xdg.py joins `get_xdg_dir('XDG_CONFIG_HOME')`
# with "pyradio" and falls back to `$HOME/.config`, and pyradio/config.py takes
# `getenv('APPDATA')` on Windows — so this is [configHome] rather than a
# hard-coded ~/.config.
#
# The whole directory, because pyradio/config.py opens config, stations.csv,
# pyradio.csv, favorites.csv, radio-browser.conf and the themes/ folder all
# inside it, and any `*.csv` / `*.m3u` there is another of the user's playlists.
paths = ["[configHome]/pyradio/"]

# Runtime bookkeeping in the same directory, from the same file: `data` (which
# holds the instance lock, among other generated files), the `.lock` file a
# second instance checks, and the `last_playlist` / `last-playlist` marker that
# records what this machine was playing.
exclude = [
  "[configHome]/pyradio/data/",
  "[configHome]/pyradio/.lock",
  "[configHome]/pyradio/last_playlist",
  "[configHome]/pyradio/last-playlist",
]

# Station lists, the chosen player and theme, and the RadioBrowser server
# preference. PyRadio talks to no account, so nothing here is a credential.
secret = []

# `config` is a flat `key = value` file, so a prefix rule reads it and needs no
# `format`. `recording_dir` is an absolute directory on this machine — config.py
# expands it from `~` or `%homepath%` at load and writes the expanded path back
# — and `player` names which of mpv, mplayer or vlc is installed here, which
# differs from machine to machine while the rest of the file is preference.
[[dotfiles.machine_lines]]
file  = "[configHome]/pyradio/config"
match = { prefix = ["recording_dir", "player"] }