Build RustMusic from source

The tools you need

RustMusic combines a Rust core (audio engine, decoders, DLNA server, SQLite database) with a SvelteKit interface, brought together by Tauri 2. On all three systems, you need:

• Rust, stable version, installed with rustup (rustup.rs).
• Node.js 20 or later, with npm.
• CMake, used to build libopus for playing Opus files.
• Git, to get the code.

Dependencies for each system

Windows: install the Microsoft C++ Build Tools with the “Desktop development with C++” workload, then CMake. WebView2 is also required; it is already present on up-to-date Windows 10 and 11.

macOS: install the Xcode command line tools, then CMake, for example with Homebrew:

xcode-select --install
brew install cmake

Linux (Debian, Ubuntu): install the build tools and the development libraries for WebKitGTK, GTK, ALSA and PulseAudio:

sudo apt install -y \
  build-essential curl wget file git pkg-config cmake libssl-dev \
  libgtk-3-dev libayatana-appindicator3-dev librsvg2-dev libxdo-dev \
  libwebkit2gtk-4.1-dev libsoup-3.0-dev libjavascriptcoregtk-4.1-dev patchelf \
  libasound2-dev libpulse-dev libdbus-1-dev

Getting the code and building

git clone https://github.com/larevuegeek/rustmusic-desktop.git
cd rustmusic-desktop
npm install

The official configuration also signs the update files with the project’s private key, which you don’t have. Disable this step with a small configuration file at the root of the project, named for example no-updater.json:

{ "bundle": { "createUpdaterArtifacts": false } }

Then start the build, passing it this file:

npm run tauri build -- --config no-updater.json

The first build takes a while: Cargo downloads and compiles all the Rust dependencies. Later builds only recompile what has changed. The packages for your system are written to src-tauri/target/release/bundle/.

Development mode

npm run tauri dev

This command runs RustMusic in development mode: a change to the interface shows up immediately, and a change to the Rust code recompiles and restarts the application. It does not need a signing key.

Finding your way around the code:

• src/: the interface (components, pages, services), with the translations in src/lib/i18n/locales.
• src-tauri/src/core: the audio engine, decoders, DSD and DLNA.
• src-tauri/src/commands: the commands called by the interface.
• src-tauri/src/repository: access to the SQLite database.

Submitting your change

1. 1

   Open an issue

   For a new feature or a large change, describe it first in a GitHub issue. Small fixes (bug, typo, translation) can go straight to a pull request.

2. 2

   Work on your own copy

   Create a copy (fork) of the repository on GitHub, then a branch for your change.

3. 3

   Check your code

   On the Rust side, run cargo fmt and cargo clippy with no new warnings; cargo check must succeed. All visible text goes through the translations and must exist in all five languages.

4. 4

   Open the pull request

   Explain what the change does and why. Commit messages in French are welcome.