REMU - Terminal Based Music Player

REMU (Rust Enviromental MUsic) is a music player that runs in your terminal. The "Enviromental" part of REMU comes from it's origins. I wanted a music player that I could use to easily switch between playlists as background music for TTRPG games.

Installation

All versions of REMU require a Nerd Font to properly render. The program is usable without one, but you will see invalid characters instead of play symbols.

Unix

You can download the release binary from the releases page.

Windows

you can download the release executable from the releases page.

Building from source

Prerequisites

Rust and Cargo

In order to install Rust and Cargo, run the following commands:

curl --proto '=https' --tlsv1.2 -sSf https://sh.rustup.rs | sh
rustup update

Building

git clone https://github.com/TalonsOfStealth/remu.git
cd remu
cargo build --releases --locked

The binary file should now be remu or remu.exe in remu/target/release/.

Note

REMU has not been tested on any system but Linux. If you run into an issue please report it.

How to use

This section will teach you everything you need to know to use REMU.

Setup

The first time you run REMU, the program will close itself and tell you to set the music_path. You have to go to the config and set music_path to a directory containing your music. REMU will be able to play music in the music_path, and all subdirectories. If you do not see the config file, make sure you run REMU at least once.

Basic Usage

When you open REMU, you should see a screen like this:

REMU   󰑗:




0: ./?????
1: ./?????
2: ./?????
   ...

At the top you can see the title, and three symbols for shuffle, pause/play, and repeat. If there was a file playing, it's path would be displayed right after the play symbols. At the bottom is a list of files and subdirectories in music_path, along with a number, letter, or symbol. If you type one of those characters (case sensitive), it will show that file/directory in the middle, and update the bottom to show that new directory's files and subdirectories. This is how you can look through your files.

If you press enter, REMU will play either the selected file, or a random file in the selected directory (provided one exists). In REMU, directories are treated like "playlists," when in shuffle mode, REMU will play random files in the same directory, but will not play from subdirectories.

Remu has 3 other keybinds:

• Space: to pause or unpause the music.
• CTRL + S: to toggle shuffle mode.
• CTRL + R: to cycle through repeat modes.

Note

If cannot see the play symbols after the name REMU, you likely don't have a Nerd Font installed. Those symbols are used to show the current player status.

Config location

The default config location depends on your system. On a system using XDG, the config will be XDG_CONFIG_HOME/remu/config.toml. On any other system, the config will be at remu_config/config.toml right next to the executable.

Note

Ideally the config gets put in the proper place even without XDG, but every device I have uses XDG so I have no way to test. If you have a device that uses something other that XDG, and you know Rust please consider putting in a pull request.

Supported file types

REMU supports .mp3, .ogg, .wav, .flac, .acc, and .pcm.