rshuffle

A dead simple MPD shuffler written in Rust. Inspired by ashuffle.

This shuffler will keep track of which songs have been played and will not play them again until all songs have been played (can be disabled). It can also keep a buffer of songs in the queue to enable crossfading (disabled by default).

Installation

Using Cargo

cargo install rshuffle

From source

git clone https://github.com/campbellcole/rshuffle.git
cd rshuffle
cargo install --path .

Basic Usage

When I use this program I generally run the following command:

rshuffle -p -b 1
#        ^^ ^^^^ keep a buffer of 1 song after the current song to enable crossfade
#        |
#         \ persist the already played songs to a file

This will make sure that crossfade works and that the tracking of already played songs survives restarts.

Usage

$ rshuffle --help
A dead simple MPD shuffler

Usage: rshuffle [OPTIONS] [COMMAND]

Commands:
  completions  Generate shell completions for the provided shell
  help         Print this message or the help of the given subcommand(s)

Options:
  -H, --host <HOST>
          The hostname of the MPD server
          
          [default: 0.0.0.0]

  -P, --port <PORT>
          The port of the MPD server
          
          [default: 6600]

  -b, --num-buffer <NUM_BUFFER>
          The number of additional songs to keep in the playlist after the current song
          
          This is required for crossfade to work
          
          [default: 0]

  -n, --no-tracking
          Don't keep track of which songs have been played

  -p, --persist
          Persist the state of the program across restarts
          
          This is useful if you have a massive music library and you want to listen to each song once over the course of a few days instead of in one sitting.

  -f, --filter <FILTER>
          Only play songs which contain any of these strings in their titles. Can be specified multiple times

  -h, --help
          Print help (see a summary with '-h')

  -V, --version
          Print version

Logging

This project defaults the RUST_LOG environment variable to rshuffle=info. This variable can be changed to e.g. rshuffle=error to only see errors, or to rshuffle=off to disable logging. (See EnvFilter Directives)

MSRV

The minimum supported Rust version for this crate is 1.74.1.

Policy

0.x.y: MSRV can only change when the minor version is incremented (e.g. 0.1.0 -> 0.2.0)
x.y.z: MSRV can only change when the major version is incremented (e.g. 1.0.0 -> 2.0.0)

License

This project is dual-licensed under the MIT and Apache 2.0 licenses. See LICENSE-MIT and LICENSE-APACHE for details.