Skip to content
This repository was archived by the owner on Mar 4, 2026. It is now read-only.

Commit 392917d

Browse files
committed
Update README.md
1 parent 83fe7ac commit 392917d

File tree

1 file changed

+10
-5
lines changed

1 file changed

+10
-5
lines changed

README.md

Lines changed: 10 additions & 5 deletions
Original file line numberDiff line numberDiff line change
@@ -1,10 +1,9 @@
11
# PatreonDownloader
22
A simple command line tool that downloads all media from a Patreon campaign.
33

4-
It's not exactly easy to use, and it's also not supported in any way.
4+
It's not exactly easy to use, but it's explained below.
55

66
## Usage
7-
87
The program needs two pieces of information:
98

109
- The link to the /api/posts page for the creator you want to download the content of. This tells the program where to look for posts.
@@ -19,8 +18,14 @@ To actually get the information:
1918

2019
Once you have the information you can start the program, and give it the information.
2120

22-
The first time you run it, it will create a file in your documents folder called posts.json, which contains the full data of all posts it downloads. At this point it does not yet download media. It is limited to downloading 20 posts at a time, but every page will be added immediately to the file, ensuring safety in the case of an unexpected crash. It will wait ten seconds between each download - this is to prevent your IP getting blocked because you are exceeding the rate limit.
21+
The first time you run it, it will create a folder in your documents folder called PatreonDownloader, and within it, a file called posts.json, which contains the full data of all posts it downloads. At this point it does not yet download media. It is limited to downloading 20 posts at a time, but every page will be added immediately to the file, ensuring safety in the case of an unexpected crash. It will wait ten seconds between each download - this is to prevent your IP getting blocked because you are exceeding the rate limit.
22+
23+
The next time you run it, it will ask you what you want to do with the posts.json file. If you decide to download all images, it will create folders inside Documents/PatreonDownloader for every post, and within each folder, all media that has been downloaded for that post. Each folder will be named according to the date of the post, in YYYY-MM-DD format, and will also include the title of the post. The subfolders will contain the original files that were published, named as they were by the creator.
24+
25+
## External media
26+
The program will also attempt to extract links from posts, and if possible, download the files stored at those links. Currently, only Dropbox links are supported. If you want to download external media from other hosting sites, feel free to submit a PR.
2327

24-
The next time you run it, it will ask you what you want to do with the posts.json file. If you decide to download all images, a folder called "Posts" will be created in your documents folder, and in that folder will be folders for all media that has been downloaded. Each subfolder will be named according to the date of the post, in YYYY-MM-DD format, and will also include the title of the post. The subfolders will contain the original files that were published, named as they were by the creator.
28+
## Contributing
29+
Please stick to existing code conventions when contributing.
2530

26-
Future versions will attempt to download files from Dropbox (and potentially other sites) links found in the content.
31+
To add support for additional external hosting sites, feel free to look at [LinkDownloader.cs](https://github.com/Foxite/PatreonDownloader/blob/master/PatreonDownloader/LinkScraping/LinkDownloader.cs) and [DropboxDownloader.cs](https://github.com/Foxite/PatreonDownloader/blob/master/PatreonDownloader/LinkScraping/DropboxDownloader.cs) to see how it works. When you have a working downloader, add it [here](https://github.com/Foxite/PatreonDownloader/blob/master/PatreonDownloader/Program.cs#L82).

0 commit comments

Comments
 (0)