mirror of
https://github.com/darkzoul5/YoutubePlaylistSync.git
synced 2026-11-05 07:55:12 +02:00
readme: update confg and dependencies sections
This commit is contained in:
1 parent
0cd693d07a
commit
e8535d335d
1 file changed
+10
-7
@@ -19,21 +19,21 @@ Local-first YouTube playlist synchronization client.
|
|||||||
## Requirements
|
## Requirements
|
||||||
|
|
||||||
- Python 3.10+
|
- Python 3.10+
|
||||||
- `yt-dlp` (pip)
|
- `ffmpeg` (needed for `audio` and `both` modes)
|
||||||
- `ffmpeg` (only needed for audio extraction / "both" mode)
|
|
||||||
|
|
||||||
Install:
|
Quick start:
|
||||||
|
|
||||||
```bash
|
Download the latest release from [releases](https://github.com/darkzoul5/YoutubePlaylistSyncThing/releases) page
|
||||||
pip install -U yt-dlp
|
|
||||||
```
|
|
||||||
|
|
||||||
## Configure
|
## Configure
|
||||||
|
|
||||||
Create/edit `config/yt-playlist-config.json`:
|
On first run, the app will auto-create a default `yt-playlist-config.json` in the project root (if missing).
|
||||||
|
|
||||||
|
Create/edit `yt-playlist-config.json`:
|
||||||
|
|
||||||
```json
|
```json
|
||||||
{
|
{
|
||||||
|
"config_path": null,
|
||||||
"playlists": [
|
"playlists": [
|
||||||
{
|
{
|
||||||
"url": "https://www.youtube.com/playlist?list=YOUR_PLAYLIST_ID",
|
"url": "https://www.youtube.com/playlist?list=YOUR_PLAYLIST_ID",
|
||||||
@@ -45,6 +45,9 @@ Create/edit `config/yt-playlist-config.json`:
|
|||||||
}
|
}
|
||||||
```
|
```
|
||||||
|
|
||||||
|
`config_path` (optional):
|
||||||
|
- If set to a string path, the app loads the config from that file instead (path is relative to the current config file).
|
||||||
|
|
||||||
`download_mode`:
|
`download_mode`:
|
||||||
- `video`: download playlist videos as muxed `.mp4` (no ffmpeg processing)
|
- `video`: download playlist videos as muxed `.mp4` (no ffmpeg processing)
|
||||||
- `audio`: download muxed `.mp4`, extract `.mp3`, delete the `.mp4`
|
- `audio`: download muxed `.mp4`, extract `.mp3`, delete the `.mp4`
|
||||||
|
|||||||
Reference in new issue
Block a user