From d487334258020168203eff052c105def914d74ed Mon Sep 17 00:00:00 2001 From: Ryszard Knop Date: Wed, 13 Oct 2021 13:55:18 +0200 Subject: [PATCH] Rename to itch-dl, update readme --- README.md | 26 ++++++++++++++++++-------- 1 file changed, 18 insertions(+), 8 deletions(-) diff --git a/README.md b/README.md index 10261dd..2a7e6c2 100644 --- a/README.md +++ b/README.md @@ -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 entries.json` +- Run the downloader: `python downloader.py --api-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)