RetroPie-Itchio-Godot-Scraper

KO | EN

gitlite — search

#react #ai #llm #golang #machine-learning #linux #docker #macos #windows #vue #awesome-list #ios #openai #open-source

RetroPie-Itchio-Godot-Scraper

(★ 15)

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

RetroPie-Itchio-Godot-Scraper Latest Version Download

Download Latest Version (.zip)

// repository documentation

Was this content helpful?

★ 0 (0 ratings)

# RetroPie itch.io Godot Scraper

[![GitHub release (latest by date)](https://img.shields.io/github/v/release/hiulit/RetroPie-Itchio-Godot-Scraper?style=flat-square)](https://github.com/hiulit/RetroPie-Itchio-Godot-Scraper/releases)
[![GitHub license](https://img.shields.io/github/license/hiulit/RetroPie-Itchio-Godot-Scraper?style=flat-square)](https://github.com/hiulit/RetroPie-Itchio-Godot-Scraper/blob/master/LICENSE)

![RetroPie itch.io Godot Scraper banner](https://raw.githubusercontent.com/hiulit/RetroPie-Itchio-Godot-Scraper/master/retropie-itchio-godot-scraper-banner.jpg)

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

This scraper uses the also open-source [itch.io Godot Scraper](https://github.com/hiulit/itchio-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:

- EmulationStation's RetroPie menu
- RetroPie Setup

You can use the GUI:

```
./setup.sh
```

![Setup](https://raw.githubusercontent.com/hiulit/RetroPie-Itchio-Godot-Scraper/master/examples/setup.png)

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:

- Enter EmulationStation.
- Go to the RetroPie menu.
- Select **itch.io Godot Scraper** to launch the script.

![EmulationStation Retropie Menu](https://raw.githubusercontent.com/hiulit/RetroPie-Itchio-Godot-Scraper/master/examples/emulationstation-retropie-menu.png)

### RetroPie Setup

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

- Run `sudo /home/pi/RetroPie-Setup/retropie_setup.sh`.
- Select **Manage packages**.
- Select **Manage optional packages**.
- Select **itchio-godot-scraper**.
- Select **Install from source**.

Now:

- Run `sudo /home/pi/RetroPie-Setup/retropie_setup.sh`.
- Select **Configuration / tools**.
- Select **itchio-godot-scraper** to launch the script.

### Dialog examples

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

- Select games to scrape.
- Scrape all games.
- Delete scrapings.

![Scrape games menu](https://raw.githubusercontent.com/hiulit/RetroPie-Itchio-Godot-Scraper/master/examples/scrape-games-menu.png)
![Select games to scrape](https://raw.githubusercontent.com/hiulit/RetroPie-Itchio-Godot-Scraper/master/examples/select-games-to-scrape.png)

## Scraping view example

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

![Scraping view](https://raw.githubusercontent.com/hiulit/RetroPie-Itchio-Godot-Scraper/master/examples/scraping-view.png)

## ℹ️ 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](https://github.com/hiulit/itchio-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:

* `~/RetroPie/roms/godot-engine/000_GAME_ATTRIBUTIONS_000.txt`
* `~/RetroPie/roms/godot-engine/images/000_IMAGE_ATTRIBUTIONS_000.txt`
* `~/RetroPie/roms/godot-engine/videos/000_VIDEO_ATTRIBUTIONS_000.txt`

## Changelog

See [CHANGELOG](/CHANGELOG.md).

## 👤 Author

**hiulit**

- Twitter: [@hiulit](https://twitter.com/hiulit)
- GitHub: [@hiulit](https://github.com/hiulit)

## 🤝 Contributing

Feel free to:

- [Open an issue](https://github.com/hiulit/cross-compile-godot-raspberry-pi/issues) if you find a bug.
- [Create a pull request](https://github.com/hiulit/cross-compile-godot-raspberry-pi/pulls) if you have a new cool feature to add to the project.
- [Start a new discussion](https://github.com/hiulit/cross-compile-godot-raspberry-pi/discussions) about a feature request.

## 🙌 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](https://img.shields.io/badge/Become_a_patron-ff424d?logo=Patreon&style=for-the-badge&logoColor=white)](https://www.patreon.com/hiulit)

[![Suppor me on Ko-Fi](https://img.shields.io/badge/Support_me_on_Ko--fi-F16061?logo=Ko-fi&style=for-the-badge&logoColor=white)](https://ko-fi.com/F2F7136ND)

[![Buy me a coffee](https://img.shields.io/badge/Buy_me_a_coffee-FFDD00?logo=buy-me-a-coffee&style=for-the-badge&logoColor=black)](https://www.buymeacoffee.com/hiulit)

[![Donate Paypal](https://img.shields.io/badge/PayPal-00457C?logo=PayPal&style=for-the-badge&label=Donate)](https://www.paypal.com/paypalme/hiulit)

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

[![](https://img.shields.io/badge/Share_on_Twitter-1DA1F2?style=for-the-badge&logo=twitter&logoColor=white)](https://twitter.com/intent/tweet?url=https%3A%2F%2Fgithub.com%2Fhiulit%2Fcross-compile-godot-raspberry-pi&text=Cross-compile+Godot+binaries+for+the+Raspberry+Pi%3A%0D%0AA+script+to+easily+cross-compile+Godot+binaries+for+the+Raspberry+Pi+from+Linux+x86_64+by+%40hiulit)

... or giving it a [star ⭐️](https://github.com/hiulit/cross-compile-godot-raspberry-pi/stargazers).

Thank you very much!

## 📝 Licenses

- Source code: [MIT License](/LICENSE).

RetroPie-Itchio-Godot-Scraper

RetroPie-Itchio-Godot-Scraper Latest Version Download

Today's picks

Was this content helpful?

Recent Feedback

RetroPie-Itchio-Godot-Scraper

RetroPie-Itchio-Godot-Scraper Latest Version Download

Today's picks

Was this content helpful?

Recent Feedback

Download README