Settings & Files

Where things live

Oxidify follows each platform’s conventions. On Linux:

Clearing caches never signs you out; credentials live in state, not cache. Web API token files are written with owner-only permissions. Signing out from Settings deletes both Web API grants and the separate playback credential. The proxy password and YouTube cookies stay until you remove them in Settings.

On macOS, settings, state, and the logs are in ~/Library/Application Support/me.master0ffate.oxidify and the caches in ~/Library/Caches/me.master0ffate.oxidify. On Windows, settings are in %APPDATA%\master0ffate\oxidify\config, state and the logs in %LOCALAPPDATA%\master0ffate\oxidify\data, and the caches in %LOCALAPPDATA%\master0ffate\oxidify\cache.

Fastpotify, the project Oxidify is derived from, kept its files in fastpotify directories next to these. The first run after switching imports settings, sign-ins, skins, and playback credentials from there, once; the old directories are left untouched. An empty fastpotify-imported file in the state directory records that the import ran, so signing out or deleting a file here never brings the Fastpotify copy back.

settings.json

Settings are stored in one readable JSON file and written atomically. UTF-8 files saved with a leading byte order mark by a Windows editor are accepted without resetting preferences. A field with a value Oxidify cannot use falls back to its default while the other fields are kept, and the file as it was is copied to settings.json.bad next to it first. Its main fields are:

Proxy settings

An http proxy covers everything Oxidify asks of the network: catalog and playback control through the Web API, and the audio connection itself. A socks5 proxy covers the Web API, artwork, lyrics and alternate playback; the audio connection (librespot) only tunnels through HTTP, so with socks5 Spotify playback connects directly. The proxy password is never written to settings.json; it lives alone in credentials/proxy-password with owner-only permissions, and only the Web API client carries it. The audio connection (librespot) cannot sign in to a proxy, so an authenticating proxy blocks streaming unless it also accepts anonymous connections.

A changed proxy is picked up the next time Oxidify starts. off ignores environment variables and platform settings; system leaves them in charge. Handing playback to a receiver on the local network always connects to it directly.

Command line

oxidify [OPTIONS]

  --device-name <NAME>  Spotify Connect name for this session
  -v, --verbose         More logs from librespot and the API client

oxidify.log in the state directory is what to attach to a bug report: it contains the last run’s output, including the additional lines printed by oxidify -v. If the app crashed, attach panic.log from the same directory as well.

Demo mode

Builds made with cargo build --features demo accept --demo, which fills the interface with sample data, useful for screenshots, theming, and interface work. Demo mode never writes settings.

--demo-page opens a page, such as home, playlist:pl1, or artist:art0, and --demo-show adds surfaces on top of it: a comma separated list of queue, now-playing, collapsed, grid, green, podcasts, devices, shortcuts, jump, create, light, focus, login, winamp, playlist, and eq.

--demo-shot <PATH> writes the window to a PNG and exits, which is how the screenshots in these pages are made:

cargo run --release --features demo -- \
  --demo-shot docs/screenshot.png --demo-page playlist:pl1 --demo-show now-playing

The shot is the window’s own frame buffer, so it comes out at whatever size the window is. --demo-shot-delay <MS> sets how long cover art has to arrive before the frame is taken.