Skip to content
Closed
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension


Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
164 changes: 156 additions & 8 deletions Cargo.lock

Some generated files are not rendered by default. Learn more about how customized files appear on GitHub.

9 changes: 6 additions & 3 deletions Cargo.toml
Original file line number Diff line number Diff line change
Expand Up @@ -25,7 +25,6 @@ mpris = ["dep:mpris-server", "dep:arc-swap"]
media-controls = ["dep:souvlaki", "dep:windows"]
extra-audio-formats = ["rodio/default"]
scrape = [
"dep:serde",
"dep:serde_json",
"dep:html-escape",
"dep:scraper",
Expand All @@ -38,6 +37,8 @@ clap = { version = "4.5.61", features = ["derive", "cargo"] }
eyre = "0.6.12"
fastrand = "2.4.1"
thiserror = "2.0.18"
figment = { version = "0.10.19", default-features = false, features = ["env", "toml"] }
serde = { version = "1.0.228", features = ["derive"] }

# Async
tokio = { version = "1.52.3", features = ["macros", "rt", "fs", "io-util", "sync", "time"], default-features = false }
Expand All @@ -60,12 +61,14 @@ unicode-segmentation = "1.12.0"
url = { version = "2.5.8", default-features = false }

# Scraper
serde = { version = "1.0.228", features = ["derive"], optional = true }
serde_json = { version = "1.0.150", optional = true }
scraper = { version = "0.27.0", optional = true }
html-escape = { version = "0.2.13", optional = true }
indicatif = { version = "0.18.4", optional = true }

[dev-dependencies]
figment = { version = "0.10.19", default-features = false, features = ["env", "toml", "test"] }

[target.'cfg(target_os = "linux")'.dependencies]
libc = "0.2.186"

Expand All @@ -76,4 +79,4 @@ windows = { version = "0.62", optional = true, features = [
"Win32_Graphics_Gdi",
"Win32_System_LibraryLoader",
"Win32_UI_WindowsAndMessaging",
] }
] }
25 changes: 23 additions & 2 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -184,14 +184,35 @@ slightly tweak the UI or behavior of the menu. The flags can be viewed with `low
| `-c`, `--clock` | Include a clock |
| `-p`, `--paused` | Start lowfi paused |
| `-f`, `--fps` | FPS of the UI [default: 12] |
| `--timeout` | Timeout in seconds for music downloads [default: 3] |
| `--timeout` | Timeout in seconds for music downloads [default: 16] |
| `-d`, `--debug` | Include ALSA & other logs meant for debugging |
| `-w`, `--width <WIDTH>` | Width of the player, from 0 to 32 [default: 3] |
| `-w`, `--width <WIDTH>` | Player width, capped at 32 [default: 3] |
| `-t`, `--track-list <TRACK_LIST>` | Use a [custom track list](#custom-track-lists) |
| `-s`, `--buffer-size <BUFFER_SIZE>` | Internal song buffer size [default: 5] |

If you need something even more specific, see [ENVIRONMENT_VARS](./docs/ENVIRONMENT_VARS.md).

### Configuration

Save persistent settings in an optional `config.toml` in Lowfi's platform data
directory. Include only the values you want to change, for example:

```toml
[playback]
paused = true

[ui]
fps = 20

[bindings]
next = ["x"]
```

Settings resolve from defaults, then the file, then `LOWFI_*` environment
variables, then explicit CLI flags. Restart Lowfi to pick up file changes.
See [Configuration](docs/CONFIGURATION.md) for file locations, every option and
default, environment syntax, binding rules, and validation errors.

### Extra Features

lowfi uses cargo/rust's "feature" system to make certain parts of the program optional,
Expand Down
Loading