Home

Awesome

RetroPie itch.io Godot Scraper

GitHub release (latest by date) GitHub license

RetroPie itch.io Godot Scraper banner

A tool for RetroPie to scrape Godot games hosted on https://itch.io/.

This scraper uses the also open-source itch.io Godot Scraper project, which scrapes all the Godot games hosted on https://itch.io/ and creates an API that can be consumed from the following URL https://itchio-godot-scraper.now.sh/api.

Installation

cd /home/pi/
git clone https://github.com/hiulit/RetroPie-Itchio-Godot-Scraper.git
cd RetroPie-Itchio-Godot-Scraper/
sudo chmod +x setup.sh
sudo chmod +x retropie-itchio-godot-scraper.sh

Updating

cd /home/pi/RetroPie-Itchio-Godot-Scraper/
git pull

🛠ī¸ Setup

You can install the script to be launched from:

You can use the GUI:

./setup.sh

Setup

Or you can use the command line:

./setup.sh {--install | --uninstall} {retropie-menu | scriptmodule}

🚀 Usage

If you don't want to install the script, you can just run it from the downloaded folder.

cd /home/pi/RetroPie-Itchio-Godot-Scraper/
./retropie-itchio-godot-scraper.sh

EmulationStation's RetroPie menu

If you installed the script in EmulationStation's RetroPie menu:

EmulationStation Retropie Menu

RetroPie Setup

If you installed the scriptmodule, first you have to set it up:

Now:

Dialog examples

In both cases you'll end up with a simple dialog, where you can:

Scrape games menu Select games to scrape

Scraping view example

This is how the default EmulationStation theme will look after the scraping.

Scraping view

ℹī¸ Troubleshooting

The scraper can't find a game

Most likely it's because the developer didn't properly* name the game build, but maybe it's because the scrapper does a bad job at finding the games.

See the itch.io Godot Scraper project (which is the API where this scraper takes the data from) to better understand how the scraper works and maybe tell the developer to rename the game so it's scrapable by this script. Or even better, contribute to make it better 😉.

* It's actually not their fault, but the scraper needs a game to be named in some kind of convention to be able to scrape it.

Attributions to the games

This scraper takes all the data from https://itch.io/ and some games have assets (images/videos) that are licensed under various licenses. So, to be as fair as posible, the script adds some files linking to the game's source webpage. These can be located at:

Changelog

See CHANGELOG.

👤 Author

hiulit

🤝 Contributing

Feel free to:

🙌 Supporting this project

If you love this project or find it helpful, please consider supporting it through any size donations to help make it better ❤ī¸.

Become a patron

Suppor me on Ko-Fi

Buy me a coffee

Donate Paypal

If you can't, consider sharing it with the world...

... or giving it a star ⭐ī¸.

Thank you very much!

📝 Licenses