GitHub/gamdl
1
0
Fork 0
mirror of https://github.com/glomatico/gamdl.git synced 2026-06-13 12:15:18 +03:00
Code Issues Packages Projects Releases Wiki Activity

Update config options table in README

Browse Source
This commit is contained in:
Rafael Moraes
2025-08-25 14:50:10 -03:00
parent b7ea0aef19
commit bd6310d39b
1 changed files with 42 additions and 42 deletions
Download Patch File Download Diff File Expand all files Collapse all files
README.md
+42 -42
View File
@@ -94,47 +94,47 @@ The config file is created automatically when you run Gamdl for the first time a
Config file values can be overridden using command-line arguments.
| Command-line argument / Config file key | Description | Default value |
| --------------------------------------------------------------- | ---------------------------------------------------------------------------- | ---------------------------- |
| `--disable-music-video-skip` / `disable_music_video_skip` | Don't skip downloading music videos in albums/playlists. | `false` |
| `--save-cover`, `-s` / `save_cover` | Save cover as a separate file. | `false` |
| `--overwrite` / `overwrite` | Overwrite existing files. | `false` |
| `--read-urls-as-txt`, `-r` / - | Interpret URLs as paths to text files containing URLs separated by newlines. | `false` |
| `--save-playlist` / `save_playlist` | Save a M3U8 playlist file when downloading a playlist. | `false` |
| `--synced-lyrics-only` / `synced_lyrics_only` | Download only the synced lyrics. | `false` |
| `--no-synced-lyrics` / `no_synced_lyrics` | Don't download the synced lyrics. | `false` |
| `--config-path` / - | Path to config file. | `<home>/.gamdl/config.json` |
| `--log-level` / `log_level` | Log level. | `INFO` |
| `--no-exceptions` / `no_exceptions` | Don't print exceptions. | `false` |
| `--cookies-path`, `-c` / `cookies_path` | Path to .txt cookies file. | `./cookies.txt` |
| `--language`, `-l` / `language` | Metadata language as an ISO-2A language code (don't always work for videos). | `en-US` |
| `--output-path`, `-o` / `output_path` | Path to output directory. | `./Apple Music` |
| `--temp-path` / `temp_path` | Path to temporary directory. | `./temp` |
| `--wvd-path` / `wvd_path` | Path to .wvd file. | `null` |
| `--nm3u8dlre-path` / `nm3u8dlre_path` | Path to N_m3u8DL-RE binary. | `N_m3u8DL-RE` |
| `--mp4decrypt-path` / `mp4decrypt_path` | Path to mp4decrypt binary. | `mp4decrypt` |
| `--ffmpeg-path` / `ffmpeg_path` | Path to FFmpeg binary. | `ffmpeg` |
| `--mp4box-path` / `mp4box_path` | Path to MP4Box binary. | `MP4Box` |
| `--download-mode` / `download_mode` | Download mode. | `ytdlp` |
| `--remux-mode` / `remux_mode` | Remux mode. | `ffmpeg` |
| `--cover-format` / `cover_format` | Cover format. | `jpg` |
| `--template-folder-album` / `template_folder_album` | Template folder for tracks that are part of an album. | `{album_artist}/{album}` |
| `--template-folder-compilation` / `template_folder_compilation` | Template folder for tracks that are part of a compilation album. | `Compilations/{album}` |
| `--template-file-single-disc` / `template_file_single_disc` | Template file for the tracks that are part of a single-disc album. | `{track:02d} {title}` |
| `--template-file-multi-disc` / `template_file_multi_disc` | Template file for the tracks that are part of a multi-disc album. | `{disc}-{track:02d} {title}` |
| `--template-folder-no-album` / `template_folder_no_album` | Template folder for the tracks that are not part of an album. | `{artist}/Unknown Album` |
| `--template-file-no-album` / `template_file_no_album` | Template file for the tracks that are not part of an album. | `{title}` |
| `--template-file-playlist` / `template_file_playlist` | Template file for the M3U8 playlist. | `Playlists/{playlist_title}` |
| `--template-date` / `template_date` | Date tag template. | `%Y-%m-%dT%H:%M:%SZ` |
| `--exclude-tags` / `exclude_tags` | Comma-separated tags to exclude. | `null` |
| `--cover-size` / `cover_size` | Cover size. | `1200` |
| `--truncate` / `truncate` | Maximum length of the file/folder names. | `null` |
| `--codec-song` / `codec_song` | Song codec. | `aac-legacy` |
| `--synced-lyrics-format` / `synced_lyrics_format` | Synced lyrics format. | `lrc` |
| `--codec-music-video` / `codec_music_video` | Music video codec. | `h264` |
| `--remux-format-music-video` / `remux_format_music_video` | Music video remux format. | `m4v` |
| `--quality-post` / `quality_post` | Post video quality. | `best` |
| `--no-config-file`, `-n` / - | Do not use a config file. | `false` |
| Command-line argument / Config file key | Description | Default value |
| --------------------------------------------------------------- | ---------------------------------------------------------------------------- | -------------------------------------------- |
| `--disable-music-video-skip` / `disable_music_video_skip` | Don't skip downloading music videos in albums/playlists. | false |
| `--read-urls-as-txt`, `-r` / - | Interpret URLs as paths to text files containing URLs separated by newlines | false |
| `--config-path` / - | Path to config file. | <home>/.gamdl/config.json |
| `--log-level` / `log_level` | Log level. | INFO |
| `--no-exceptions` / `no_exceptions` | Don't print exceptions. | false |
| `--cookies-path`, `-c` / `cookies_path` | Path to .txt cookies file. | ./cookies.txt |
| `--language`, `-l` / `language` | Metadata language as an ISO-2A language code (don't always work for videos). | en-US |
| `--output-path`, `-o` / `output_path` | Path to output directory. | ./Apple Music |
| `--temp-path` / `temp_path` | Path to temporary directory. | ./temp |
| `--wvd-path` / `wvd_path` | Path to .wvd file. | null |
| `--overwrite` / `overwrite` | Overwrite existing files. | false |
| `--save-cover`, `-s` / `save_cover` | Save cover as a separate file. | false |
| `--save-playlist` / `save_playlist` | Save a M3U8 playlist file when downloading a playlist. | false |
| `--no-synced-lyrics` / `no_synced_lyrics` | Don't download the synced lyrics. | false |
| `--synced-lyrics-only` / `synced_lyrics_only` | Download only the synced lyrics. | false |
| `--nm3u8dlre-path` / `nm3u8dlre_path` | Path to N_m3u8DL-RE binary. | N_m3u8DL-RE |
| `--mp4decrypt-path` / `mp4decrypt_path` | Path to mp4decrypt binary. | mp4decrypt |
| `--ffmpeg-path` / `ffmpeg_path` | Path to FFmpeg binary. | ffmpeg |
| `--mp4box-path` / `mp4box_path` | Path to MP4Box binary. | MP4Box |
| `--download-mode` / `download_mode` | Download mode. | ytdlp |
| `--remux-mode` / `remux_mode` | Remux mode. | ffmpeg |
| `--cover-format` / `cover_format` | Cover format. | jpg |
| `--template-folder-album` / `template_folder_album` | Template folder for tracks that are part of an album. | {album_artist}/{album} |
| `--template-folder-compilation` / `template_folder_compilation` | Template folder for tracks that are part of a compilation album. | Compilations/{album} |
| `--template-file-single-disc` / `template_file_single_disc` | Template file for the tracks that are part of a single-disc album. | {track:02d} {title} |
| `--template-file-multi-disc` / `template_file_multi_disc` | Template file for the tracks that are part of a multi-disc album. | {disc}-{track:02d} {title} |
| `--template-folder-no-album` / `template_folder_no_album` | Template folder for the tracks that are not part of an album. | {artist}/Unknown Album |
| `--template-file-no-album` / `template_file_no_album` | Template file for the tracks that are not part of an album. | {title} |
| `--template-file-playlist` / `template_file_playlist` | Template file for the M3U8 playlist. | Playlists/{playlist_artist}/{playlist_title} |
| `--template-date` / `template_date` | Date tag template. | %Y-%m-%dT%H:%M:%SZ |
| `--exclude-tags` / `exclude_tags` | Comma-separated tags to exclude. | null |
| `--cover-size` / `cover_size` | Cover size. | 1200 |
| `--truncate` / `truncate` | Maximum length of the file/folder names. | null |
| `--codec-song` / `codec_song` | Song codec. | aac-legacy |
| `--synced-lyrics-format` / `synced_lyrics_format` | Synced lyrics format. | lrc |
| `--codec-music-video` / `codec_music_video` | Comma-separated music video codec priority. | h264,h265 |
| `--remux-format-music-video` / `remux_format_music_video` | Music video remux format. | m4v |
| `--quality-post` / `quality_post` | Post video quality. | best |
| `--no-config-file`, `-n` / - | Do not use a config file. | false |
### Tags variables
@@ -230,8 +230,8 @@ The following variables can be used in the template folders/files and/or in the
- `png`: Lossless format.
- `raw`: Raw cover without processing (requires `save_cover` to save separately).
## Embedding
Gamdl can be used as a library in Python scripts. Here's a basic example of downloading a song by its ID:
```python