Skip to content

Commit

Permalink
Bump to version 0.5.0
Browse files Browse the repository at this point in the history
Changes:
- Switched from SFML to ggez for audio and video. Binaries can now run
out of the box on any platform!
- CI with Azue Pipelines!

Signed-off-by: Cory Forsstrom <cforsstrom18@gmail.com>
  • Loading branch information
tarkah committed May 18, 2019
1 parent 6275125 commit 25e5afc
Show file tree
Hide file tree
Showing 5 changed files with 7 additions and 6 deletions.
2 changes: 1 addition & 1 deletion Cargo.lock

Some generated files are not rendered by default. Learn more about how customized files appear on GitHub.

2 changes: 1 addition & 1 deletion Cargo.toml
@@ -1,6 +1,6 @@
[package]
name = "karaoke-rs"
version = "0.4.0"
version = "0.5.0"
authors = ["Cory Forsstrom <cforsstrom18@gmail.com>"]
edition = "2018"

Expand Down
7 changes: 4 additions & 3 deletions README.md
Expand Up @@ -2,19 +2,20 @@

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. Only tested on Linux and Windows, but pull requests are welcome to get working on OSX.
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](https://github.com/ggez/ggez)! No more dependency on SFML, the binaries should run out of the box on any system._**


## Setup
### Linux
- Install SFML and CSFML bindings to run, required by rust-sfml -- see [link to help setup](https://github.com/jeremyletang/rust-sfml/wiki/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
- 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`
Expand Down
Binary file modified screenshots/cli.png
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
2 changes: 1 addition & 1 deletion src/main.rs
Expand Up @@ -39,7 +39,7 @@ fn main() -> Result<(), failure::Error> {

fn get_config() -> Result<Config, failure::Error> {
let matches = App::new("karoake-rs")
.version("0.4.0")
.version("0.5.0")
.author("Cory F. <cforsstrom18@gmail.com>")
.about("A simple, network enabled karaoke player in Rust")
.arg(
Expand Down

0 comments on commit 25e5afc

Please sign in to comment.