Mirrors/itch-dl
2
0
Fork 0
mirror of https://github.com/DragoonAethis/itch-dl.git synced 2024-12-20 18:11:52 +01:00
Code Issues Packages Projects Releases Wiki Activity

Rename to itch-dl, update readme

Browse Source
This commit is contained in:
Ryszard Knop 2021-10-13 13:55:18 +02:00
parent 4627a863d8
commit d487334258
1 changed files with 18 additions and 8 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

26
README.md
View File

@ -1,6 +1,6 @@
# Itch Jam Downloader
# itch-dl
Downloads all games from a public Itch.io Game Jam.
Bulk download games from [itch.io](https://itch.io/). Currently only supports downloading game jams.
What you'll need:
@ -12,12 +12,9 @@ On Arch, `pacman -S wget python python-requests python-slugify` works.
How to use this:
- Go to your jam's page, ex. https://itch.io/jam/gbcompo21 and right-click -> View Source.
- Ctrl-F for `"id":` - it should find that text once, followed by a number. Write it down.
- (It you found it multiple times, grab the one after ViewJam something something.)
- Download https://itch.io/jam/NUMBER/entries.json (replacing NUMBER with what you wrote down)
- Log into itch.io with the account you'd like to use for downloading.
- Generate a new API key on your user account page: https://itch.io/user/settings/api-keys
- Run the downloader: `python downloader.py --api-key <KEY> entries.json`
- Run the downloader: `python downloader.py --api-key <KEY> https://itch.io/jam/yourjamhere`
- Wait. This is going to take a while.
The downloader is able to grab more or less everything you can download via the itch app.
@ -30,4 +27,17 @@ The downloader also grabs the entry page HTML, which usually comes with controls
does not download images, external assets and so on, just the text - if the Itch page dies,
so will most elements on those downloaded pages. Controls should survive, though.
(There's a pedantic mirroring toggle in the script, if you know what you're doing though.)
(There's a pedantic site mirroring toggle in the script, if you know what you're doing. You will
need wget for that.)
## Cannot extract IDs?
Downloader can parse and download games from a game jam entries JSON file if you want to provide it.
(The script basically automates the steps below, so if it's not able to do the same, please create
an issue!)
- Go to your jam's page, ex. https://itch.io/jam/gbcompo21 and right-click -> View Source.
- Ctrl-F for `"id":` - it should find that text once, followed by a number. Write it down.
- (It you found it multiple times, grab the one after ViewJam something something.)
- Download https://itch.io/jam/NUMBER/entries.json (replacing NUMBER with what you wrote down)