shell scripting topic

meleu

/opt/retropie/supplementary/emulationstation/emulationstation.sh

This file will be overwritten after the next ES update. Then, you're right, it's not the best script to tweak...

Is there any way to launch a script either on system's startup or shutdown?

At shutdown it's a bit tricky. I did this for my trick to gracefully finish ES and save metadata in every system shutdown

At start it's pretty simple: /etc/rc.local. And in my opinion your script can safely be placed here but you need to remove that command to show the image in the end.

It's a good place because the script can be setted to run in background (add & in the end of line that is calling your script). I think the current splashscreen to be displayed will be the previous generated one, but your script would be generating a new splash for the next boot. ;-)

hiulit

@meleu I've added the script to etc/rc.local but it seems that there's something wrong with the $home variable. I get this error:

sed: cant' read /root/.emulationstation/es_settings.cfg: No such file or directory

Instead of getting /home/pi as $home, it gets root, so the script doesn't work.

hiulit

@hiulit If I launch the script adding -H -u pi it works, but I don't think it's the best way to do it...

meleu

@hiulit said in shell scripting topic:

@hiulit If a launch the script adding -H -u pi it works, but I don't think it's the best way to do it...

IMHO it's perfectly acceptable and also a really good way to do it. ;-)

Of course if we evolve this method, this config (adding the script call in rc.local) won't be made manually, and then we can get the username to use.

;)

hiulit

@meleu But then, does it make sense to keep using this?

user="$SUDO_USER"
[[ -z "$user" ]] && user="$(id -un)"
home="$(eval echo ~$user)"

Because that's what's getting root as $home when the script is launched in /etc/rc.local.

We could then just do home="/home/pi", don't you think?
Because adding the user -H -u pi like this removes the dynamism of the function (getting the user dynamically), right?

meleu

@hiulit said in shell scripting topic:

@meleu But then, does it make sense to keep using this?
user="$SUDO_USER"
[[ -z "$user" ]] && user="$(id -un)"
home="$(eval echo ~$user)"

Yes. Keeping this in the script makes sense because the user can use it at any moment, right?

Because that's what's getting root as $home when the script is launched in /etc/rc.local.

Does it happen even when using sudo -H -u pi ...???

We could then just do home="/home/pi", don't you think?
Because adding the user -H -u pi like this removes the dynamism of the function (getting the user dynamically), right?

Sorry if I misunderstood you, but you want to avoid to remove dynamism by hardcoding home=/home/pi? Sounds weird for me.

I would consider what we have until now like a proof-of-concept script (kudos to you for working on this). Let's wait what the big boss will say about my proposal and take next steps based on his decision.

If he refuse, we can continue this project extra-officially. I'm just trying to say that what approach to use to launch the script at startup depends on that decision.

cyperghost

@hiulit said in shell scripting topic:

Also, @cyperghost , if I understood you correctly, you though about searching for the font based on the theme's name? (e.g Pixel theme -> pixel.ttf)
Because, for what I see, there isn't a "standardized" naming convention on font naming for themes.
The default to Carbon's font it's nice, yeah! ;)

No, we misunderstood ;)
If the theme CARBON looks like this
./art/font-1.ttf and ./art/font-2.ttf
you can try to use ls *.ttf -R to find all fonts that are in the theme folder.
Then do a grep search with all fonts and give the most usefull hit the path to your $DEFAULT_FONT

Is it clear now? But maybe @meleu gots a better solution. I know it's bad to use lscommand for this action ;)

hiulit

@meleu Ok, you're right! I didn't explain myself clearly, hehe! It sounds weird not wanting to hardcode sudo -H -u pi but wanting to hardcode home="/home/pi" instead :P Nonsense!

Now, I'm at home and I'm testing the script in an actual Raspberry Pi with RetroPie and I have a couple of things to comment:

I've added sudo ~/es-fun-facts-splashscreens/es-fun-facts-splashscreens.sh & and it seems to work when I launch /etc/rc.local from the terminal, but not when the system boots up.
I've tried adding -H -u pi and it doesn't seem to work.

This code worked perfectly! :D I didn't had imagemagick installed on this Raspberri Pi and the warning pop up, nice!

if ! which convert > /dev/null; then
    echo "ERROR: The imagemagick package is not installed!"
    echo "Please, install it with 'sudo apt-get install imagemagick'."
    exit 1
fi

