You signed in with another tab or window. Reload to refresh your session.You signed out in another tab or window. Reload to refresh your session.You switched accounts on another tab or window. Reload to refresh your session.Dismiss alert
{{ message }}
This repository was archived by the owner on Mar 4, 2026. It is now read-only.
Copy file name to clipboardExpand all lines: README.md
+10-5Lines changed: 10 additions & 5 deletions
Display the source diff
Display the rich diff
Original file line number
Diff line number
Diff line change
@@ -1,10 +1,9 @@
1
1
# PatreonDownloader
2
2
A simple command line tool that downloads all media from a Patreon campaign.
3
3
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.
5
5
6
6
## Usage
7
-
8
7
The program needs two pieces of information:
9
8
10
9
- 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:
19
18
20
19
Once you have the information you can start the program, and give it the information.
21
20
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.
23
27
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.
25
30
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