diff --git a/README.md b/README.md index ff31ca5..52dd14e 100644 --- a/README.md +++ b/README.md @@ -7,18 +7,10 @@ It'll do this as simply as it can: no albums, no ads, just lofi. ## Disclaimer -> [!NOTE] -> -> As of the 19th of July 2025, lofigirl.com is temporarily down. If your lowfi is up to date, -> you can follow the [quick instructions](CHILLHOP.md) for using the [chillhop](https://chillhop.com/) alternative track list. -> -> Apologies for the inconvenience, it's out of lowfi's control. +As of the 1.7.0 version of lowfi, **all** of the audio files embedded +by default are from [chillhop](https://chillhop.com/). -**All** of the audio files embedded into in lowfi by default are from [Lofi Girl's](https://lofigirl.com/) website, -under their [licensing guidelines](https://form.lofigirl.com/CommercialLicense). - -If, god forbid, you're planning to use lowfi in a commercial setting, please -follow their rules. + ## Why? @@ -174,44 +166,47 @@ where more information can be found by running `lowfi help scrape`. ### Custom Track Lists -Some nice users, especially [danielwerg](https://github.com/danielwerg), -have aleady made alternative track lists located in the [data](https://github.com/talwat/lowfi/blob/main/data/) -directory of this repo. You can use them with lowfi by using the `--tracks` flag. - -Feel free to contribute your own list with a PR. - -> [!WARNING] +> [!NOTE] +> Some nice users, especially [danielwerg](https://github.com/danielwerg), +> have aleady made alternative track lists located in the [data](https://github.com/talwat/lowfi/blob/main/data/) +> directory of this repo. You can use them with lowfi by using the `--tracks` flag. > -> Custom track lists are going to be pretty particular. -> This is because I still want to keep `lowfi` as simple as possible, -> so custom lists will be very similar to how the built in list functions. -> -> This also means that there will be no added flexibility to these lists, -> so you'll have to work that out on your own. +> Feel free to contribute your own list with a PR. lowfi also supports custom track lists, although the default one from Lofi Girl is embedded into the binary. To use a custom list, use the `--tracks` flag. This can either be a path to some file, or it could also be the name of a file (without the `.txt` extension) in the data -directory, so on Linux it's `~/.local/share/lowfi`. +directory. + +> [!NOTE] +> Data directories: +> +> - Linux - `~/.local/share/lowfi` +> - macOS - `~/Library/Application Support/lowfi` +> - Windows - `%appdata%\Roaming\lowfi` For example, `lowfi --tracks minipop` would load `~/.local/share/lowfi/minipop.txt`. Whereas if you did `lowfi --tracks ~/Music/minipop.txt` it would load from that specified directory. +All tracks must be in the MP3 format, unless lowfi has been compiled with the +`extra-audio-formats` feature which includes support for some others. + #### The Format -In lists, the first line should be the base URL, followed by the rest of the tracks. -This is also known as the "header", because it comes first. +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 +the track. -Each track will be first appended to the base URL, and then the result use to download -the track. All tracks must be in the MP3 format, as lowfi doesn't support any others currently. +> [!NOTE] +> lowfi _will not_ put a `/` between the base & track for added flexibility, +> so for most cases you should have a trailing `/` in your header. -Additionally, lowfi _won't_ put a `/` between the base & track for added flexibility, -so for most cases you should have a trailing `/` in your base url. -The exception to this is if the track name begins with something like `https://`, -where in that case the base will not be prepended to it. +The exception to this is if the track name begins with a protocol like `https://`, +in which case the base will not be prepended to it. If all of your tracks are like this, +then you can put `noheader` as the first line and not have a header at all. For example, in this list: @@ -243,7 +238,7 @@ This is useful if you want to use a local file as the base URL, such as: ```txt file:///home/user/Music/ file.mp3 -file:///home/user/Music/second-file.mp3 +file:///home/user/Other Music/second-file.mp3 ``` Further examples can be found in the [data](https://github.com/talwat/lowfi/tree/main/data) folder. diff --git a/data/lofigirl-new.txt b/data/archive.txt similarity index 100% rename from data/lofigirl-new.txt rename to data/archive.txt diff --git a/data/file.txt b/data/file.txt index 4042c0b..6d63944 100644 --- a/data/file.txt +++ b/data/file.txt @@ -1,2 +1,2 @@ file:///home/user/Music/ -Anomaly.mp3 \ No newline at end of file +Test.mp3 \ No newline at end of file diff --git a/data/noheader.txt b/data/noheader.txt new file mode 100644 index 0000000..285bacd --- /dev/null +++ b/data/noheader.txt @@ -0,0 +1,2 @@ +noheader +https://stream.chillhop.com/mp3/9476 \ No newline at end of file diff --git a/data/lofigirl.txt b/data/old/lofigirl.txt similarity index 100% rename from data/lofigirl.txt rename to data/old/lofigirl.txt diff --git a/data/synthboy.txt b/data/old/synthboy.txt similarity index 100% rename from data/synthboy.txt rename to data/old/synthboy.txt diff --git a/data/sample.txt b/data/sample.txt index affaf3d..64ca88d 100644 --- a/data/sample.txt +++ b/data/sample.txt @@ -1,4 +1,4 @@ https://lofigirl.com/wp-content/uploads/ 2023/06/Foudroie-Finding-The-Edge-V2.mp3 2023/04/2-In-Front-Of-Me.mp3 -https://file-examples.com/storage/fe85f7a43b689349d9c8f18/2017/11/file_example_MP3_1MG.mp3 \ No newline at end of file +https://stream.chillhop.com/mp3/9476 \ No newline at end of file