{"id":13805889,"url":"https://github.com/tarkah/karaoke-rs","last_synced_at":"2025-03-17T10:34:35.771Z","repository":{"id":34785504,"uuid":"181776012","full_name":"tarkah/karaoke-rs","owner":"tarkah","description":"A simple, network enabled karaoke player in Rust","archived":false,"fork":false,"pushed_at":"2022-06-08T22:37:14.000Z","size":6384,"stargazers_count":161,"open_issues_count":10,"forks_count":11,"subscribers_count":4,"default_branch":"master","last_synced_at":"2024-10-15T11:38:09.957Z","etag":null,"topics":["actix-web","glium","karaoke","music","rodio","rust","wasm","yew"],"latest_commit_sha":null,"homepage":"","language":"Rust","has_issues":true,"has_wiki":null,"has_pages":null,"mirror_url":null,"source_name":null,"license":"mit","status":null,"scm":"git","pull_requests_enabled":true,"icon_url":"https://github.com/tarkah.png","metadata":{"files":{"readme":"README.md","changelog":null,"contributing":null,"funding":null,"license":"LICENSE","code_of_conduct":null,"threat_model":null,"audit":null,"citation":null,"codeowners":null,"security":null,"support":null}},"created_at":"2019-04-16T22:20:15.000Z","updated_at":"2024-08-15T11:05:40.000Z","dependencies_parsed_at":"2022-09-15T09:50:45.892Z","dependency_job_id":null,"html_url":"https://github.com/tarkah/karaoke-rs","commit_stats":null,"previous_names":[],"tags_count":21,"template":false,"template_full_name":null,"repository_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/tarkah%2Fkaraoke-rs","tags_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/tarkah%2Fkaraoke-rs/tags","releases_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/tarkah%2Fkaraoke-rs/releases","manifests_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/tarkah%2Fkaraoke-rs/manifests","owner_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners/tarkah","download_url":"https://codeload.github.com/tarkah/karaoke-rs/tar.gz/refs/heads/master","host":{"name":"GitHub","url":"https://github.com","kind":"github","repositories_count":221675311,"owners_count":16861860,"icon_url":"https://github.com/github.png","version":null,"created_at":"2022-05-30T11:31:42.601Z","updated_at":"2022-07-04T15:15:14.044Z","host_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub","repositories_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories","repository_names_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repository_names","owners_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners"}},"keywords":["actix-web","glium","karaoke","music","rodio","rust","wasm","yew"],"created_at":"2024-08-04T01:01:05.976Z","updated_at":"2024-10-27T12:33:56.621Z","avatar_url":"https://github.com/tarkah.png","language":"Rust","funding_links":[],"categories":["Projects"],"sub_categories":[],"readme":"\u003cp align=\"center\"\u003e\n  \u003ca href=\"assets/logo.png\"\u003e\n    \u003cimg src=\"assets/logo.png\" width=\"30%\" /\u003e\n  \u003c/a\u003e\n\u003c/p\u003e\n\u003cp align=\"center\"\u003e\n  A simple, network enabled karaoke player in Rust.\n\u003c/p\u003e\n\u003cp align=\"center\"\u003e\n  \u003ca href=\"https://dev.azure.com/tarkah/karaoke-rs/_build/latest?definitionId=1\u0026branchName=master\"\u003e\n    \u003cimg src=\"https://dev.azure.com/tarkah/karaoke-rs/_apis/build/status/tarkah.karaoke-rs?branchName=master\" /\u003e\n  \u003c/a\u003e\n\u003c/p\u003e\n\n---\n\nYour karaoke collection can be browsed and queued from a self served website and played either natively on your computer, or remotely through any browser. Only supports MP3+G (mp3 \u0026 corresponding cdg) files.\n\n**_Now includes a web player. Songs can be played from any modern browser, anywhere in the world! Use command line flag `--use-web-player` to enable this feature. Player is accessible from the `/player` page on the website and can be controlled just like the native player through commands on the queue page._**\n\n- [Setup](#setup)\n  - [Linux](#linux)\n  - [macOS](#macos)\n  - [Windows](#windows)\n  - [Build from Source](#build-from-source)\n- [CLI Arguments](#cli-arguments)\n- [Screenshots](#screenshots)\n  - [Songs Page](#songs-page)\n  - [Favorites Page](#favorites-page)\n  - [Artists Page](#artists-page)\n  - [Queue Page](#queue-page)\n  - [Player](#player)\n- [Acknowledgments](#acknowledgments)\n\n## Setup\n### Linux\n- Download latest [release](https://github.com/tarkah/karaoke-rs/releases/latest) or build from source\n- Run `karaoke-rs --help` to see all arguments\n- Place your song collection at `~/.local/share/karaoke-rs/songs`, or specify location via `--songs path/to/song/directory`\n- Default configuration file is created at `~/.config/karaoke-rs/config.yaml`. This can be copied / changed and specified via `--config path/to/config.yaml`\n- You may need to force disable vsync to eliminate flickering, set environment variable `vblank_mode=0`\n\n### macOS\n- Download latest [release](https://github.com/tarkah/karaoke-rs/releases/latest) or build from source\n- Run `karaoke-rs --help` to see all arguments\n- Place your song collection at `$HOME/Library/Application Support/karaoke-rs/songs`, or specify location via `--songs path/to/song/directory`\n- Default configuration file is created at `$HOME/Library/Preferences/karaoke-rs/config.yaml`. This can be copied / changed and specified via `--config path/to/config.yaml`\n\n### Windows\n- Download latest [release](https://github.com/tarkah/karaoke-rs/releases/latest) or build from source\n- Double click `karaoke-rs.exe` to run with default configuration. Run from command prompt / powershell `karaoke-rs.exe --help` to see all arguments\n- Place your song collection at `%APPDATA%\\karaoke-rs\\songs`, or specify location via `--songs C:\\path\\to\\song\\directory`\n- 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`\n- Ensure all paths supplied via argument are absolute from the root of the applicable drive. Relative paths appear to cause program to crash\n\n### Build from Source\n- Build frontend\n\nFirst [install wasm-pack](https://rustwasm.github.io/wasm-pack/installer/), then run:\n```sh\ncd frontend\nnpm install\nnpm run build\n```\n- Compile\n```sh\ncd ..\ncargo build --release\n```\n- Binary located at `target/release/karaoke-rs`\n\n## CLI Arguments\n```\nkaroake-rs 0.11.1\ntarkah \u003cadmin@tarkah.dev\u003e\nA simple, network enabled karaoke player in Rust\n\nUSAGE:\n    karaoke-rs [FLAGS] [OPTIONS]\n\nFLAGS:\n    -h, --help              Prints help information\n    -w, --use-web-player    Use web player instead of native player\n    -V, --version           Prints version information\n\nOPTIONS:\n    -c, --config \u003cFILE\u003e                Sets a custom config file\n    -d, --data \u003cDIR\u003e                   Sets a custom data directory\n    -p, --port \u003cPORT\u003e                  Specify website port\n        --port-ws \u003cPORT_WS\u003e            Specify a websocket port when using the web player feature\n    -r, --refresh-collection \u003cBOOL\u003e    Specify if collection should be refreshed on startup [possible values: true,\n                                       false]\n    -s, --songs \u003cDIR\u003e                  Sets a custom song directory\n```\n\n## Screenshots\n\n### Songs Page\n![songs](/screenshots/songs.png?raw=true)\n\n### Favorites Page\n![favorites](/screenshots/favorites.png?raw=true)\n\n### Artists Page\n![artists](/screenshots/artists.png?raw=true)\n\n### Queue Page\n![queue](/screenshots/queue.png?raw=true)\n\n### Player\n![player1](/assets/background.png?raw=true)\n\n![player1](/screenshots/player_1.png?raw=true)\n\n![player2](/screenshots/player_2.png?raw=true)\n\n\n## Acknowledgments\n\n- [@maxjoehnk](https://github.com/maxjoehnk) - Thanks for designing the frontend!\n- [@Keavon](https://github.com/Keavon) - Thanks for helping extensively test the new frontend \u0026 web player!","project_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Ftarkah%2Fkaraoke-rs","html_url":"https://awesome.ecosyste.ms/projects/github.com%2Ftarkah%2Fkaraoke-rs","lists_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Ftarkah%2Fkaraoke-rs/lists"}