Skip to content

Commit

Permalink
Update documentation
Browse files Browse the repository at this point in the history
  • Loading branch information
m4heshd committed Feb 15, 2024
1 parent ee0d66c commit 06a3270
Show file tree
Hide file tree
Showing 3 changed files with 25 additions and 14 deletions.
1 change: 1 addition & 0 deletions .github/FUNDING.yml
Original file line number Diff line number Diff line change
@@ -1,2 +1,3 @@
github: m4heshd
ko_fi: m4heshd
custom: "https://www.paypal.me/m4heshdtt"
38 changes: 24 additions & 14 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -36,12 +36,13 @@
An open-source video downloader tool for UFC Fight Pass that can run on both desktop and the cloud. The only thing it
can't do is STEAL videos free of charge for you. A paid Fight Pass subscription is required for this tool to work.

### Intellectual property (DISCLAIMER) ⚠️

The UFC logo and the UFC Fight Pass logo used in this project are intellectual properties of Zuffa LLC.

The user will be responsible for any content downloaded through this tool. Any kind of redistribution of that content is
illegal and this application or I (the developer) won't be liable for that.
> [!IMPORTANT]
>### Intellectual property (DISCLAIMER) ⚠️
>
>The UFC logo and the UFC Fight Pass logo used in this project are intellectual properties of Zuffa LLC.
>
>The user will be responsible for any content downloaded through this tool. Any kind of redistribution of that content
> is illegal, and this application or I (the developer) will not be liable for that.
### Dear Dana White,

Expand Down Expand Up @@ -137,22 +138,22 @@ Ripper.
using
the "Fight Pass account" section.
2. Once successfully logged in, copy and paste a link to a UFC Fight Pass video in the "Link" input and hit the download
button.
2. Once successfully logged in, you can search for videos and download them, or copy and paste a link to a UFC Fight
Pass video in the "Link" input and hit the download button.
3. Optionally, look through the configuration to change any download settings (video quality, audio quality, etc..) to
your needs
## Mention-worthy features
### Proxy support
### Advanced search
This might come in handy when you run UFC Ripper as a docker container in the cloud because the service blocks any
requests initiated using a datacenter IP address.
If you have ever used UFC Fight Pass search, you know how difficult it is to find the video you're actually looking for
on there. But not to worry because UFC Ripper supports much more advanced and precise searching of the Fight Pass
library than UFC Fight Pass itself.
If you set up a proxy, UFC Ripper will forward all API requests through that proxy server. Remember, only the API
requests will go through the proxy. Not the downloads. This also means that your proxy server will hardly have to
transfer any data through it.
You can restrict the search algorithm to only look inside the event titles which would result in way more accurate
results, or you can use advanced query syntax like double quotes and negative symbol like you would on Google search.
### Concurrent multi-fragment downloads
Expand All @@ -161,6 +162,15 @@ fragments. This feature allows you to download the given number of fragments con
downloads by the number of allowed concurrent fragment downloads. You can set the amount in the configuration as you
wish.
### Proxy support
This might come in handy when you run UFC Ripper as a docker container in the cloud because the service blocks any
requests initiated using a datacenter IP address.
If you set up a proxy, UFC Ripper will forward all API requests through that proxy server. Remember, only the API
requests will go through the proxy. Not the downloads. This also means that your proxy server will hardly have to
transfer any data through it.
### File numbering
UFC Ripper can automatically number each download incrementally. Let's say you discovered a fighter you haven't watched
Expand Down
Binary file modified project-res/images/ufcr-repo-demo.gif
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.

0 comments on commit 06a3270

Please sign in to comment.