mirror of
https://github.com/Emersont1/itchio.git
synced 2026-03-11 08:54:39 +00:00
6b2113a64e
* Fixes an issue prevents writing paths that end in '...' or similar * Add Framework for human readable folder structures * Removed -h argument due to conflict * Game Folders / Files now respond to --human-folders * Update Readme.md to include new argument * Remove -h from arg logic because it's not used and collides with help --------- Co-authored-by: 64Core <webmaster@64core.io>
66 lines
2.2 KiB
Markdown
66 lines
2.2 KiB
Markdown
## IMPORTANT NOTICE: up until 2022-03-09, the package was called itchio, it is now called itchiodl (to avoid pypi conflicts)
|
|
|
|
# Itchio Downloader Tool
|
|
## Install
|
|
```bash
|
|
pip install itchiodl
|
|
```
|
|
## Download All Games in library from account
|
|
**Please Note:** Having too many jobs may cause rate-limiting from some testing 8 works fine but 10 starts giving errors.
|
|
|
|
```bash
|
|
# via python
|
|
python -m itchiodl.downloader
|
|
|
|
# via setup-tools entry point
|
|
itch-download
|
|
```
|
|
|
|
This uses the same API the itchio app uses to download the files. If you have 2FA enabled, generate an API key [here](https://itch.io/user/settings/api-keys) and run the following instead
|
|
|
|
```bash
|
|
# via python (with 4 concurrent downloads)
|
|
python -m itchiodl.downloader --api-key=KEYHERE --jobs=4
|
|
|
|
# via setup-tools entry point
|
|
itch-download -k KEYHERE
|
|
|
|
# download with multiple threads
|
|
itch-download -k KEYHERE -j 4
|
|
|
|
# only download osx or cross platform downloads
|
|
itch-download -p osx
|
|
|
|
# folder structure uses display names for users/publishers and game titles
|
|
itch-download --human-folders
|
|
|
|
```
|
|
|
|
## Add All Games in a bundle to your library
|
|
|
|
```bash
|
|
# via python
|
|
python -m itchiodl.bundle_tool
|
|
|
|
# via setup-tools entry point
|
|
itch-load-bundle
|
|
```
|
|
|
|
This is a bit of a bodge, but it works. It essentially goes through and clicks the "Download" link on every item on the bundle's page, which adds it to your itchio library. It does not download any files. You will need the download page's URL (this will be in the bundle's email, and possibly your purchase history). It will not work with 2FA, and I'm unlikely to be able to fix it without making it far more complicated
|
|
|
|
|
|
## Errors
|
|
if a download fails it will be reported in ```errors.txt``` in the same directory as your downloads
|
|
|
|
An example of which could look something like this:
|
|
```Cannot download game/asset: <Game Name>
|
|
Publisher Name: <Publisher Name>
|
|
Output File: <Publisher Name>/<Game Name>/<Specific Item>
|
|
Request URL: <Some URL>
|
|
Request Response Code: 404
|
|
Error Reason: Not Found
|
|
This game/asset has been skipped please download manually
|
|
---------------------------------------------------------
|
|
```
|
|
|
|
This is not a perfect solution but does prevent the whole process from crashing
|