mirror of
https://github.com/talwat/lowfi
synced 2025-09-27 10:50:02 +00:00
docs: update feature list and fix some wording
This commit is contained in:
parent
8f837302c3
commit
e702c1de00
37
README.md
37
README.md
@ -13,15 +13,12 @@ by default are from [chillhop](https://chillhop.com/). Read
|
|||||||
|
|
||||||
## Why?
|
## Why?
|
||||||
|
|
||||||
I really hate modern music platforms, and I wanted a small, "suckless"
|
I really hate modern music platforms, and I wanted a small, simple
|
||||||
app that would just play random lofi without video.
|
app that would just play random ambient music without video and other fluff.
|
||||||
|
|
||||||
It was also designed to be fairly resilient to inconsistent networks,
|
Beyond that, it was also designed to be fairly resilient to inconsistent networks,
|
||||||
and as such it buffers 5 whole songs at a time instead of parts of the same song.
|
and as such it buffers 5 whole songs at a time instead of parts of the same song.
|
||||||
|
|
||||||
See [Scraping](#scraping) if you're interested in downloading the tracks.
|
|
||||||
Beware, there's a lot of them.
|
|
||||||
|
|
||||||
## Installing
|
## Installing
|
||||||
|
|
||||||
> [!NOTE]
|
> [!NOTE]
|
||||||
@ -154,13 +151,31 @@ slightly tweak the UI or behaviour of the menu. The flags can be viewed with `lo
|
|||||||
| `-t`, `--track-list <TRACK_LIST>` | Use a [custom track list](#custom-track-lists) |
|
| `-t`, `--track-list <TRACK_LIST>` | Use a [custom track list](#custom-track-lists) |
|
||||||
| `-s`, `--buffer-size <BUFFER_SIZE>` | Internal song buffer size [default: 5] |
|
| `-s`, `--buffer-size <BUFFER_SIZE>` | Internal song buffer size [default: 5] |
|
||||||
|
|
||||||
### Scraping
|
### Extra Features
|
||||||
|
|
||||||
lowfi also has an optional `scrape` command enabled by the `scrape` feature.
|
lowfi uses cargo/rust's "feature" system to make certain parts of the program optional,
|
||||||
|
like those which are only expected to be used by a handful of users.
|
||||||
|
|
||||||
|
#### `scrape` - Scraping
|
||||||
|
|
||||||
|
This feature provides the `scrape` command.
|
||||||
It's usually not very useful, but is included for transparency's sake.
|
It's usually not very useful, but is included for transparency's sake.
|
||||||
|
|
||||||
More information can be found by running `lowfi help scrape`.
|
More information can be found by running `lowfi help scrape`.
|
||||||
|
|
||||||
|
#### `mpris` - MPRIS
|
||||||
|
|
||||||
|
Enables MPRIS. It's not rocket science.
|
||||||
|
|
||||||
|
#### `extra-audio-formats` - Extra Audio Formats
|
||||||
|
|
||||||
|
This is only relevant to those using a custom track list, in which case
|
||||||
|
it allows for more formats than just MP3. Those are FLAC, Vorbis, and WAV.
|
||||||
|
|
||||||
|
These should be sufficient for some 99% of music files people might want to play.
|
||||||
|
If you dealing with the 1% using another audio format which is in
|
||||||
|
[this list](https://github.com/pdeljanov/Symphonia?tab=readme-ov-file#codecs-decoders), open an issue.
|
||||||
|
|
||||||
### Custom Track Lists
|
### Custom Track Lists
|
||||||
|
|
||||||
> [!NOTE]
|
> [!NOTE]
|
||||||
@ -194,7 +209,7 @@ All tracks must be in the MP3 format, unless lowfi has been compiled with the
|
|||||||
#### The Format
|
#### The Format
|
||||||
|
|
||||||
In lists, the first line is what's known as the header, followed by the rest of the tracks.
|
In lists, the first line is what's known as the header, followed by the rest of the tracks.
|
||||||
Each track will be first appended to the header, and then use that to download
|
Each track will be first appended to the header, and then use the combination to download
|
||||||
the track.
|
the track.
|
||||||
|
|
||||||
> [!NOTE]
|
> [!NOTE]
|
||||||
@ -229,8 +244,8 @@ For example, if you had an entry like this:
|
|||||||
|
|
||||||
Then lowfi would download from the first section, and display the second as the track name.
|
Then lowfi would download from the first section, and display the second as the track name.
|
||||||
|
|
||||||
You can also prepend `file://` to the header track name, which will make lowfi treat it as a local file.
|
`file://` can be used in front a track/header to make lowfi treat it as a local file.
|
||||||
This is useful if you want to use a local file as the base URL, such as:
|
This is useful if you want to use a local file as the base URL, for example:
|
||||||
|
|
||||||
```txt
|
```txt
|
||||||
file:///home/user/Music/
|
file:///home/user/Music/
|
||||||
|
@ -121,8 +121,8 @@ pub async fn scrape() -> eyre::Result<()> {
|
|||||||
const IGNORED_TRACKS: [u32; 20] = [
|
const IGNORED_TRACKS: [u32; 20] = [
|
||||||
// 404
|
// 404
|
||||||
74707, // Lyrics
|
74707, // Lyrics
|
||||||
21655, 21773, 8172, 55397, 75135, 24827, 8141, 8157, 64052, 31612, 41956, 8001, 9217, 55372,
|
21655, 21773, 8172, 55397, 75135, 24827, 8141, 8157, 64052, 31612, 41956, 8001, 9217,
|
||||||
// Abnormal
|
55372, // Abnormal
|
||||||
8469, 7832, 10448, 9446, 9396,
|
8469, 7832, 10448, 9446, 9396,
|
||||||
];
|
];
|
||||||
|
|
||||||
|
Loading…
x
Reference in New Issue
Block a user