Giter Club home page Giter Club logo

retropie-itchio-godot-scraper's Introduction

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:

  • EmulationStation's RetroPie menu
  • RetroPie Setup

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:

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

EmulationStation Retropie Menu

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 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:

  • ~/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.

๐Ÿ‘ค 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

retropie-itchio-godot-scraper's People

Contributors

hiulit avatar

Stargazers

 avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar

Watchers

 avatar  avatar  avatar

Forkers

boyquotes

Recommend Projects

  • React photo React

    A declarative, efficient, and flexible JavaScript library for building user interfaces.

  • Vue.js photo Vue.js

    ๐Ÿ–– Vue.js is a progressive, incrementally-adoptable JavaScript framework for building UI on the web.

  • Typescript photo Typescript

    TypeScript is a superset of JavaScript that compiles to clean JavaScript output.

  • TensorFlow photo TensorFlow

    An Open Source Machine Learning Framework for Everyone

  • Django photo Django

    The Web framework for perfectionists with deadlines.

  • D3 photo D3

    Bring data to life with SVG, Canvas and HTML. ๐Ÿ“Š๐Ÿ“ˆ๐ŸŽ‰

Recommend Topics

  • javascript

    JavaScript (JS) is a lightweight interpreted programming language with first-class functions.

  • web

    Some thing interesting about web. New door for the world.

  • server

    A server is a program made to process requests and deliver data to clients.

  • Machine learning

    Machine learning is a way of modeling and interpreting data that allows a piece of software to respond intelligently.

  • Game

    Some thing interesting about game, make everyone happy.

Recommend Org

  • Facebook photo Facebook

    We are working to build community through open source technology. NB: members must have two-factor auth.

  • Microsoft photo Microsoft

    Open source projects and samples from Microsoft.

  • Google photo Google

    Google โค๏ธ Open Source for everyone.

  • D3 photo D3

    Data-Driven Documents codes.