But I didn't had feh installed and the warning didn't pop up :(

if [[ -n "$DISPLAY" ]] && ! which feh  > /dev/null; then
    echo "ERROR: The feh package is not installed!"
    echo "Please, install it with 'sudo apt-get install feh'."
    exit 1
fi

Maybe instead of && it should be || ?
Or maybe remove [[ -n "$DISPLAY" ]] and just leave if ! which feh > /dev/null ?

Anyways, the script works perfectly by itself and when launching /etc/rc.local from the terminal, but not when it's supposed to be launched in /etc.rc.local at startup.

hiulit

@cyperghost Ok, but how would we know which is "the best hit"? Based on what?

cyperghost

@hiulit Well the xml in the root of the theme or keywords like "mainfont=font-1.ttf".... That are just suggestions.

Or you write an identifier.txt so you say: theme, font

# Example file
Carbon, system.ttf
IO, mainfont.ttf

hiulit

@cyperghost don't get me wrong! I really appreciate the feedback :)

I think we can try to find a generic method to get fonts if we squeeze our minds together

hiulit

What do you think about this code?
I want to add a line in /etc/rc.local to launch a script.
Also, I want to check if that line is already in /etc/rc.local.
Additionally, I want to check if /etc/rc.local has the needed exit 0 at the end (in case the user removed it).
The latter is totally optional.

# If the user mistakenly removed "exit 0", add it at the end of "/etc/rc.local".
function check_safe_exit_boot_script() {
    if [[ "$(tail -n1 /etc/rc.local)" != "exit 0" ]]; then
        sed -i -e '$i \exit 0\' "/etc/rc.local"
    fi
}

# Get the line that launches script at boot.
# $SCRIPT_DIR="/home/pi/es-fun-facts-splashscreens".
function check_boot_script() {
    grep "$SCRIPT_DIR" "/etc/rc.local"
}

# Add the line to launch script in "/etc/rc.local"
function add_boot_script() {
    sed -i -e '$i \\n'"$home"'/es-fun-facts-splashscreens/es-fun-facts-splashscreens.sh &\n' "/etc/rc.local"
    check_safe_exit_boot_script
}

# Check if the line that launches the script is already in "/etc/rc.local"
# If it's not, add it.
[[ -z "$(check_boot_script)" ]] && add_boot_script

cyperghost

@hiulit Well I think as setup.sh this is possible. Withwget path/to/your/github/es-funfacts.sh a (half)automated installation shouldbe possible ;)

About the correct font ... there is surly a generic solution. But what about adding just a path to a font via command line parameter?
So you have es-funfacts.sh /path/to/font.ttf

Find automatically the correct font
If 1 fails, try to use Carbon font (as default theme)
If there is a parameter available then 1 and 2 are ignored

hiulit

Hello my fellow nerds! :P

What do you think about this code?

First piece of code is this one:

function is_arm() {
    uname -m | grep -q "arm"
}

I'm trying to detect if the device is arm based. If not, I'm gussing it's x86 based .

And then I'm using this other piece of code to get the screen resolution.
arm based systems and x86based systems have different methods to get the screen resolution. And that's what I've come up with.

function get_screen_resolution_x() {
    if is_arm; then
        fbaset -s | cut -dx -f1
    else
        xdpyinfo | awk -F '[ x]+' '/dimensions:/{print $3}'
    fi
}


function get_screen_resolution_y() {
    if is_arm; then
        fbaset -s | cut -dx -f2
    else
        xdpyinfo | awk -F '[ x]+' '/dimensions:/{print $4}'
    fi
}

mitu

@hiulit If your intention is to detect whether the user is running under a desktop environment (X) or not, then I wouldn't use the architecture of the kernel to determine that, but something more simple like testing if the DISPLAY env is available or something like this.
Running on an ARM board doesn't mean the user's session is not running under Pixel and vice-versa.

meleu

@hiulit said in shell scripting topic:

First of all, we would be able to be more helpful if you say what exactly you want to do. Anyways, here are some thoughts about what you asked...

I'm trying to detect if the device is arm based. If not, I'm gussing it's x86 based .

I would use the system.sh scriptmodule for this or at least get some inspiration from its code.

Example using the existent code:

. $HOME/RetroPie-Setup/scriptmodules/helpers.sh
. $HOME/RetroPie-Setup/scriptmodules/system.sh
get_platform
echo "$__platform"

Or get inspiration from the function starting on this line of code to write your own function.

