wks / tuimodplayer

A text-user-interface module music player using libopenmpt

TUI Mod Player

Q: What would I do if I downloaded the entire ModArchive and don't know what to do with the 100000+ mod files I have?

A: You play them with TUIModPlayer.

TUIModPlayer is a module music (a.k.a. mod) player with a text-based user interface (TUI) written in Rust.

As the name suggests, it uses the tui-rs library to build the UI.

It uses libopenmpt to decode mods. It can play whatever format libopenmpt supports, including but not limited to .mod, .xm, .s3m, .it, .mptm and so on.

How to Use?

Download, Compile and Run

You may need to install libopenmpt using your favourite package managers, for example:

sudo pacman -S libopenmpt

Then clone this repo and build/run.

git clone https://github.com/wks/tuimodplayer.git
cd tuimodplayer
cargo run --release -- /path/to/modarchive_2007_official_snapshot_120000_modules

If you would like to randomise the playlist, add the -s option.

cargo run --release -- /path/to/modarchive_2007_official_snapshot_120000_modules -s

Key Bindings

List available key bindings:

openmpt123 --help-keyboard

Yes. This is intentional. I don't want to surprise those who are used to openmpt123. But there are more:

• r: Toggle repeating. When on, it will repeat the same mod.
• ctrl+L: Redraw screen.

Author

Kunshan Wang <d2tzMTk4NkBnbWFpbC5jb20K>

License

GPLv3