- ym-api wraps yamuse: device-code flow, token refresh, account status, and its own Error type that the UI acts on (expired, denied, network) - Credentials live in the system keychain, never print their tokens, and refresh when within a week of expiry; a rejected token is forgotten - Sign-in screen with code, QR, copy/open-in-browser, countdown and a pasted-token fallback; restoring/unreachable screens on startup - Sidebar account chip and Settings account card with Plus status and sign-out; Settings re-reads the account when opened - Live device-code test behind --ignored
55 lines
2.0 KiB
Markdown
55 lines
2.0 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.
|
|
|
|
## 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.
|
|
|
|
## Licences
|
|
|
|
Musyx is MIT. Onest and Unbounded are OFL (`crates/musyx/assets/fonts`), and Lucide icons
|
|
are ISC (`crates/musyx/assets/icons/LICENSE.txt`).
|