A cross platform, local music player that is an offline(no streaming) version of muzik. This app allows you to listen to music that is stored on your local machine, that being music in mp3, wav, ogg and flac format.
- muzik-offline
- Table of Contents
- I am a user/tester
- Usage
- I am a developer
- Node modules used
- Rust libraries used
- Navigate to the releases tab and find the latest app release for your operating system.
- Download it and install and enjoy the application
- Please read the usage section for some extra information.
- Also note that you can report bugs/issues or make feature requests
- Some shortcuts include
SPACE- Pause/Play musicCTRL/CMD+SHIFT+F- Open/Close settingsCTRL/CMD+S- Focus on search barCTRL/CMD+I- Show song infoUPorDOWN- scroll song by songLEFTorRIGHT- seek by fixed valueCTRL/CMD+PorENTER- Play the selected songCTRL/CMD+SHIFT+A- Add to playlistCTRL/CMD+SHIFT+L- Play laterCTRL/CMD+SHIFT+N- Play Next
- Download the pre-requisites for tauri only by following the pre-requisites page for your operating system.
- If you are on linux OS(debian/ubuntu), run
sudo apt-get install libasound2-dev
- Clone this repo, specifically the main-app-dev branch
- run
cd muzik-offline/muzik-offline
- run
npm install
- This project uses discord rpc, so you will need a client id, otherwise the code won't compile
- To get a client id, setup a new application on discord developer portal and then place your client id in an
.envfile in the src-tauri directory - The env file should look like this:
DISCORD_CLIENT_ID=<Your client id goes here>
- If you are on linux/macos or any unix based OS, please navigate to tauri.config.json and under the
windowsobject, change thedecorationsproperty totrue - run
npm run tauri dev
- Clone the releases branch. It is the most stable and ready to go branch
- Before you create a build, you will have to embed any env variables into the rust code otherwise the application will panic if you try to run it. The env variables are only meant to be used in the development cycle.
- To embed the env variables, copy your
DISCORD_CLIENT_IDfrom the.envfile. - Go to discord_rpc.rs and comment out these snippets of code:
3 -> use dotenv::dotenv;
4 -> use std::env;
15 -> //get client id from env variables
16 -> dotenv().ok();
17 -> let client_id = env::var("DISCORD_CLIENT_ID").expect("DISCORD_CLIENT_ID env variable not set");
- In this snippet of code
let client: DiscordIpcClient = DiscordIpcClient::new(&client_id)?;, replace&client_idwith"<Your client id goes here>" - You can also remove the dotnev crate by just removing that line of code.
- If you want to go back to dev, you will have to undo all the steps above.
- If you want to create a production build, run
npm run tauri build
- If you want to create a debug production build(one where you have access to devtools), run
npm run tauri build -- --debug
Please note that when you run npm run tauri dev, npm run tauri build or npm run tauri build -- --debug for the first time, it may take a lengthy amount of minutes to compile everything. However this only occurs just on your first run. In subsequent runs, it will be faster.
React
Typescript
Django
Laravel
Facebook
Microsoft
Google
Alibaba
D3
Tencent