xenmotif/README.md

33 lines
657 B
Markdown
Raw Permalink Normal View History

2023-03-21 21:40:09 +00:00
# Xenmotif
A simple `TUI` and commandline client for `mpd`.
## Goals
- Simple and easy to use
- Modern features such as album art, scrobbling, notifications, etc.
- Simple configuration via a `TOML` file, and commandline options
## API (WIP)
### Commandline Options
`--help` - Print help options
2023-03-21 21:43:42 +00:00
2023-03-21 21:40:09 +00:00
`-p/--port` - Specify MPD port
2023-03-21 21:43:42 +00:00
2023-03-21 21:40:09 +00:00
`-h/--host` - Specify MPD host
2023-03-21 21:43:42 +00:00
2023-03-21 21:40:09 +00:00
`-c/--config` - Use a specific configuration file
2023-03-21 21:43:42 +00:00
2023-03-21 21:40:09 +00:00
`-v/--version` - Print version information
2023-03-21 21:43:42 +00:00
2023-03-21 21:40:09 +00:00
`-j/--json` - Output in JSON format
### Subcommands
`stop` - Stop playing
2023-03-21 21:43:42 +00:00
2023-03-21 21:40:09 +00:00
`play` - Start/resume playing
2023-03-21 21:43:42 +00:00
2023-03-21 21:40:09 +00:00
`pause` - Pause playing
2023-03-21 21:43:42 +00:00
2023-03-21 21:40:09 +00:00
`queue` - Print off queue
2023-03-21 21:43:42 +00:00
2023-03-21 21:40:09 +00:00
`info` - Print current song information