2021-10-13 13:55:18 +02:00
|
|
|
# itch-dl
|
2021-10-02 03:05:29 +02:00
|
|
|
|
2021-10-13 13:55:18 +02:00
|
|
|
Bulk download games from [itch.io](https://itch.io/). Currently only supports downloading game jams.
|
2021-10-02 03:05:29 +02:00
|
|
|
|
|
|
|
|
What you'll need:
|
|
|
|
|
|
|
|
|
|
- Python 3.8+
|
|
|
|
|
- `pip install -r requirements.txt`
|
2021-10-03 03:49:49 +02:00
|
|
|
- For site mirroring, [wget](https://www.gnu.org/software/wget/) in your PATH.
|
2021-10-02 03:05:29 +02:00
|
|
|
|
2021-10-03 03:49:49 +02:00
|
|
|
On Arch, `pacman -S wget python python-requests python-slugify` works.
|
2021-10-02 03:05:29 +02:00
|
|
|
|
|
|
|
|
How to use this:
|
|
|
|
|
|
2021-10-13 13:55:18 +02:00
|
|
|
- Log into itch.io with the account you'd like to use for downloading.
|
2021-10-03 03:49:49 +02:00
|
|
|
- Generate a new API key on your user account page: https://itch.io/user/settings/api-keys
|
2021-10-13 13:55:18 +02:00
|
|
|
- Run the downloader: `python downloader.py --api-key <KEY> https://itch.io/jam/yourjamhere`
|
2021-10-02 03:05:29 +02:00
|
|
|
- Wait. This is going to take a while.
|
|
|
|
|
|
2021-10-03 03:49:49 +02:00
|
|
|
The downloader is able to grab more or less everything you can download via the itch app.
|
2021-10-02 03:05:29 +02:00
|
|
|
|
|
|
|
|
It's expected that the downloader output will not be complete - logs are stupidly verbose and
|
|
|
|
|
it prints a report on successful/failed downloads, so you must manually grab whatever was not
|
|
|
|
|
handled for you automatically for some reason.
|
|
|
|
|
|
|
|
|
|
The downloader also grabs the entry page HTML, which usually comes with controls and such. It
|
|
|
|
|
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.
|
2021-10-03 03:49:49 +02:00
|
|
|
|
2021-10-13 13:55:18 +02:00
|
|
|
(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)
|
