Github/lowfi
1
0
Fork 0
mirror of https://github.com/talwat/lowfi synced 2025-12-07 23:47:46 +00:00
Code Issues Packages Projects Releases Wiki Activity

chore: merge branch 'main' into rewrite

Browse Source
This commit is contained in:
talwat 2025-12-04 14:00:56 +01:00
commit b36cd89638
3 changed files with 39 additions and 8 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

26
CONTRIBUTING.md Normal file
View File

@ -0,0 +1,26 @@
# Contributing to lowfi
There are a few guidelines outlined here that will make it more likely for your PR to be accepted.
Only ones that are less obvious are going to be listed. If you need to ask, it's probably a no.
## 1. No AI
You can use AI for searching and so on, and if there's something minor and tedious that you'd like
the AI to write then that's okay, but if it is noticable that you used AI then it is way too much.
If you used AI, you aren't helping any maintainer by submitting your slop, it's just a hassle for them.
## 2. Smaller is better
Try and make it so that each PR is one contained feature. Adding multiple features in a PR is usually a bad idea.
This is also so that individual features can be approved or denied, rather than that having to be for a more significant
chunk of code.
## 3. Keep lowfi simple
lowfi is supposed simple program. For now, no changes to the initial user-facing UI will be accepted.
The UI of lowfi playing a song has stayed identical since the first versions, since complicating it
detracts from it's purpose.
More complex features, like fancy colors or cover art, will not be accepted ever. Implementations of
acceptable features should also be simple and not too obtrusive. Even if a feature is simple,
if it is very complex to implement, then it won't be accepted.

17
README.md
View File

@ -69,10 +69,11 @@ cargo install lowfi --features mpris
```
and making sure `$HOME/.cargo/bin` is added to `$PATH`.
Also see [Extra Features](#extra-features) for extended functionality.
### Release Binaries
If you're struggling or unwilling to use cargo, you can just download
If you're struggling or unwilling to use cargo, you can just download the
precompiled binaries from the [latest release](https://github.com/talwat/lowfi/releases/latest).
### AUR
@ -147,14 +148,22 @@ Yeah, that's it.
> Besides its regular controls, lowfi offers compatibility with Media Keys
> and [MPRIS](https://wiki.archlinux.org/title/MPRIS) (with tools like `playerctl`).
>
> MPRIS is currently an optional feature in cargo (enabled with `--features mpris`)
> MPRIS is currently an [optional feature](#extra-features) in cargo (enabled with `--features mpris`)
> due to it being only for Linux, as well as the fact that the main point of
> lowfi is it's unique & minimal interface.
### Bookmarks
Bookmarks are lowfi's extremely simple answer to "what about if I'd like to save a track."
You can bookmark/unbookmark tracks with `b`, and play them with `lowfi -t bookmarks`.
From a technical perspective, your bookmarks are no different to any other track list,
and as such are also stored in the same directory.
### Extra Flags
If you have something you'd like to tweak about lowfi, you use additional flags which
slightly tweak the UI or behaviour of the menu. The flags can be viewed with `lowfi help`.
slightly tweak the UI or behaviour of the menu. The flags can be viewed with `lowfi --help`.
| Flag | Function |
| ----------------------------------- | --------------------------------------------------- |
@ -191,7 +200,7 @@ 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
If you are 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

4
data/chillhop.txt
View File

@ -83,7 +83,6 @@ https://stream.chillhop.com/mp3/
9201!Skyrate
8349!Isla Bella
8303!Indelible
8730!Everydayluvin
9252!Yesorno
9249!Remember
8412!Nomatter
@ -176,7 +175,6 @@ https://stream.chillhop.com/mp3/
8425!Silience
8447!Phase
8548!Fall Down - Instrumental
9262!Fall Down
8551!Fira
8494!Gone Again
8489!Evening Routine
@ -219,7 +217,6 @@ https://stream.chillhop.com/mp3/
8756!Away with the Fairies
8473!Melting Ice
8781!All Us
9372!Love from NGC 7318
8554!Faces
8005!Interstellar
7998!Stay.
@ -1039,7 +1036,6 @@ https://stream.chillhop.com/mp3/
30130!Leaf Contour
30137!Reunion
30141!Repent
30131!Letters
30308!Green Tea
30140!Riverside
31601!Solitude