Support for upcoming console cases

MichaelKirsch

Hello guys

im Michael Kirsch and im part of the crew of Kintaro (former Old Skool Tools). Many of you may use our Raspberry Pi Case for your RetroPie Consoles. We are going to release a new case that features a customizable pcb. For this to work i have written a simple python script that is easy to install and i would like to implement it as a driver/experimental package. As this is my first contribution to a open source project im not sure how to implement it (as a driver or a experimental package) and where i have to exactely contribute. I am very happy to hear your feedback and when i posted this into the wrong category or made other mistakes please tell me

MichaelKirsch

Im sorry i forgot to link the github : https://github.com/MichaelKirsch/kintaro_pcb

meleu

@michaelkirsch hello man. I'm not sure about the purpose of your post. Are you asking for help to write a RetroPie scriptmodule?

MichaelKirsch

Hey man . Yes actually i want to make it as easy as possible for the users of retropie to use the case. So yes i would need some help how to write a proper RetroPie scriptmodule

meleu

@michaelkirsch ~~there's no dedicated doc for that~~ (look here: https://retropie.org.uk/api/), but you can learn from the existing code. It's not that hard. Here is an example:
https://github.com/RetroPie/RetroPie-Setup/blob/master/scriptmodules/supplementary/powerblock.sh

BuZz

@michaelkirsch You will need to look at existing modules, and https://retropie.org.uk/api/

MichaelKirsch

@meleu thank you very much for your reply i will read myself into it

MichaelKirsch

@meleu but there is one question left to me: how is the module (once its done ) implemented into retropie and where is it uploaded ?

meleu

@michaelkirsch said in Support for upcoming console cases:

@meleu but there is one question left to me: how is the module (once its done ) implemented into retropie and where is it uploaded ?

Locally it should be placed at $HOME/RetroPie-Setup/scriptmodules/supplementary/SCRIPT_MODULE_NAME.sh. But if you want to make it part of RetroPie-Setup you have to submit a Pull Request to https://github.com/RetroPie/RetroPie-Setup repository.

MichaelKirsch

@meleu thank you very much. I will work towards a pull request for the RetroPie-Setup

MichaelKirsch

@meleu I have written a scriptmodule now. Can i share it here before i make a pull request so we can maybe find some mistakes already. Its working fine here on multiple raspberrys.

meleu

@michaelkirsch sharing here can be a good idea, but you can do as you wish. By the way, just FYI, the man who approves (or not) if your script module will be part of RetroPie-Setup is @BuZz .

MichaelKirsch

@meleu @BuZz here is my working scriptmodule. If there are any mistakes please point them out and i will fix them immediately. Link: https://github.com/MichaelKirsch/kintaro_scriptmodule

meleu

@michaelkirsch some things I noticed at a first glance:

some lines are indented with a tab followed by spaces (lines 45, 50 and 58). This should be fixed to spaces only.
if your driver is for rpi only, you can make the scriptmodule be shown only on rpi installs using some flags. Example:

rp_module_flags="noinstclean !mali !x86"

I think the function remove_kintaropcb should also do those steps to disable the driver (systemctl disable and stop).
I also think you should say what exactly that pcb_1.0.0_armhf.deb installs.

MichaelKirsch

@meleu Thank you for your quick reply. I will do this today

MichaelKirsch

@meleu two questions. Where should i write what the .deb is doing ? And what program do you use to see if something is only indented or tab ? I use gedit on linux and that doesnt show that

meleu

@michaelkirsch said in Support for upcoming console cases:

Where should i write what the .deb is doing ?

Maybe in rp_module_help. You can break lines using \n. Example:

rp_module_help="Kintaro Pcb Driver\n\nThis module installs:\n- file1\n- file2\n- file3..."

And what program do you use to see if something is only indented or tab ?

Mozilla Firefox (look lines 45, 49 and 60):

I use gedit on linux and that doesnt show that

I also opened your file with vim editor and noticed those tabs, maybe your gedit is configured to display tabs as 4 spaces.

MichaelKirsch

@meleu said in Support for upcoming console cases:

rp_module_help="Kintaro Pcb Driver\n\nThis module installs:\n- file1\n- file2\n- file3..."

okay thanks i will do that :)

MichaelKirsch

@meleu yeah seems like gedit is not doing a great job with it i now fixed it within github

meleu

@MichaelKirsch some points

pcb.py into /opt/kintaro could be just the full path: /opt/kintaro/pcb.py. Same thing for kintaro.service.
I can't see why your driver needs doxygen. Is it really necessary?
I'm not sure if it will be part of RetroPie-Setup. Even if not, I think that a scriptmodule is the way to provide an user-friendly way to your customers install/enable your driver. ;-)