Developing for retropie-setup

kiro

Hi,

I'm starting to play around with the idea of adding my scraper to retropie setup. So far I've managed to have it installed and running (basing my .sh in scraper.sh). The program runs, but I cannot see the output of my program immediately, it rather shows buffers of output at a time, giving the impression that the program is frozen (it is running in python). Is there anywhere that I can have a look to understand how the output is handled within the retropie-setup context so I manage to fix this? Also, is there any other documentation available apart from what's available on the shell style guide? Thanks!

mitu

@kiro said in Developing for retropie-setup:

Is there anywhere that I can have a look to understand how the output is handled within the retropie-setup context so I manage to fix this?

It's probably caused by the output being buffered by the terminal. A similar issue with Skyscraper was fixed by using stdbuf to disable the buffering - see this commit.

Also, is there any other documentation available apart from what's available on the shell style guide? Thanks!

I wrote a small guide a couple of years ago in this topic that may help you, looking at/cloning and existing module is the easiest way to start writing a new scriptmodule.

kiro

@mitu Hi, thanks, everything seems to be sorted out right now and the script is working, at least on y machine :-)

I know you've probably been asked this several times, but I've looked around with no success, what's the process to get the script into the official retropie-setup repository?

Thanks!

sleve_mcdichael

@kiro said in Developing for retropie-setup:

what's the process to get the script into the official retropie-setup repository?

Are you at all familiar with git? You'll need to clone the repo, make the changes to your local fork, commit them, and then submit a pull request to have them considered for inclusion in the main branch.

kiro

@sleve_mcdichael thanks for that, I'm 'more or less familiar', clone, change, commit, that should be straightforward, how do I actually create a pull request though?

BuZz

@kiro there's plenty of documentation and tutorials for this on the web. Here's one I found:

https://docs.github.com/en/desktop/contributing-and-collaborating-using-github-desktop/working-with-your-remote-repository-on-github-or-github-enterprise/creating-an-issue-or-pull-request

kiro

@BuZz Thx, was looking into that, no worries... thx everyone for the help!

mitu

@kiro said

...
I know you've probably been asked this several times, but I've looked around with no success, what's the process to get the script into the official retropie-setup repository?

The others already mentioned what it takes - just a pull request.

I have a couple of objections about including your scraper in RetroPie:

I'm not comfortable with the fact that's not really a scraper, but just a client for your own cached scraped data, which you take from the actual source site(s) (ScreenScraper, TheGamesDB ? - it's not mentioned anywhere).

This scraper uses its own backend, which has been compiled from many sources on the net and keeps extending. If this is a problem for you, do not run this software.

While some sources allow mirroring of data and re-distribution, they're not mentioned explicitely anywhere in your project.

it has very little testing. Both external scrapers that are integrated with RetroPie-Setup have been used for quite some time before they were added in RetroPie.

kiro

@mitu I guess It is your prerogative. No worries at all. It is the learning process which is the most interesting part, and giving back to the community with no interest in profiting at all.