Files
musyx/README.md
T
Yuriy Panov c4928ae7fe feat: workspace scaffold with iced shell, theme and design system
Two-crate workspace (ym-api for the API client, musyx for the iced app).
The app has the sidebar, top bar, Queue/Lyrics drawer and player bar from
the approved mockup, plus signed-out states for every screen.

- DESIGN.md records the mockup tokens; ui/theme.rs mirrors them for dark
  and light, and the app follows the system appearance
- Bundles Onest/Unbounded (OFL) and Lucide 0.460 icons (ISC)
- Back-stack navigator, player bar toggles (shuffle, repeat, volume, mute)
- snapshot feature renders a screen to PNG via iced's window screenshot
2026-10-15 13:52:55 +06:00

42 lines
1.2 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
```
## 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.
`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`).