Skip to content

Commit

Permalink
📚 Update documentation
Browse files Browse the repository at this point in the history
- Update packages
- Update FAQ
- Update screenshots
  • Loading branch information
database64128 committed Jul 22, 2020
1 parent df3861b commit 4d1825e
Show file tree
Hide file tree
Showing 6 changed files with 29 additions and 22 deletions.
2 changes: 1 addition & 1 deletion AboutDialog.xaml
Original file line number Diff line number Diff line change
Expand Up @@ -26,7 +26,7 @@
Style="{StaticResource MaterialDesignHeadline6TextBlock}"
TextWrapping="Wrap"
VerticalAlignment="Center">
About - v1.1 Build 20200715
About - v1.2 Build 20200722
</TextBlock>
<TextBlock Grid.Row="1"
Grid.Column="1"
Expand Down
Binary file modified DarkMode.png
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
41 changes: 24 additions & 17 deletions Formats.md
Original file line number Diff line number Diff line change
@@ -1,20 +1,20 @@
# Format Selection Design Goals

## Container Selections (editable):
## Container Selection (editable):

```
- Auto
- .webm
- .mp4
- .mkv
- .opus
- .flac
- .ogg
- .m4a
- .mp3
- webm
- mp4
- mkv
- opus
- flac
- ogg
- m4a
- mp3
```

## Quality Selections (non-editable):
## Format Selection (editable):

```
- Auto
Expand All @@ -31,18 +31,25 @@
- worstvideo
- bestaudio
- worstaudio
- YouTube 4K 60fps HDR webm (337+251)
- YouTube 4K 60fps webm (315+251)
- YouTube 4K 60fps AV1 (401+140)
- YouTube 4K webm (313+251)
- YouTube 1080p60 webm (303+251)
- YouTube 1080p webm (248+251)
- 1080p
- 720p
```

## Generated Format Selection Strings:

- `Auto + bestvideo+bestaudio/best == bestvideo+bestaudio/best`
- `Auto + Custom + 248 + 251 == 248 + 251`
- `.webm + Auto == webm`
- `.webm + bestvideo+bestaudio/best == (bestvideo+bestaudio/best)[ext=webm]`
- `.webm + Custom + 248 + 251 == (248+251)[ext=webm]`
- `.mp4 + Custom + 137 + 140 == 137[ext=mp4]+140[ext=m4a]`
- `Auto + "248+251" == 248+251`
- `webm + Auto == webm`
- `webm + bestvideo+bestaudio/best == (bestvideo+bestaudio/best)[ext=webm]`
- `webm + "248+251" == (248+251)[ext=webm]`
- `mp4 + Custom + "137+140" == 137[ext=mp4]+140[ext=m4a]`

## Rules

- Can select quality and custom formats ONLY WHEN container is `Auto`.
- Can specify custom formats ONLY WHEN quality is `Custom`.
- Can select format ONLY WHEN container is `Auto`.
Binary file modified LightMode.png
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
6 changes: 3 additions & 3 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -31,8 +31,8 @@ A simple GUI wrapper for [`youtube-dl`](https://github.com/ytdl-org/youtube-dl).
- _Q:_ The __Download__ button is grayed out and I can't click it!
- _A:_ `youtube-dl-wpf` is a simple GUI wrapper. It doesn't embed any downloader in it. You have to download `youtube-dl` from the upstream. The `ffmpeg` binary is required by `youtube-dl` when downloading and merging separate video and audio tracks, which is the case for any video resolution higher than 360p.

- _Q:_ How can I specify video and audio tracks to download?
- _A:_ First use the "List Formats" button to ask youtube-dl to list all available formats. To specify the video and audio format, toggle "Override Formats" and fill in the format numbers, as shown in the screenshots above.
- _Q:_ Why can't I specify custom container and custom format at the same time?
- _A:_ Currently `youtube-dl`'s format matching algorithm doesn't handle this very well. And I don't want to see workarounds for it in my code. So it is blocked intentionally to prevent issues.

- _Q:_ How can I use a proxy to download?
- _A:_ Leave the proxy field empty to use system proxy settings. Otherwise the format is similar to how `curl` accepts proxy strings. Examples are, `socks5://localhost:1080/`, `http://localhost:8080/`. Currently the upstream doesn't accept `socks5h` protocol and treat `socks5` as `socks5h` by always resolving the hostname using the proxy. This is tracked in [this issue](https://github.com/ytdl-org/youtube-dl/issues/22618).
Expand Down Expand Up @@ -70,4 +70,4 @@ $ git clone --recursive https://github.com/database64128/youtube-dl-wpf.git

[Material Design Themes](https://github.com/MaterialDesignInXAML/MaterialDesignInXamlToolkit) is licensed under [MIT](https://github.com/MaterialDesignInXAML/MaterialDesignInXamlToolkit/blob/master/LICENSE).

[PeanutButter.TinyEventAggregator](https://github.com/fluffynuts/PeanutButter) is licensed under [BSD-3-Clause License](https://github.com/fluffynuts/PeanutButter/blob/master/LICENSE).
[`PeanutButter.TinyEventAggregator`](https://github.com/fluffynuts/PeanutButter) is licensed under [BSD-3-Clause License](https://github.com/fluffynuts/PeanutButter/blob/master/LICENSE).
2 changes: 1 addition & 1 deletion youtube-dl-wpf.csproj
Original file line number Diff line number Diff line change
Expand Up @@ -22,7 +22,7 @@
</PropertyGroup>

<ItemGroup>
<PackageReference Include="MaterialDesignThemes" Version="3.2.0-ci1773" />
<PackageReference Include="MaterialDesignThemes" Version="3.2.0-ci1779" />
<PackageReference Include="PeanutButter.TinyEventAggregator" Version="1.2.375" />
</ItemGroup>

Expand Down

0 comments on commit 4d1825e

Please sign in to comment.