2.4 KiB
Development
Setup (Windows)
- Node 22+, Rust stable (MSVC), Visual Studio C++ build tools, 7-Zip.
npm ci.\scripts\fetch-libmpv.ps1downloads the shinchirompv-dev-x86_64build (the Windows libmpv builds linked from mpv.io) intovendor/mpv/windows.- Put a
.envin the repository root for the development sign-in:PLEX_SERVER_URL=...andPLEX_TOKEN=.... It is ignored by git and only read by debug builds and the Vite dev server. Never commit or print it. npm run tauri dev
The interface alone runs in a browser with npm run dev (port 1420), which is handy for
layout work; playback, downloads and native dialogs need the desktop app. In development
builds the stores are available as window.__kaleido for debugging.
To drive the desktop app from scripts, start it with
WEBVIEW2_ADDITIONAL_BROWSER_ARGUMENTS=--remote-debugging-port=9333 and attach over the
Chrome DevTools Protocol.
Checks
npm run typecheck
npm test
cargo check --manifest-path src-tauri/Cargo.toml
Playback tests change real Plex progress; resume an in-progress title near its saved position, or restore it afterwards. Selecting audio or subtitle tracks is saved to Plex for that file.
Releases
- Bump the version in
package.json,src-tauri/Cargo.tomlandsrc-tauri/tauri.conf.json. .\scripts\build.ps1builds the NSIS installer and its signed updater artifact. The updater key is read from.tools/updater.key(ignored; keep it safe — replacing it breaks in-app updates for existing installs) or fromTAURI_SIGNING_PRIVATE_KEY.- Commit, tag
vX.Y.Zand push, thennode scripts/publish-release.mjs X.Y.Z [--prerelease]creates the Forgejo release with the installer and its.sig(notes come fromCHANGELOG.md). It readsFORGEJO_TOKEN(repository read/write) from the environment or the ignored.env. node scripts/update-manifest.mjs X.Y.Z https://git.elijahkuntz.com/Elijah/Kaleido-Desktop/releases/download/vX.Y.Z notes.mdand commitupdates/latest.json. Installed copies offer the update on their next start.
For macOS and Linux, build on those systems (scripts/fetch-libmpv.sh, then
npx tauri build) and merge their bundles into the same feed with KALEIDO_BUNDLES.
CI (.forgejo/workflows/release.yml) validates every push and builds installers for
tags on runners for each enabled platform.