RetroDECK/retrodeck.sh

#!/bin/bash

source /app/bin/global.sh

# We moved the lockfile in /var/config/retrodeck in order to solve issue #53 - Remove in a few versions
if [ -f "$HOME/retrodeck/.lock" ]
then
  mv "$HOME/retrodeck/.lock" $lockfile
fi

# Functions area

dir_prep() {
    # This script is creating a symlink preserving old folder contents and moving them in the new one
    
    # Call me with:
    # dir prep "real dir" "symlink location"
    real="$1"
    symlink="$2"

    echo -e "\n[DIR PREP]\nMoving $symlink in $real" #DEBUG

    # if the dest dir exists we want to backup it
    if [ -d "$symlink" ];
    then
      echo "$symlink found" #DEBUG
      mv -fv "$symlink" "$symlink.old"
    fi

    # if the real dir doesn't exist we create it
    if [ ! -d "$real" ];
    then
      echo "$real not found, creating it" #DEBUG
      mkdir -pv "$real"
    fi
    
    # creating the symlink
    echo "linking $real in $symlink" #DEBUG
    mkdir -pv "$(dirname "$symlink")" # creating the full path except the last folder
    ln -sv "$real" "$symlink"

    # moving everything from the old folder to the new one, delete the old one
    if [ -d "$symlink.old" ];
    then
      echo "Moving the data from $symlink.old to $real" #DEBUG
      mv -fv "$symlink".old/* $real
      echo "Removing $symlink.old" #DEBUG
      rm -rf "$symlink.old"
    fi

    echo -e "$symlink is now $real\n"
}

tools_init() {
    rm -rfv /var/config/retrodeck/tools/
    mkdir -pv /var/config/retrodeck/tools/
    cp -r /app/retrodeck/tools/* /var/config/retrodeck/tools/
    mkdir -pv /var/config/emulationstation/.emulationstation/custom_systems/tools/
    cp /app/retrodeck/tools-gamelist.xml /var/config/retrodeck/tools/gamelist.xml
}

standalones_init() {
    # This script is configuring the standalone emulators with the default files present in emuconfigs folder
    
    echo "----------------------"
    echo "Initializing standalone emulators"
    echo "----------------------"

    # Yuzu
    echo "----------------------"
    echo "Initializing YUZU"
    echo "----------------------"
    # removing dead symlinks as they were present in a past version
    if [ -d $rdhome/bios/switch ]; then
      find $rdhome/bios/switch -xtype l -exec rm {} \;
    fi
    # initializing the keys folder
    dir_prep "$rdhome/bios/switch/keys" "/var/data/yuzu/keys"
    # initializing the firmware folder
    dir_prep "$rdhome/bios/switch/registered" "/var/data/yuzu/nand/system/Contents/registered"
    # configuring Yuzu
    dir_prep "$rdhome/.logs/yuzu" "/var/data/yuzu/log"
    mkdir -pv /var/config/yuzu/
    cp -fvr $emuconfigs/yuzu/* /var/config/yuzu/
    sed -i 's#~/retrodeck#'$rdhome'#g' /var/config/yuzu/qt-config.ini
    dir_prep "$rdhome/screenshots" "/var/data/yuzu/screenshots"

    # Dolphin
    echo "----------------------"
    echo "Initializing DOLPHIN"
    echo "----------------------"
    mkdir -pv /var/config/dolphin-emu/
    cp -fvr "$emuconfigs/dolphin/"* /var/config/dolphin-emu/
    sed -i 's#~/retrodeck#'$rdhome'#g' /var/config/dolphin-emu/Dolphin.ini
    dir_prep "$rdhome/saves/gc/dolphin/EUR" "/var/data/dolphin-emu/GC/EUR"
    dir_prep "$rdhome/saves/gc/dolphin/USA" "/var/data/dolphin-emu/GC/USA"
    dir_prep "$rdhome/saves/gc/dolphin/JAP" "/var/data/dolphin-emu/GC/JAP"
    dir_prep "$rdhome/screenshots" "/var/data/dolphin-emu/ScreenShots"
    dir_prep "$rdhome/states" "/var/data/dolphin-emu/StateSaves"
    dir_prep "$rdhome/saves/wii/dolphin" "/var/data/dolphin-emu/Wii/"

    # pcsx2
    echo "----------------------"
    echo "Initializing PCSX2"
    echo "----------------------"
    mkdir -pv /var/config/PCSX2/inis/
    mkdir -pv "$rdhome/saves/ps2/pcsx2/memcards"
    cp -fvr $emuconfigs/PCSX2/* /var/config/PCSX2/inis/
    sed -i 's#~/retrodeck#'$rdhome'#g' /var/config/PCSX2/inis/PCSX2_ui.ini
    sed -i 's#~/retrodeck#'$rdhome'#g' /var/config/PCSX2/inis/PCSX2.ini
    dir_prep "$rdhome/states/ps2/pcsx2" "/var/config/PCSX2/sstates"
    dir_prep "$rdhome/screenshots" "/var/config/PCSX2/snaps"
    dir_prep "$rdhome/.logs" "/var/config/PCSX2/logs"
    dir_prep "$rdhome/bios" "$rdhome/bios/pcsx2"

    # MelonDS
    echo "----------------------"
    echo "Initializing MELONDS"
    echo "----------------------"
    mkdir -pv /var/config/melonDS/
    mkdir -pv "$rdhome/saves/nds/melonds"
    mkdir -pv "$rdhome/states/nds/melonds"
    dir_prep "$rdhome/bios" "/var/config/melonDS/bios"
    cp -fvr $emuconfigs/melonDS.ini /var/config/melonDS/
    # Replace ~/retrodeck with $rdhome as ~ cannot be understood by MelonDS
    sed -i 's#~/retrodeck#'$rdhome'#g' /var/config/melonDS/melonDS.ini

    # CITRA
    echo "------------------------"
    echo "Initializing CITRA"
    echo "------------------------"
    mkdir -pv /var/config/citra-emu/
    mkdir -pv "$rdhome/saves/n3ds/citra/nand/"
    mkdir -pv "$rdhome/saves/n3ds/citra/sdmc/"
    dir_prep "$rdhome/.logs/citra" "/var/data/citra-emu/log"
    cp -fv $emuconfigs/citra-qt-config.ini /var/config/citra-emu/qt-config.ini
    sed -i 's#~/retrodeck#'$rdhome'#g' /var/config/citra-emu/qt-config.ini
    #TODO: do the same with roms folders after new variables is pushed (check even the others qt-emu)
    #But actually everything is always symlinked to retrodeck/roms so it might be not needed
    #sed -i 's#~/retrodeck#'$rdhome'#g' /var/config/citra-emu/qt-config.ini

    # RPCS3
    echo "------------------------"
    echo "Initializing RPCS3"
    echo "------------------------"
    mkdir -pv /var/config/rpcs3/
    cp -fvr $emuconfigs/rpcs3/* /var/config/rpcs3/
    sed -i 's#/home/deck/retrodeck#'$rdhome'#g' /var/config/rpcs3/vfs.yml

    # XEMU
    echo "------------------------"
    echo "Initializing XEMU"
    echo "------------------------"
    mkdir -pv $rdhome/saves/xbox/xemu/
    cp -fv $emuconfigs/xemu.toml /var/data/xemu/xemu.toml
    sed -i 's#/home/deck/retrodeck#'$rdhome'#g' /var/data/xemu/xemu.toml
    # Preparing HD dummy Image if the image is not found
    if [ ! -f $rdhome/bios/xbox_hdd.qcow2 ]
    then
      wget "https://github.com/mborgerson/xemu-hdd-image/releases/latest/download/xbox_hdd.qcow2.zip" -P $rdhome/bios/
      unzip $rdhome/bios/xbox_hdd.qcow2.zip $rdhome/bios/
      rm -rfv $rdhome/bios/xbox_hdd.qcow2.zip
    fi

    # PPSSPPSDL
    echo "------------------------"
    echo "Initializing PPSSPPSDL"
    echo "------------------------"
    mkdir -p /var/config/ppsspp/PSP/SYSTEM/
    cp -fv $emuconfigs/ppssppsdl/* /var/config/ppsspp/PSP/SYSTEM/
    sed -i 's#/home/deck/retrodeck#'$rdhome'#g' /var/config/ppsspp/PSP/SYSTEM/ppsspp.ini

    # DUCKSTATION
    echo "------------------------"
    echo "Initializing DUCKSTATION"
    echo "------------------------"
    mkdir -p /var/config/duckstation/
    cp -fv $emuconfigs/duckstation/* /var/config/duckstation
    sed -i 's#/home/deck/retrodeck/bios#'$rdhome/bios'#g' /var/config/ppsspp/PSP/SYSTEM/settings.ini


    # PICO-8
    # Moved PICO-8 stuff in the finit as only it knows here roms folders is

}

ra_init() {
    dir_prep "$rdhome/bios" "/var/config/retroarch/system"
     dir_prep "$rdhome/.logs/retroarch" "/var/config/retroarch/logs"
    mkdir -pv /var/config/retroarch/cores/
    cp /app/share/libretro/cores/* /var/config/retroarch/cores/
    cp -fv $emuconfigs/retroarch.cfg /var/config/retroarch/
    cp -fv $emuconfigs/retroarch-core-options.cfg /var/config/retroarch/
    #rm -rf $rdhome/bios/bios # in some situations a double bios symlink is created
    sed -i 's#~/retrodeck#'$rdhome'#g' /var/config/retroarch/retroarch.cfg

    # PPSSPP
    echo "--------------------------------"
    echo "Initializing PPSSPP_LIBRETRO"
    echo "--------------------------------"
    if [ -d $rdhome/bios/PPSSPP/flash0/font ]
    then
      mv -fv $rdhome/bios/PPSSPP/flash0/font $rdhome/bios/PPSSPP/flash0/font.bak
    fi
    mkdir -p $rdhome/bios/PPSSPP
    #if [ ! -f "$rdhome/bios/PPSSPP/ppge_atlas.zim" ]
    #then
      wget "https://github.com/hrydgard/ppsspp/archive/refs/heads/master.zip" -P $rdhome/bios/PPSSPP
      unzip "$rdhome/bios/PPSSPP/master.zip" -d $rdhome/bios/PPSSPP/
      mv "$rdhome/bios/PPSSPP/ppsspp-master/assets/"* "$rdhome/bios/PPSSPP/"
      rm -rfv "$rdhome/bios/PPSSPP/master.zip"
      rm -rfv "$rdhome/bios/PPSSPP/ppsspp-master"
    #fi
    if [ -d $rdhome/bios/PPSSPP/flash0/font.bak ]
    then
      mv -fv $rdhome/bios/PPSSPP/flash0/font.bak $rdhome/bios/PPSSPP/flash0/font
    fi


    # MSX / SVI / ColecoVision / SG-1000
    echo "-----------------------------------------------------------"
    echo "Initializing MSX / SVI / ColecoVision / SG-1000 LIBRETRO"
    echo "-----------------------------------------------------------"
    wget "http://bluemsx.msxblue.com/rel_download/blueMSXv282full.zip" -P $rdhome/bios/MSX
    unzip "$rdhome/bios/MSX/blueMSXv282full.zip" $rdhome/bios/MSX
    mv -rfv $rdhome/bios/MSX/Databases $rdhome/bios/Databases
    mv -rfv $rdhome/bios/MSX/Machines $rdhome/bios/Machines
    rm -rfv $rdhome/bios/MSX

}

create_lock() {
    # creating RetroDECK's lock file and writing the version in the config file
    version=$hard_version
    touch "$lockfile"
    conf_write
}

post_update() {
    # post update script
    echo "Executing post-update script"

    # Unhiding downloaded media from the previous versions
    if [ -d "$rdhome/.downloaded_media" ]
    then
      mv -fv "$rdhome/.downloaded_media" "$media_folder"
    fi

    # Unhiding themes folder from the previous versions
    if [ -d "$rdhome/.themes" ]
    then
      mv -fv "$rdhome/.themes" "$themes_folder"
    fi

    # Doing the dir prep as we don't know from which version we came
    dir_prep "$media_folder" "/var/config/emulationstation/.emulationstation/downloaded_media"
    dir_prep "$themes_folder" "/var/config/emulationstation/.emulationstation/themes"
    mkdir -pv $rdhome/.logs #this was added later, maybe safe to remove in a few versions
    

    # Resetting es_systems, now we need it but in the future I should think a better solution, maybe with sed
    cp -fv /app/retrodeck/es_settings.xml /var/config/emulationstation/.emulationstation/es_settings.xml

    # 0.4 -> 0.5
    # Saves migration - Part 1: Standalones
    
    #mv -fv OLD_CITRA_SAVES $rdhome/saves/n3ds/citra/nand/
    #mv -fv OLD_CITRA_STATES $rdhome/saves/n3ds/citra/sdmc/

    mv -fv $rdhome/states/*.ml* $rdhome/states/nds/melonds

    mv -fv $rdhome/saves/xemu/* $rdhome/saves/xbox/xemu/

    mv -fv /var/config/PCSX2/memcards/* $rdhome/saves/ps2/memcards

    #ppsspp?

    ra_init
    standalones_init
    tools_init

    create_lock
}

start_retrodeck() {
    # normal startup
    echo "Starting RetroDECK v$version"
    emulationstation --home /var/config/emulationstation
}

browse(){
  # Function for browsing the sd card
  path_selected=false
      while [ $path_selected == false ]
      do
        sdcard="$(zenity --file-selection --title="Choose retrodeck folder location" --directory)"  
        echo "Path choosed: $sdcard, answer=$?"
        zenity --question --no-wrap --window-icon="/app/share/icons/hicolor/scalable/apps/net.retrodeck.retrodeck.svg" --title "RetroDECK" \
        --cancel-label="No" \
        --ok-label "Yes" \
        --text="Your rom folder will be:\n\n$sdcard/retrodeck/roms\n\nis that ok?"
        if [ $? == 0 ] #yes
        then
          sdselected == true
          roms_folder="$sdcard/retrodeck/roms"
          break
        else
          zenity --question --no-wrap --window-icon="/app/share/icons/hicolor/scalable/apps/net.retrodeck.retrodeck.svg" --title "RetroDECK" --cancel-label="No" --ok-label "Yes" --text="Do you want to quit?"
          if [ $? == 0 ] # yes, quit
          then
            exit 0
          fi
        fi
      done
}

#advanced(){
#  # function to give advanced install options
#  echo "Advaced choosed"
#
#  choice=$(zenity --icon-name=net.retrodeck.retrodeck --info --no-wrap \
#    --window-icon="/app/share/icons/hicolor/scalable/apps/net.retrodeck.retrodeck.svg" --title "RetroDECK" \
#    --ok-label "ROMs" \
#    --extra-button "Media" \
#    --extra-button "Themes" \
#    --extra-button "Back" \
#    --text="What do you want to change?\n\nROMS folder = $roms_folder\nMedia folder (scraped data) = $media_folder\nThemes folder=$themes_folder" )
#    echo "Choice is $choice"
#
#    case $choice in
#
#    "" ) # Internal (yes)
#      echo "ROMs"
#      ;;
#
#    "Media" )
#      echo "Media"
#      ;;
#
#    "Themes" )
#      echo "Themes"
#      ;;
#
#    "Back" ) # Browse + not found fallback
#      echo "Back"
#      finit
#      ;;
#
#    esac
#}

finit() {
    # Force/First init, depending on the situation

    echo "Executing finit"

    # Internal or SD Card?
    choice=$(zenity --icon-name=net.retrodeck.retrodeck --info --no-wrap \
    --window-icon="/app/share/icons/hicolor/scalable/apps/net.retrodeck.retrodeck.svg" --title "RetroDECK" \
    --ok-label "Cancel" \
    --extra-button "Internal" \
    --extra-button "SD Card" \
    #--extra-button "Advanced" \
    --text="Welcome to the first configuration of RetroDECK.\nThe setup will be quick but please READ CAREFULLY each message in order to avoid misconfigurations.\n\nWhere do you want your roms folder to be located?" )
    echo "Choice is $choice"

    case $choice in

    "" ) # Cancel or X button quits
      echo "Now quitting"
      kill $$
    ;;

    "Internal" ) # Internal
      echo "Internal selected"
      roms_folder="$rdhome/roms"
    ;;

    "SD Card" )
      echo "SD Card selected"
      if [ ! -d "$sdcard" ] # SD Card path is not existing
      then
        echo "Error: SD card not found"
        zenity --question --no-wrap \
        --window-icon="/app/share/icons/hicolor/scalable/apps/net.retrodeck.retrodeck.svg" \
        --title "RetroDECK" --cancel-label="Cancel" \
        --ok-label "Browse" \
        --text="SD Card was not find in the default location.\nPlease choose the SD Card root.\nA retrodeck/roms folder will be created starting from the directory that you selected."
        browse # Calling the browse function
      else
        roms_folder="$sdcard/retrodeck/roms"    # sdcard variable is correct as its given by browse function
        echo "ROMs folder = $roms_folder"
      fi
    ;;

    #"Advanced" ) # Browse + not found fallback
    #  echo "Advanced"
    #  advanced
    #;;

    esac

    mkdir -pv $roms_folder

    # TODO: after the next update of ES-DE this will not be needed
    #zenity --icon-name=net.retrodeck.retrodeck --info --no-wrap --window-icon="/app/share/icons/hicolor/scalable/apps/net.retrodeck.retrodeck.svg" --title "RetroDECK" --text="EmulationStation will now initialize the system.\nPlease DON'T EDIT THE ROMS LOCATION, just select:\n\nCREATE DIRECTORIES\nYES\nOK\nQUIT\n\nRetroDECK will manage the rest."
    zenity --icon-name=net.retrodeck.retrodeck --info --no-wrap --window-icon="/app/share/icons/hicolor/scalable/apps/net.retrodeck.retrodeck.svg" --title "RetroDECK" --text="RetroDECK will now install the needed files.\nPlease wait up to one minute,\nanother message will notify when the process will be finished.\n\nPress OK to continue."

    # Recreating the folder
    rm -rfv /var/config/emulationstation/
    rm -rfv /var/config/retrodeck/tools/
    mkdir -pv /var/config/emulationstation/
    
    # Initializing ES-DE
    # TODO: after the next update of ES-DE this will not be needed - let's test it
    emulationstation --home /var/config/emulationstation --create-system-dirs

    mkdir -pv /var/config/retrodeck/tools/

    #zenity --icon-name=net.retrodeck.retrodeck --info --no-wrap --window-icon="/app/share/icons/hicolor/scalable/apps/net.retrodeck.retrodeck.svg" --title "RetroDECK" --text="RetroDECK will now install the needed files.\nPlease wait up to one minute,\nanother message will notify when the process will be finished.\n\nPress OK to continue."

    # Initializing ROMs folder - Original in retrodeck home (or SD Card)
    dir_prep $roms_folder "/var/config/emulationstation/ROMs"

    mkdir -pv $rdhome/saves
    mkdir -pv $rdhome/states
    mkdir -pv $rdhome/screenshots
    mkdir -pv $rdhome/bios/pico8
    mkdir -pv $rdhome/.logs

    # XMLSTARLET HERE
    cp -fv /app/retrodeck/es_settings.xml /var/config/emulationstation/.emulationstation/es_settings.xml

    # ES-DE preparing themes and scraped folders
    dir_prep "$rdhome/downloaded_media" "/var/config/emulationstation/.emulationstation/downloaded_media"
    dir_prep "$rdhome/themes" "/var/config/emulationstation/.emulationstation/themes"

    # PICO-8
    dir_prep "$roms_folder/pico8" "$rdhome/bios/pico8/bbs/carts" #this is the folder where pico-8 is saving the carts

    ra_init
    standalones_init
    tools_init
    create_lock

    zenity --icon-name=net.retrodeck.retrodeck --info --no-wrap \
    --window-icon="/app/share/icons/hicolor/scalable/apps/net.retrodeck.retrodeck.svg" \
    --title "RetroDECK" \
    --text="Installation completed.\nPlease put your roms in:\n\n$roms_folder\n\nand your bioses in\n\n$rdhome/bios\n\nThen start the program again.\nIf you wish to change the roms location, you may use the tool located the tools section of RetroDECK.\n\nIMPORTANT NOTES:\n- RetroDECK must be manually added and launched from your Steam Library in order to work correctly.\n- It's recommended to use the 'RetroDECK Offical Controller Config' from Steam (under community layouts).\n- It's suggested to use BoilR to automatically add the SteamGridDB images to Steam (this will be automated soon).\nhttps://github.com/PhilipK/BoilR"
    # TODO: Replace the stuff above with BoilR code when ready
}

# Arguments section

for i in "$@"; do
  case $i in
    -h*|--help*)
      echo "RetroDECK v""$version"
      echo "
      Usage:
flatpak run [FLATPAK-RUN-OPTION] net.retrodeck-retrodeck [ARGUMENTS]

Arguments:
    -h, --help        Print this help
    -v, --version     Print RetroDECK version
    --info-msg        Print paths and config informations
    --reset           Starts the initial RetroDECK installer (backup your data first!)
    --reset-ra        Resets RetroArch's config to the default values
    --reset-sa        Reset standalone emulator configs to the default values
    --reset-tools     Recreate the tools section

For flatpak run specific options please run: flatpak run -h

https://retrodeck.net
"
      exit
      ;;
    --version*|-v*)
      #conf_init
      echo "RetroDECK v$version"
      exit
      ;;
    --info-msg*)
      #conf_init
      echo "RetroDECK v$version"
      echo "RetroDECK config file is in: $rd_conf"
      echo "Contents:"
      cat $rd_conf
      exit
      ;;
    --reset-ra*)
      ra_init
      shift # past argument with no value
      ;;
    --reset-sa*)
      standalones_init
      shift # past argument with no value
      ;;
    --reset-tools*)
      tools_init
      shift # past argument with no value
      ;;
    --reset*)
      rm -f "$lockfile"
      shift # past argument with no value
      ;;
    -*|--*)
      echo "Unknown option $i"
      exit 1
      ;;
    *)
      ;;
  esac
done

# UPDATE TRIGGERED
# if lockfile exists
if [ -f "$lockfile" ]
then

  #conf_init             # Initializing/reading the config file (sourced from global.sh)

  # ...but the version doesn't match with the config file
  if [ "$hard_version" != "$version" ]; 
  then
      echo "Config file's version is $version but the actual version is $hard_version"
      post_update       # Executing post update script
      conf_write        # Writing variables in the config file (sourced from global.sh)
      start_retrodeck
      exit 0
  fi

# Else, LOCKFILE IS NOT EXISTING (WAS REMOVED)
# if the lock file doesn't exist at all means that it's a fresh install or a triggered reset
else 
  echo "Lockfile not found"
  #conf_init         # Initializing/reading the config file (sourced from global.sh)
  finit             # Executing First/Force init
  conf_write        # Writing variables in the config file (sourced from global.sh)
	exit 0
fi

# Normal Startup
start_retrodeck