Files
musyx/README.md
T
2026-10-15 18:15:27 +06:00

89 lines
3.3 KiB
Markdown

# Musyx
A desktop player for Yandex Music, written in Rust with [iced](https://iced.rs).
Musyx is an unofficial client. It talks to the same undocumented API the official apps use,
and it isn't affiliated with or endorsed by Yandex.
## Layout
- `crates/ym-api`: the Yandex Music API client, with no UI dependencies.
- `crates/musyx`: the iced app (screens, widgets, player, theme).
- `design/mockup.html`: the approved design. `DESIGN.md` records its tokens.
## Run
```sh
cargo run -p musyx
```
### Sign-in
Musyx signs in with Yandex's device flow. It shows a code, you confirm it at the page Yandex
names (or scan the QR code), and the app picks up the token on its own. You can also paste an
existing OAuth token. The token is kept in the system keychain (service `musyx`, account
`yandex-music`) and refreshed when it is within a week of expiring. Signing out deletes it.
Sign-in uses the public OAuth client id of the official Android app (through
[`yamuse`](https://crates.io/crates/yamuse)), because the music API doesn't accept
third-party apps. On macOS an unsigned dev build may ask for keychain access again after
each rebuild, because the keychain ties access to the binary's signature.
## Install on macOS
```sh
tool/bundle-macos.sh --install
```
This builds a release `Musyx.app` into `target/release/bundle/`, signed with the
`Developer ID Application` certificate of team `H33L24BGUH` and the hardened runtime. With
`--install`, it also copies the app to `/Applications`. The icon comes from
`crates/musyx/assets/icon/musyx.png`, which `tool/make_icon.py` draws. Set
`MUSYX_SIGN_IDENTITY` to sign with another identity, or to `-` for an ad-hoc signature
(each ad-hoc build is a new code identity, so macOS asks again for keychain access).
## Settings
Settings (streaming quality, appearance, volume) are kept in
`~/Library/Application Support/Musyx/settings.json`. Covers are cached under
`~/Library/Caches/Musyx/covers` and can be cleared from Settings.
## Check
```sh
cargo clippy --workspace --all-targets -- -D warnings
cargo test --workspace
```
Snapshot mode renders one screen to a PNG through iced's own screenshot, so it needs no
screen-recording permission:
```sh
MUSYX_SNAPSHOT=design/shots/home.png MUSYX_SNAPSHOT_ROUTE=home MUSYX_SNAPSHOT_THEME=dark \
cargo run -p musyx --features snapshot
```
`MUSYX_SNAPSHOT_ROUTE` takes home, wave, search, collection, podcasts, settings or signin. Every
route except signin renders with a sample signed-in account, so no network or keychain is needed.
`MUSYX_SNAPSHOT_DRAWER` takes queue or lyrics. `MUSYX_SNAPSHOT_THEME` takes light or dark.
`MUSYX_SNAPSHOT_LIVE=1` signs in with the account stored in the keychain instead of using sample
data. Set `MUSYX_SNAPSHOT_DELAY` (ms) to wait longer for slow pages.
`cargo run -p musyx --example api_probe` calls the discovery endpoints with the stored account
(read-only) and prints what came back.
### Tracing
`MUSYX_TRACE=1 cargo run -p musyx` logs each user action (not playback ticks or cover loads)
to stderr, followed by what's playing and the next three tracks.
### Audio
`cargo run -p musyx --example audio_probe` lists the output devices and checks that each one
opens. Use it when the player bar says no sound output was found.
## Licences
Musyx is MIT. Onest and Unbounded are OFL (`crates/musyx/assets/fonts`), and Lucide icons
are ISC (`crates/musyx/assets/icons/LICENSE.txt`).