Skip to content
This repository has been archived by the owner on Jan 31, 2024. It is now read-only.

Commit

Permalink
improve readme
Browse files Browse the repository at this point in the history
  • Loading branch information
@Avnsx
Avnsx authored May 27, 2023
1 parent 1ba2261 commit 0469619
Showing 1 changed file with 54 additions and 25 deletions.
79 changes: 54 additions & 25 deletions README.md
View file
Original file line number Diff line number Diff line change
@@ -1,7 +1,44 @@
## 👋 Introducing `Fansly Downloader`: The Ultimate Fansly Content Downloading App
![Downloads](https://img.shields.io/github/downloads/Avnsx/fansly-downloader/total?color=0078d7&label=🔽%20Downloads.exe&style=flat-square) ![Compatibility](https://img.shields.io/static/v1?style=flat-square&label=%F0%9F%90%8D%20Python&message=3.6%2B&color=blue) ![Stars](https://img.shields.io/github/stars/Avnsx/fansly-downloader?style=flat-square&label=⭐%20Stars&color=ffc83d)

![UI Banner](https://i.imgur.com/EhL42m3.jpg)
## 👋 Introducing `Fansly Downloader`: The Ultimate Content Downloading App

<div align="center">
<a href="https://github.com/Avnsx/fansly-downloader/releases/latest">
<img src="https://img.shields.io/github/downloads/Avnsx/fansly-downloader/total?color=0078d7&label=%F0%9F%94%BD%20Downloads&style=flat-square" alt="Downloads" />
</a>
<a href="https://github.com/Avnsx/fansly-downloader/releases/latest">
<img src="https://img.shields.io/github/v/release/Avnsx/fansly-downloader?color=%23b02d4a&display_name=tag&label=%F0%9F%9A%80%20Latest%20Compiled%20Release&style=flat-square" alt="Latest Release" />
</a>
<a href="https://github.com/Avnsx/fansly-downloader/commits/main">
<img src="https://img.shields.io/github/commits-since/Avnsx/fansly-downloader/latest?color=orange&label=%F0%9F%92%81%20Uncompiled%20Commits&style=flat-square" alt="Commits since latest release" />
</a>
<a href="https://github.com/Avnsx/fansly-downloader/issues?q=is%3Aissue+is%3Aopen+label%3Abug">
<img src="https://img.shields.io/github/issues-raw/Avnsx/fansly-downloader/bug?color=pink&label=%F0%9F%A6%84%20Known%20Bugs&style=flat-square" alt="Known Bugs" />
</a>
<a href="https://www.python.org/downloads/">
<img src="https://img.shields.io/static/v1?style=flat-square&label=%F0%9F%90%8D%20Python&message=3.6%2B&color=3c8c50" alt="Compatibility" />
</a>
<a href="https://github.com/Avnsx/fansly-downloader/stargazers">
<img src="https://img.shields.io/github/stars/Avnsx/fansly-downloader?style=flat-square&label=%E2%AD%90%20Stars&color=ffc83d" alt="Stars" />
</a>
</div>

<div align="center">
<a href="https://github.com/Avnsx/fansly-downloader/releases/latest">
<img src="https://img.shields.io/badge/Compatible with-grey?style=flat-square" alt="Compatible with text" />
</a>
<a href="https://github.com/Avnsx/fansly-downloader/releases/latest">
<img src="https://img.shields.io/badge/%F0%9F%AA%9F-Windows-0078D6?style=flat-square" alt="Compatible with Windows" />
</a>
<a href="https://github.com/Avnsx/fansly-downloader/releases/latest">
<img src="https://img.shields.io/badge/%F0%9F%90%A7-Linux-FCC624?style=flat-square" alt="Compatible with Linux" />
</a>
<a href="https://github.com/Avnsx/fansly-downloader/commits/main">
<img src="https://img.shields.io/badge/%E2%9A%AA-macOS-000000?style=flat-square" alt="Compatible with macOS" />
</a>
</div>



![Fansly Downloader UI Banner](https://i.imgur.com/bxZonNp.gif)

Fansly Downloader is the go-to app for all your bulk media downloading needs. Download photos, videos or any other media from Fansly, this powerful tool has got you covered! Say goodbye to the hassle of individually downloading each piece of media – now you can download them all or just some, with just a few clicks.

Expand All @@ -14,28 +51,23 @@ Fansly Downloader is the go-to app for all your bulk media downloading needs. Do
</td>
</tr>
<tr>
<td align="middle"></td>
<td align="middle"></td>
<td align="middle"></td>
</tr>
<tr>
<td align="middle">
<td align="middle" nowrap>
<strong>📥 Download Modes</strong>
<hr>
<ul align="left">
<li>Bulk: Timeline, Messages, Collection</li>
<li>or specific Single Posts by post ID</li>
</ul>
</td>
<td align="middle">
<td align="middle" nowrap>
<strong>♻️ Updates</strong>
<hr>
<ul align="left">
<li>Easily update prior download folders</li>
<li>App keeps itself up-to-date with fansly</li>
</ul>
</td>
<td align="middle">
<td align="middle" nowrap>
<strong>🖥️ Cross-Platform Compatibility</strong>
<hr>
<ul align="left">
Expand All @@ -45,23 +77,23 @@ Fansly Downloader is the go-to app for all your bulk media downloading needs. Do
</td>
</tr>
<tr>
<td align="middle">
<td align="middle" nowrap>
<strong>⚙️ Customizability</strong>
<hr>
<ul align="left">
<li>Separate media into sub-folders?</li>
<li>Want to download previews?</li>
</ul>
</td>
<td align="middle">
<td align="middle" nowrap>
<strong>🔎 Deduplication</strong>
<hr>
<ul align="left">
<li>Downloads only unique content</li>
<li>resulting in less bandwidth usage</li>
</ul>
</td>
<td align="middle">
<td align="middle" nowrap>
<strong>💸 Free of Charge</strong>
<hr>
<ul align="left">
Expand All @@ -72,7 +104,6 @@ Fansly Downloader is the go-to app for all your bulk media downloading needs. Do
</tr>
</table>


<img src="https://i.imgur.com/fj0sjQy.png" alt="Computer Mouse Icon" width="23" height="23">[Configuration Settings in detail](https://github.com/Avnsx/fansly-downloader/wiki/Explanation-of-provided-programs-&-their-functionality#4-configini)

[Detailed description on each of the components of this software](https://github.com/Avnsx/fansly-downloader/wiki/Explanation-of-provided-programs-&-their-functionality)<img src="https://i.imgur.com/iIsCcGU.png" alt="Computer Mouse Icon" width="20" height="20">
Expand All @@ -85,7 +116,7 @@ Fansly Downloader is the go-to app for all your bulk media downloading needs. Do
On windows you can just install the [Executable version](https://github.com/Avnsx/fansly-downloader/releases/latest), skip the entire set up section & go to [Quick Start](https://github.com/Avnsx/fansly-downloader#-quick-start)

#### Requirements
If you intend to use the Python source directly, please ensure that [Python is installed](https://www.python.org/downloads/) on your system. Once Python is installed, you can proceed by installing the following requirements using [Python's package manager](https://realpython.com/what-is-pip/) within your systems terminal type:
If your operating system is not compatible with **executable versions** of Fansly Downloader (only Windows supported for ``.exe``) or just generally intend to use the Python source directly, please ensure that [Python is installed](https://www.python.org/downloads/) on your system. Once Python is installed, you can proceed by installing the following requirements using [Python's package manager](https://realpython.com/what-is-pip/), within your systems terminal type:

pip install requests loguru imagehash pillow python-dateutil psutil keyboard av m3u8 pycryptodome "undetected_chromedriver==3.4.6" "pywin32; platform_system == 'Windows'"
Alternatively you can use [``requirements.txt``](https://github.com/Avnsx/fansly-downloader/blob/main/requirements.txt) through opening your system's terminal (e.g.: cmd.exe) and navigating to the project's download folder & executing the following command: ``pip install --user -r requirements.txt``
Expand All @@ -96,9 +127,9 @@ If you are on windows and can't install the windows only library called ``pywin3
**Quick start is only compatible with Windows & you have to have recently logged into fansly in any of the following browsers: Chrome, FireFox, Opera, Brave or Microsoft Edge and that browser has to be [set as your default browser in windows settings](https://www.avast.com/c-change-default-browser-windows#:~:text=Open%20the%20Start%20menu%20and,is%20the%20current%20default%20browser).**

1. Make sure the browser you set as default browser [in windows settings](https://www.avast.com/c-change-default-browser-windows#:~:text=Open%20the%20Start%20menu%20and,is%20the%20current%20default%20browser), is also the browser that you've browsed fansly with in the past
2. Click on Automatic Configurator and wait for it [to do its thing](https://github.com/Avnsx/fansly-downloader/wiki/Explanation-of-provided-programs-&-their-functionality#2-automatic-configurator)
3. If it was successful(``config.ini`` should now *only* show a *single* ``ReplaceMe`` the targeted creator name) open the ``config.ini`` file and replace the value for ``[TargetedCreator]`` > ``Username =`` with whatever content creator you wish to have scraped
4. Save the ``config.ini`` file(into the same directory as Fansly Downloader) with the changes you've done to it, close it & then start up Fansly Downloader by clicking on it
2. Click on Automatic Configurator and wait for it [to do its thing](https://github.com/Avnsx/fansly-downloader/wiki/Explanation-of-provided-programs-&-their-functionality#2-automatic-configurator) (if it was successful ``config.ini`` should now *only* show a *single* ``ReplaceMe`` for the targeted creator name)
3. Open the ``config.ini`` file and replace the value for ``[TargetedCreator]`` > ``Username =`` with whatever content creators username
4. Save the ``config.ini`` file(into the same directory as Fansly Downloader) with the changes you've done to it, close it & start up Fansly Downloader by clicking on it

**⚠️ If you are not using Windows or are encountering a bug with quick start please head over to [Get Started](https://github.com/Avnsx/fansly-downloader/wiki/Get-Started) instead ⚠️**

Expand All @@ -114,7 +145,7 @@ Do you have any unanswered questions or want to know more about Fansly Downloade
**A**: Star the project and I'll think about it. Otherwise you could always [open a pull request](https://github.com/Avnsx/fansly-downloader/pulls)

+ **Q**: "Will you add any payment bypassing features to Fansly Downloader?"
**A**: No, as the intention of this repository is not to harm fansly
**A**: No, as the intention of this repository is not to harm fansly or its content creators

## 🤝 Contributing to `Fansly Downloader`
Any kind of positive contribution is welcome! Please help it grow by contributing to the project.
Expand All @@ -126,14 +157,12 @@ The currently most needed changes are:
Please open a [open a pull request](https://github.com/Avnsx/fansly-downloader/pulls)!

## 🙏 Support
+ As this is not a commercialised product, please give this project a star(⭐️) to encourage further development
+ Please give this project a star(⭐️) to encourage further development

+ Maximise your support for Fansly Downloader by recommending it to others online 🌍

## 🛡️ License
This project (including executables) is licensed under the GPL-3.0 License - see the [`LICENSE`](LICENSE) file for details.

## Disclaimer
"Fansly" or [fansly.com](https://fansly.com/) is operated by Select Media LLC as stated on their "Contact" page. This repository and the provided content in it isn't in any way affiliated with, sponsored by, or endorsed by Select Media LLC or "Fansly". The developer(referred to: "Avnsx" in the following) of this code is not responsible for the end users actions, no unlawful activities of any kind are being encouraged. Statements and processes described in this repository only represent best practice guidance aimed at fostering an effective software usage. The repository was written purely for educational purposes, in an entirely theoretical environment. Thus, any information is presented on the condition that the developer of this code shall not be held liable in no event to you or anyone else for any direct, special, incidental, indirect or consequential damages of any kind, or any damages whatsoever, including without limitation, loss of profit, loss of use, savings or revenue, or the claims of third parties, whether the developer has advised of the possibility of such loss, however caused and on any theory of liability, arising out of or in connection with the possession, use or performance of this software. The material embodied in this repository is supplied to you "as-is" and without warranty of any kind, express, implied or otherwise, including without limitation, any warranty of fitness. Finally it is important to note that this GitHub repository is the sole branch maintained and owned by the developer and any third-party websites or entities are in no way affiliated with Fansly Downloader, either directly or indirectly. This disclaimer is preliminary and is subject to revision.
##
Written with python on Windows 11
"Fansly" or [fansly.com](https://fansly.com/) is operated by Select Media LLC as stated on their "Contact" page. This repository and the provided content in it isn't in any way affiliated with, sponsored by, or endorsed by Select Media LLC or "Fansly". The developer(referred to: "Avnsx" in the following) of this code is not responsible for the end users actions, no unlawful activities of any kind are being encouraged. Statements and processes described in this repository only represent best practice guidance aimed at fostering an effective software usage. The repository was written purely for educational purposes, in an entirely theoretical environment. Thus, any information is presented on the condition that the developer of this code shall not be held liable in no event to you or anyone else for any direct, special, incidental, indirect or consequential damages of any kind, or any damages whatsoever, including without limitation, loss of profit, loss of use, savings or revenue, or the claims of third parties, whether the developer has advised of the possibility of such loss, however caused and on any theory of liability, arising out of or in connection with the possession, use or performance of this software. The material embodied in this repository is supplied to you "as-is" and without warranty of any kind, express, implied or otherwise, including without limitation, any warranty of fitness. This code does not bypass any paywalls & no end user information is collected during usage. Finally it is important to note that this GitHub repository is the sole branch maintained and owned by the developer and any third-party websites or entities are in no way affiliated with Fansly Downloader, either directly or indirectly. This disclaimer is preliminary and is subject to revision.

0 comments on commit 0469619

Please sign in to comment.