Skip to content
A simple, network enabled karaoke player in Rust
Branch: master
Clone or download
tarkah Flatten folder structure for release archive
Binary wasn't published to root of archive

Signed-off-by: Cory Forsstrom <cforsstrom18@gmail.com>
Latest commit da4c3dc May 22, 2019
Permalink
Type Name Latest commit message Commit time
Failed to load latest commit information.
ci Update azure-pipelines for cross release May 22, 2019
embed Switch from Rocket to Actix Web May 14, 2019
screenshots Bump to version 0.5.0 May 18, 2019
src
tests/test_data/songs
.gitignore Site setup and working Apr 26, 2019
Cargo.lock Bump to version 0.5.1 May 22, 2019
Cargo.toml Bump to version 0.5.1 May 22, 2019
LICENSE
README.md Bump to version 0.5.0 May 18, 2019
azure-pipelines.yml Flatten folder structure for release archive May 22, 2019
rustfmt.toml Formatted with rustfmt Apr 26, 2019

README.md

karaoke-rs Build Status

A simple, network enabled karaoke player in Rust.

Your karaoke collection can be browsed and queued to the player from a self served website. Currently only supports MP3+G (mp3 & corresponding cdg) files.

Now built off ggez! No more dependency on SFML, the binaries should run out of the box on any system.

Setup

Linux

  • Download latest release binary or compile from source -- cargo build --release
  • Run karaoke-rs --help to see all arguments
  • Place your song collection at ~/.local/share/karaoke-rs/songs, or specify location via --songs path/to/song/directory
  • Default configuration file is created at ~/.config/karaoke-rs/config.yaml. This can be copied / changed and specified via --config path/to/config.yaml

Windows

  • Download latest release binary or compile from source -- cargo build --release
  • Double click karaoke-rs.exe to run with default configuration. Run from command prompt / powershell karaoke-rs.exe --help to see all arguments
  • Place your song collection at %APPDATA%\karaoke-rs\songs, or specify location via --songs C:\path\to\song\directory
  • Default configuration file is created at %APPDATA%\karaoke-rs\config.yaml. This can be copied / changed and specified via --config C:\path\to\config.yaml
  • Ensure all paths supplied via argument are absolute from the root of the applicable drive. Relative paths appear to cause program to crash

TODO

  • Finish setting up configuration file, allow specifying song directory and data directory (for collection db file)
  • Allow passing config file location as argument
  • Bundle website template / static files into build binary, unload them to data path on run, update Rocket to load templates / static files from that path
  • Setup proper logging and error handling

Screenshots

Command Line

cli

Songs Page

songs

Artists Page

artists

Queue Page

queue

Player - background color rainbow cycles

player1

player2

You can’t perform that action at this time.