Building from source
Prisme is a Rust workspace (the engine and the application) with an Angular interface, put together by Tauri. The same commands build it on Windows, macOS and Linux; the Android package is built by the project’s CI.
What you need
Section titled “What you need”On every system:
- Rust, through rustup. The repository pins its version in
rust-toolchain.toml: rustup installs that one by itself the first time you build. - Node.js 24 and pnpm, for the interface.
- Python 3: the setup script fetches with it the libclang the bindings of the C++ libraries are generated with.
- The Tauri command line, version 2:
cargo install tauri-cli --version "^2", or run it withnpx @tauri-apps/cli@2in place ofcargo tauribelow.
Then, for each system:
Windows 10 or 11, with the Microsoft C++ build tools that Rust uses on Windows. The ASIO SDK is downloaded by the build itself.
macOS 13.3 or later, with the Xcode command line tools (xcode-select --install).
A C++ compiler and the libraries of the web view, ALSA and JACK. On Debian and Ubuntu:
sudo apt install build-essential libwebkit2gtk-4.1-dev libgtk-3-dev libxdo-dev \ libssl-dev libayatana-appindicator3-dev librsvg2-dev libasound2-dev \ libjack-jackd2-dev libudev-devBuild and run
Section titled “Build and run”-
Get the code:
Terminal window git clone https://github.com/Shawiizz/prisme.gitcd prisme -
Install the development tools that are not Rust crates:
Terminal window scripts\setup-dev.ps1Terminal window scripts/setup-dev.shThe script puts libclang in
.tools/libclang, inside the repository, where.cargo/config.tomlpoints the build to, then installs the interface’s packages (pnpm installinfrontend). -
Run the tests:
Terminal window cargo test --workspace -
Start the application:
Terminal window cd apps/prisme-desktopcargo tauri devTauri starts the interface’s development server (
pnpm startinfrontend, on port 4200), builds the application and opens it. A change to the interface shows at once; a change to the Rust code rebuilds and restarts the application.
Start in a known state
Section titled “Start in a known state”While you develop, a few environment variables start Prisme without clicking:
| Variable | |
|---|---|
PRISME_DECK1 … PRISME_DECK4 |
An audio file to load on that deck at start. |
PRISME_SIMULATE=1 |
Start with the simulated turntable on deck 1: vinyl control without a turntable. |
PRISME_MASTER_GAIN |
The master gain at start, such as 0.2 to try things quietly. |
PRISME_DATA_DIR |
A folder for the settings and the library, in place of your own. |
PRISME_MUSIC_DIR |
A music folder, in place of your own. |
PRISME_FAKE_SPLIT |
Pretend there is a second screen under the window, its top this many pixels down (560, or 560@0.8 with its scale): to try the two-screen layout on one screen. |
Check your changes
Section titled “Check your changes”The CI runs these on Windows, Linux and macOS for every pull request; run them before you push:
cd frontendpnpm exec prettier --check srcpnpm exec ng test --watch=falsepnpm buildcd ..cargo fmt --all --checkcargo clippy --workspace --all-targets -- -D warningscargo test --workspaceChanging the actions of the interface, or a controller profile, also changes files the tests compare: see The files beside the profiles.
Make the packages
Section titled “Make the packages”cd apps/prisme-desktopcargo tauri buildThe packages land in target/release/bundle:
| System | Package |
|---|---|
| Windows | An installer (NSIS), installed for the current user. |
| Linux | A .deb and an AppImage. |
| macOS | The .app and a .dmg. |
For a Mac build that runs on both Apple and Intel processors, add both targets and build the universal one:
rustup target add aarch64-apple-darwin x86_64-apple-darwincargo tauri build --target universal-apple-darwinA build runs on systems as old as the one it was made on: the project builds its Linux packages on Ubuntu 22.04 for that reason.
On Linux, Prisme plays through ALSA, or through JACK (PipeWire’s included) for the lowest latency.
Android and iOS
Section titled “Android and iOS”The Android package is built by the Mobile workflow on GitHub, for a tag such as mobile-1.2.3 or on demand: a signed APK for 64-bit ARM phones, attached to a draft release. To build it yourself, follow that workflow (.github/workflows/mobile.yml): Java 21, the Android SDK and its NDK, the Rust target aarch64-linux-android, the NDK’s headers given to the bindings, then:
cd apps/prisme-desktopcargo tauri android build --apk --target aarch64A release APK is signed with the key named in apps/prisme-desktop/gen/android/keystore.properties, which stays out of the repository.
The iOS build is only checked: the same workflow compiles it and starts it in the iPhone simulator. There is no iOS release.
Releasing
Section titled “Releasing”-
Set the new version in the workspace’s
Cargo.toml([workspace.package] version). -
Push a tag with that version, such as
0.2.0. The CI builds the packages of the three systems and their signed update packages, and attaches them to a draft release. -
Publish the draft: the installed copies then offer the update.
The Package workflow, run on demand, builds the same packages without the update packages, starts each build once and keeps a screenshot and its logs: a way to see a build start on a system you do not have at hand.