The $__platform variable is one of these:
rpi1 rpi2 rpi3 odroid-c1 odroid-c2 imx6 odroid-xu tinker x86

(...) get the screen resolution.

I agree with @mitu above.

If your intention is to detect whether the user is running under a desktop environment (X) or not, then I wouldn't use the architecture of the kernel to determine that, but something more simple like testing if the DISPLAY env is available or something like this.

grant2258

probably a useless one but might come in helpful if people dont know use -- in a command line if it has special characters and bash will ignore the special characters.

pi@retropie:~ $ touch -- +1.txt
pi@retropie:~ $ less -- +1.txt
pi@retropie:~ $ less +1.txt
Missing filename ("less --help" for help)

hiulit

Thanks to all! You were very useful :)

Sorry @meleu (and @mitu ) if I wasn't more precise.

The problem I'm facing is that I want to get the screen resolution to create launching images accordingly to that size, but the way I found to get it differs from, for example, my Raspberry Pi (arm) and my VM running Pixel (x86).

I think I like @meleu 's idea of using $__platform.

hansolo77

I'm intrested in developing a script that will generate a custom list for my GameEx High Scoring Competition. GameEx is a frontend I use on my PC, and our forums have created a competition for it's users. I'm actually the primary moderator for that forum. We have a utility for keeping track of scores and generating forum tables. It's all nice and good. I came up with an idea to generate a map file, which allows you to create a "custom list" menu inside GameEx, so you can instantly get into a game that is available for posting high scores with. It works great. I was looking to do something like that for RetroPie too. My PC's keyboard no longer works, and the only way I can use that PC is through RemoteDesktop. However, I have all the games on my Pi, so why can't I just use that?

Here's a breakdown of what I need to accomplish:

Upon turning on the system, as part of the boot process, have a script go out and download the updated list of games from a server. The utility we use to track scores already generates this list and uploads it somewhere, so I just need something to grab it. wget perhaps?
- This may not need to be done during EVERY bootup.. in fact it might not even work if there is no internet available.
- Maybe the script should just be available for manual launching? We only add new games every 2 months now.
After getting the list, it needs edited to work with EmulationStation's custom list features, as by default the list is probably not directly usable.
Save the edited list as a custom list file, in the appropriate folder for EmulationStation to pick it up.

For reservation, here is the map file:
http://gameinfo.hfc-essentials.com/hiscore/HiScore.map

And here is a MAME favorites ini file:
http://gameinfo.hfc-essentials.com/hiscore/HiScore.ini

I'm not sure which file would be easier to work with. But if you look at them, it should be easy enough to figure out the editing that needs to happen. Can detailed editing of the file be done automatically via a script? I wasn't sure so I thought I'd ask here. I also asked our developer of the tool we use to see if he can update the tool to also spit out a plain text list.. Looking to see what can happen, or happens. I'd just like a bit of hand holding, not really asking somebody to step in and do all the work (would be nice but I can't learn scripting without practice!).

What are your suggestions or recommendations?

mitu

@hansolo77 It can be done. This is how I'd do it.

Download the .map file (curl/wget) locally. Should be text only. Check for errors or if the file is empty and exit if so.
Read the file line by line, split it in col1 (zip name) and col2 (game name). For each col1:
- Look in the gamelist for the arcade system to search for col1.zip, either via grep or xmlstarlet. [1]
  The idea is to get the path to the ROM zip file as the value into path
- If you found the path, then check if arcade_folder_path/path exists and if so, add it to a list (list_rom).
- Repeat steps above if your rom might be in a different system (i.e. mame2003-libretro, fba) and nothing was found in the previous step.
At the end, walk over list_rom and produce a custom collection file in $HOME/.emulationstation/collections/custom-GameEx.cfg containing one line for each ROM path in the list. If a previous .cfg fie exists, back it up.

You should have to create the collection before running the script so you can choose in ES to make it visible, but once ES knows to show it, I think you only need to restart ES after each script run.

The above assumes you only have arcade ROMs, since the naming is standard. Make sure to lowecase the col1 in step 2 (I've seen that TMNT is uppercase, but the zip name should be lowercase and

[1] - get the path of rom using xmlstarlet and ROM name.

$ xmlstarlet sel -t -v "//game[contains(path,'1943.zip')]/path" .emulationstation/gamelists/arcade/gamelist.xml 
# outputs: 
 ./1943.zip