2020-10-21 16:47:41 +00:00
|
|
|
# mmtc
|
2020-11-02 22:58:54 +00:00
|
|
|
|
2020-11-03 00:36:38 +00:00
|
|
|
[](https://github.com/figsoda/mmtc/releases)
|
|
|
|
|
[][Crate]
|
|
|
|
|
[](https://libraries.io/cargo/mmtc)
|
|
|
|
|
[](https://www.mozilla.org/en-US/MPL/2.0)
|
|
|
|
|
[](https://github.com/figsoda/mmtc/actions?query=workflow:ci)
|
|
|
|
|
|
2020-11-11 13:47:23 +00:00
|
|
|
Minimal [mpd](https://github.com/musicplayerdaemon/mpd) terminal client that aims to be simple yet highly configurable
|
2020-11-02 22:58:54 +00:00
|
|
|
|
2020-11-07 18:12:06 +00:00
|
|
|
- [Installation](#Installation)
|
|
|
|
|
- [Building from source](#Building-from-source)
|
|
|
|
|
- [Key bindings](#Key-bindings)
|
|
|
|
|
- [Configuration.md]
|
|
|
|
|
- [CHANGELOG.md]
|
2020-11-02 22:58:54 +00:00
|
|
|
|
2020-11-13 17:03:37 +00:00
|
|
|
|
2020-11-03 00:36:38 +00:00
|
|
|
## Installation
|
|
|
|
|
|
|
|
|
|
The latest precompiled binaries are available on [github](https://github.com/figsoda/mmtc/releases/latest).
|
|
|
|
|
|
2020-11-10 17:53:43 +00:00
|
|
|
Alternatively you can install mmtc from [crates.io][Crate] with cargo.
|
2020-11-13 17:03:37 +00:00
|
|
|
This requires the nightly toolchain of [Rust].
|
2020-11-03 00:36:38 +00:00
|
|
|
|
|
|
|
|
```shell
|
|
|
|
|
cargo +nightly install mmtc
|
|
|
|
|
```
|
|
|
|
|
|
|
|
|
|
|
2020-11-02 22:58:54 +00:00
|
|
|
## Building from source
|
|
|
|
|
|
2020-11-13 17:03:37 +00:00
|
|
|
This requires the nightly toolchain of [Rust].
|
2020-11-02 22:58:54 +00:00
|
|
|
|
|
|
|
|
```shell
|
|
|
|
|
cargo +nightly build --release
|
|
|
|
|
```
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
## Usage
|
|
|
|
|
|
|
|
|
|
```
|
2020-11-03 20:34:59 +00:00
|
|
|
mmtc [FLAGS] [OPTIONS]
|
2020-11-02 22:58:54 +00:00
|
|
|
```
|
|
|
|
|
|
2020-11-09 13:13:14 +00:00
|
|
|
flag | description
|
|
|
|
|
-|-
|
2020-11-09 21:28:23 +00:00
|
|
|
--clear-query-on-play | Clear query on play
|
2020-11-10 23:33:10 +00:00
|
|
|
--cycle | Cycle through the queue
|
2020-11-09 13:13:14 +00:00
|
|
|
-h, --help | Prints help information
|
2020-11-09 21:28:23 +00:00
|
|
|
--no-clear-query-on-play | Don't clear query on play
|
2020-11-09 13:13:14 +00:00
|
|
|
--no-cycle | Don't cycle through the queue
|
|
|
|
|
-V, --version | Prints version information
|
2020-11-02 22:58:54 +00:00
|
|
|
|
2020-11-09 13:13:14 +00:00
|
|
|
option | description
|
|
|
|
|
-|-
|
2020-11-09 19:47:34 +00:00
|
|
|
--address \<address> | Specify the address of the mpd server
|
|
|
|
|
-c, --config \<file> | Specify the config file
|
|
|
|
|
--jump-lines \<number> | The number of lines to jump
|
|
|
|
|
--seek-secs \<number> | The time to seek in seconds
|
|
|
|
|
--ups \<number> | The amount of status updates per second
|
2020-11-02 22:58:54 +00:00
|
|
|
|
|
|
|
|
|
2020-11-03 00:34:18 +00:00
|
|
|
## Key bindings
|
|
|
|
|
|
|
|
|
|
Key | Action
|
|
|
|
|
-|-
|
2020-11-14 22:38:18 +00:00
|
|
|
`q`, `Ctrl + q` | quit mmtc
|
2020-11-03 00:34:18 +00:00
|
|
|
`r` | toggle repeat
|
|
|
|
|
`R` | toggle random
|
|
|
|
|
`s` | toggle single
|
|
|
|
|
`S` | toggle oneshot
|
|
|
|
|
`c` | toggle consume
|
|
|
|
|
`p` | toggle pause
|
|
|
|
|
`;` | stop
|
|
|
|
|
`h`, `Left` | seek backwards
|
|
|
|
|
`l`, `Right` | seek forwards
|
|
|
|
|
`H` | previous song
|
|
|
|
|
`L` | next song
|
2020-11-04 17:24:39 +00:00
|
|
|
`Enter` | play selected song or quit searching mode if in searching mode
|
2020-11-03 00:34:18 +00:00
|
|
|
`Space` | select current song or the first song in the queue
|
|
|
|
|
`j`, `Down`, `ScrollDown` | go down in the queue
|
|
|
|
|
`k`, `Up`, `ScrollUp` | go up in the queue
|
|
|
|
|
`J`, `PageDown` | jump down in the queue
|
|
|
|
|
`K`, `PageUp` | jump up in the queue
|
2020-11-04 17:24:39 +00:00
|
|
|
`/` | enter searching mode
|
|
|
|
|
`Escape` | quit searching mode and empty query
|
2020-11-03 00:34:18 +00:00
|
|
|
|
|
|
|
|
|
2020-11-03 16:28:42 +00:00
|
|
|
## Configuration
|
|
|
|
|
|
2020-11-07 18:12:06 +00:00
|
|
|
See [Configuration.md]
|
2020-11-03 16:28:42 +00:00
|
|
|
|
|
|
|
|
|
2020-11-02 22:58:54 +00:00
|
|
|
## Changelog
|
|
|
|
|
|
2020-11-07 18:12:06 +00:00
|
|
|
See [CHANGELOG.md]
|
2020-11-03 00:36:38 +00:00
|
|
|
|
|
|
|
|
|
|
|
|
|
[Crate]: https://crates.io/crates/mmtc
|
2020-11-07 18:12:06 +00:00
|
|
|
[Configuration.md]: https://github.com/figsoda/mmtc/blob/main/Configuration.md
|
|
|
|
|
[CHANGELOG.md]: https://github.com/figsoda/mmtc/blob/main/CHANGELOG.md
|
2020-11-13 17:03:37 +00:00
|
|
|
[Rust]: https://www.rust-lang.org/tools/install
|
