EmuDeck/functions/ToolScripts/emuDeckESDE.sh
rawdatafeel ae6d663c1b
ES-DE: Hotfix custom_systems folder not being created (#1181)
* If users reset emulator configurations and not ES-DE, a junk custom_systems file would be created. This adds creating the custom_systems folder to emulator scripts when applicable.
* Added a function to ES-DE to delete the junk custom_systems file so legacy users can update and have the custom_systems folder actually generate.
2024-04-07 19:54:06 +02:00

472 lines
18 KiB
Bash

#!/bin/bash
#variables
ESDE_toolName="ES-DE"
ESDE_oldtoolName="EmulationStation-DE"
ESDE_downloadedToolName="EmulationStation-DE-x64_SteamDeck.AppImage"
ESDE_toolType="$emuDeckEmuTypeAppImage"
ESDE_oldConfigDirectory="$ESDE_newConfigDirectory"
ESDE_newConfigDirectory="$HOME/ES-DE"
ESDE_toolLocation="$HOME/Applications"
ESDE_toolPath="${ESDE_toolLocation}/ES-DE.AppImage"
ESDE_releaseURL="https://gitlab.com/es-de/emulationstation-de/-/package_files/76389058/download" #default URl in case of issues parsing json
ESDE_releaseMD5="b749b927d61317fde0250af9492a4b9f" #default hash
ESDE_prereleaseURL=""
ESDE_prereleaseMD5=""
ESDE_releaseJSON="https://gitlab.com/es-de/emulationstation-de/-/raw/master/latest_release.json"
ESDE_addSteamInputFile="$EMUDECKGIT/configs/steam-input/emulationstation-de_controller_config.vdf"
steam_input_templateFolder="$HOME/.steam/steam/controller_base/templates/"
es_systemsFile="$ESDE_newConfigDirectory/custom_systems/es_systems.xml"
es_settingsFile="$ESDE_newConfigDirectory/settings/es_settings.xml"
es_rulesFile="$ESDE_newConfigDirectory/custom_systems/es_find_rules.xml"
ESDE_SetAppImageURLS() {
local json="$(curl -s $ESDE_releaseJSON)"
ESDE_releaseURL=$(echo "$json" | jq -r '.stable.packages[] | select(.name == "LinuxSteamDeckAppImage") | .url')
ESDE_releaseMD5=$(echo "$json" | jq -r '.stable.packages[] | select(.name == "LinuxSteamDeckAppImage") | .md5')
ESDE_prereleaseURL=$(echo "$json" | jq -r '.prerelease.packages[] | select(.name == "LinuxSteamDeckAppImage") | .url')
ESDE_prereleaseMD5=$(echo "$json" | jq -r '.prerelease.packages[] | select(.name == "LinuxSteamDeckAppImage") | .md5')
}
#cleanupOlderThings
ESDE_cleanup(){
echo "NYI"
}
ESDE_migration(){
if [ -d "$ESDE_oldConfigDirectory" ] && [ ! -L "$ESDE_oldConfigDirectory" ] && [ ! -d "$ESDE_newConfigDirectory" ]; then
mv "$ESDE_oldConfigDirectory" "$ESDE_newConfigDirectory"
ln -s "$ESDE_newConfigDirectory" "$ESDE_oldConfigDirectory"
echo "EmulationStation-DE config directory successfully migrated and linked."
fi
if [ -f "${toolsPath}/$ESDE_downloadedToolName" ] && [ ! -L "${toolsPath}/$ESDE_downloadedToolName" ]; then
mv "${toolsPath}/$ESDE_downloadedToolName" "$ESDE_toolPath"
ln -s "$ESDE_toolPath" "${toolsPath}/EmulationStation-DE-x64_SteamDeck.AppImage"
echo "$ESDE_toolName successfully migrated and linked."
fi
if [ -f "${toolsPath}/$ESDE_oldtoolName.AppImage" ] && [ ! -L "${toolsPath}/$ESDE_oldtoolName.AppImage" ]; then
mv "${toolsPath}/$ESDE_oldtoolName.AppImage" "$ESDE_toolPath"
ln -s "$ESDE_toolPath" "${toolsPath}/$ESDE_oldtoolName.AppImage"
echo "$ESDE_toolName successfully migrated and linked."
fi
}
ESDE_customDesktopShortcut(){
mkdir -p "$toolsPath/launchers/es-de"
mkdir -p "$toolsPath/launchers/esde"
cp "$EMUDECKGIT/tools/launchers/es-de/es-de.sh" "$toolsPath/launchers/es-de/es-de.sh"
rm -rf $HOME/.local/share/applications/$ESDE_oldtoolName.desktop
createDesktopShortcut "$HOME/.local/share/applications/$ESDE_toolName.desktop" \
"$ESDE_toolName AppImage" \
"${toolsPath}/launchers/es-de/es-de.sh" \
"false"
ln -s "${toolsPath}/launchers/es-de/es-de.sh" "$toolsPath/launchers/esde/emulationstationde.sh"
}
ESDE_uninstall(){
rm -rf "${toolsPath}/$ESDE_oldtoolName.AppImage"
rm -rf "${toolsPath}/$ESDE_downloadedToolName"
rm -rf "$ESDE_toolPath"
rm -rf $HOME/.local/share/applications/$ESDE_toolName.desktop
}
#Install
ESDE_install(){
setMSG "Installing $ESDE_toolName"
# Move ES-DE to ~/Applications folder
ESDE_migration
ESDE_SetAppImageURLS
ESDE_migration
local showProgress="$1"
echo $ESDE_releaseURL
if [[ $ESDE_releaseURL = "https://gitlab.com/es-de/emulationstation-de/-/package_files/"* ]]; then
if safeDownload "$ESDE_toolName" "$ESDE_releaseURL" "$ESDE_toolPath" "$showProgress"; then
chmod +x "$ESDE_toolPath"
ESDE_customDesktopShortcut
else
return 1
fi
else
setMSG "$ESDE_toolName not found"
return 1
fi
}
#ApplyInitialSettings
ESDE_init(){
setMSG "Setting up $ESDE_toolName"
ESDE_migration
ESDE_junksettingsFile
ESDE_addCustomSystemsFile
mkdir -p "$ESDE_newConfigDirectory/settings"
rsync -avhp --mkpath "$EMUDECKGIT/configs/emulationstation/es_settings.xml" "$(dirname "$es_settingsFile")" --backup --suffix=.bak
rsync -avhp --mkpath "$EMUDECKGIT/chimeraOS/configs/emulationstation/custom_systems/es_find_rules.xml" "$(dirname "$es_rulesFile")" --backup --suffix=.bak
cp -r "$EMUDECKGIT/tools/launchers/es-de/." "$toolsPath/launchers/es-de/" && chmod +x "$toolsPath/launchers/es-de/es-de.sh"
ESDE_addCustomSystems
ESDE_setEmulationFolder
ESDE_setDefaultEmulators
ESDE_applyTheme "$esdeThemeUrl" "$esdeThemeName"
ESDE_migrateDownloadedMedia
#ESDE_addSteamInputProfile
ESDE_symlinkGamelists
ESDE_migrateEpicNoir
SRM_createParsers
addSteamInputCustomIcons
ESDE_flushToolLauncher
SRM_flushOldSymlinks
}
ESDE_resetConfig(){
ESDE_init &>/dev/null && echo "true" || echo "false"
}
# ESDE20_init(){
# ESDE_init
# }
ESDE_update(){
setMSG "Setting up $ESDE_toolName"
ESDE_migration
ESDE_junksettingsFile
ESDE_addCustomSystemsFile
mkdir -p "$ESDE_newConfigDirectory/custom_systems/"
mkdir -p "$ESDE_newConfigDirectory/settings"
#update es_settings.xml
rsync -avhp --mkpath "$EMUDECKGIT/configs/emulationstation/es_settings.xml" "$(dirname "$es_settingsFile")" --ignore-existing
rsync -avhp --mkpath "$EMUDECKGIT/chimeraOS/configs/emulationstation/custom_systems/es_find_rules.xml" "$(dirname "$es_rulesFile")" --ignore-existing
ESDE_addCustomSystems
ESDE_setEmulationFolder
ESDE_setDefaultEmulators
ESDE_applyTheme "$esdeThemeUrl" "$esdeThemeName"
ESDE_migrateDownloadedMedia
#ESDE_addSteamInputProfile
ESDE_symlinkGamelists
addSteamInputCustomIcons
ESDE_flushToolLauncher
}
ESDE_junksettingsFile(){
local junkSettingsFile="$ESDE_newConfigDirectory/settings"
local customSystemsFile="$ESDE_newConfigDirectory/custom_systems"
if [ -f "$junkSettingsFile" ]; then
rm -f "$junkSettingsFile"
echo ""$junkSettingsFile" deleted."
else
echo ""$junkSettingsFile" does not exist."
fi
if [ -f "$customSystemsFile" ]; then
rm -f "$customSystemsFile"
echo ""$customSystemsFile" deleted."
else
echo ""$customSystemsFile" does not exist."
fi
}
ESDE_addCustomSystemsFile(){
# Separate function so it can be copied and used in the emulator scripts.
mkdir -p "$ESDE_newConfigDirectory/custom_systems/"
rsync -avhp --mkpath "$EMUDECKGIT/configs/emulationstation/custom_systems/es_systems.xml" "$(dirname "$es_systemsFile")" --backup --suffix=.bak
}
ESDE_addCustomSystems(){
# Some reported issues where these custom systems are not always being applied properly. Added here as a fail-safe.
BigPEmu_addESConfig
CemuProton_addESConfig
Model2_addESConfig
Xenia_addESConfig
Yuzu_addESConfig
}
#update
ESDE_applyTheme(){
local themeUrl=$1
local themeName=$2
echo "ESDE: applyTheme $themeName"
mkdir -p "$ESDE_newConfigDirectory/themes/"
if [ -d "$ESDE_newConfigDirectory/themes/$themeName" ]; then
cd "$ESDE_newConfigDirectory/themes/$themeName" && git pull
else
git clone $themeUrl "$ESDE_newConfigDirectory/themes/"
fi
updateOrAppendConfigLine "$es_settingsFile" "<string name=\"ThemeSet\"" "<string name=\"ThemeSet\" value=\"\""
updateOrAppendConfigLine "$es_settingsFile" "<string name=\"Theme\"" "<string name=\"Theme\" value=\"\""
sed -i "s/<string name=\"ThemeSet\" value=\"[^\"]*\"/<string name=\"ThemeSet\" value=\"$themeName\"\/>/" "$es_settingsFile"
sed -i "s/<string name=\"Theme\" value=\"[^\"]*\"/<string name=\"Theme\" value=\"$themeName\"\/>/" "$es_settingsFile"
}
#ConfigurePaths
ESDE_setEmulationFolder(){
#update cemu custom system launcher to correct path by just replacing the line, if it exists.
echo "updating $es_systemsFile"
#insert new commands
if [[ ! $(grep -rnw "$es_systemsFile" -e 'wiiu') == "" ]]; then
if [[ $(grep -rnw "$es_systemsFile" -e 'Cemu (Native)') == "" ]]; then
#insert
xmlstarlet ed -S --inplace --subnode 'systemList/system[name="wiiu"]' --type elem --name 'commandN' -v "/bin/bash ${toolsPath}/launchers/cemu.sh -f -g %ROM%" \
--insert 'systemList/system/commandN' --type attr --name 'label' --value "Cemu (Native)" \
-r 'systemList/system/commandN' -v 'command' \
"$es_systemsFile"
#format doc to make it look nice
xmlstarlet fo "$es_systemsFile" > "$es_systemsFile".tmp && mv "$es_systemsFile".tmp "$es_systemsFile"
else
#update
cemuNativeCommandString="/bin/bash ${toolsPath}/launchers/cemu.sh -f -g %ROM%"
xmlstarlet ed -L -u '/systemList/system/command[@label="Cemu (Native)"]' -v "$cemuNativeCommandString" "$es_systemsFile"
fi
if [[ $(grep -rnw "$es_systemsFile" -e 'Cemu (Proton)') == "" ]]; then
#insert
xmlstarlet ed -S --inplace --subnode 'systemList/system[name="wiiu"]' --type elem --name 'commandP' -v "/bin/bash ${toolsPath}/launchers/cemu.sh -w -f -g z:%ROM%" \
--insert 'systemList/system/commandP' --type attr --name 'label' --value "Cemu (Proton)" \
-r 'systemList/system/commandP' -v 'command' \
"$es_systemsFile"
#format doc to make it look nice
xmlstarlet fo "$es_systemsFile" > "$es_systemsFile".tmp && mv "$es_systemsFile".tmp "$es_systemsFile"
else
#update
cemuProtonCommandString="/bin/bash ${toolsPath}/launchers/cemu.sh -w -f -g z:%ROM%"
xmlstarlet ed -L -u '/systemList/system/command[@label="Cemu (Proton)"]' -v "$cemuProtonCommandString" "$es_systemsFile"
fi
fi
if [[ ! $(grep -rnw "$es_systemsFile" -e 'xbox360') == "" ]]; then
if [[ $(grep -rnw "$es_systemsFile" -e 'Xenia (Proton)') == "" ]]; then
#insert
xmlstarlet ed -S --inplace --subnode 'systemList/system[name="xbox360"]' --type elem --name 'commandP' -v "/bin/bash ${toolsPath}/launchers/xenia.sh z:%ROM% %INJECT%=%BASENAME%.esprefix" \
--insert 'systemList/system/commandP' --type attr --name 'label' --value "Xenia (Proton)" \
-r 'systemList/system/commandP' -v 'command' \
"$es_systemsFile"
#format doc to make it look nice
xmlstarlet fo "$es_systemsFile" > "$es_systemsFile".tmp && mv "$es_systemsFile".tmp "$es_systemsFile"
else
#update
xeniaProtonCommandString="/bin/bash ${toolsPath}/launchers/xenia.sh z:%ROM% %INJECT%=%BASENAME%.esprefix"
xmlstarlet ed -L -u '/systemList/system/command[@label="Xenia (Proton)"]' -v "$xeniaProtonCommandString" "$es_systemsFile"
fi
fi
if [[ ! $(grep -rnw "$es_systemsFile" -e 'model2') == "" ]]; then
if [[ $(grep -rnw "$es_systemsFile" -e 'Model 2 Emulator (Proton)') == "" ]]; then
#insert
xmlstarlet ed -S --inplace --subnode 'systemList/system[name="model2"]' --type elem --name 'commandP' -v "/bin/bash ${toolsPath}/launchers/model-2-emulator.sh %BASENAME%" \
--insert 'systemList/system/commandP' --type attr --name 'label' --value "Model 2 Emulator (Proton)" \
-r 'systemList/system/commandP' -v 'command' \
"$es_systemsFile"
#format doc to make it look nice
xmlstarlet fo "$es_systemsFile" > "$es_systemsFile".tmp && mv "$es_systemsFile".tmp "$es_systemsFile"
else
#update
model2ProtonCommandString="/bin/bash ${toolsPath}/launchers/model-2-emulator.sh %BASENAME%"
xmlstarlet ed -L -u '/systemList/system/command[@label="Model 2 Emulator (Proton)"]' -v "$model2ProtonCommandString" "$es_systemsFile"
fi
fi
if [[ ! $(grep -rnw "$es_systemsFile" -e 'atarijaguar') == "" ]]; then
if [[ $(grep -rnw "$es_systemsFile" -e 'BigPEmu (Proton)') == "" ]]; then
#insert
xmlstarlet ed -S --inplace --subnode 'systemList/system[name="atarijaguar"]' --type elem --name 'commandP' -v "/bin/bash ${toolsPath}/launchers/bigpemu.sh %BASENAME%" \
--insert 'systemList/system/commandP' --type attr --name 'label' --value "BigPEmu (Proton)" \
-r 'systemList/system/commandP' -v 'command' \
"$es_systemsFile"
#format doc to make it look nice
xmlstarlet fo "$es_systemsFile" > "$es_systemsFile".tmp && mv "$es_systemsFile".tmp "$es_systemsFile"
else
#update
bigpemujaguarProtonCommandString="/bin/bash ${toolsPath}/launchers/bigpemu.sh %ROM%"
xmlstarlet ed -L -u '/systemList/system/command[@label="BigPEmu (Proton)"]' -v "$bigpemujaguarProtonCommandString" "$es_systemsFile"
fi
fi
if [[ ! $(grep -rnw "$es_systemsFile" -e 'atarijaguarcd') == "" ]]; then
if [[ $(grep -rnw "$es_systemsFile" -e 'BigPEmu (Proton)') == "" ]]; then
#insert
xmlstarlet ed -S --inplace --subnode 'systemList/system[name="atarijaguarcd"]' --type elem --name 'commandP' -v "/bin/bash ${toolsPath}/launchers/bigpemu.sh %ROM%" \
--insert 'systemList/system/commandP' --type attr --name 'label' --value "BigPEmu (Proton)" \
-r 'systemList/system/commandP' -v 'command' \
"$es_systemsFile"
#format doc to make it look nice
xmlstarlet fo "$es_systemsFile" > "$es_systemsFile".tmp && mv "$es_systemsFile".tmp "$es_systemsFile"
else
#update
bigpemujaguarcdProtonCommandString="/bin/bash ${toolsPath}/launchers/bigpemu.sh %ROM%"
xmlstarlet ed -L -u '/systemList/system/command[@label="BigPEmu (Proton)"]' -v "$bigpemujaguarcdProtonCommandString" "$es_systemsFile"
fi
fi
if [[ ! $(grep -rnw "$es_systemsFile" -e 'switch') == "" ]]; then
if [[ $(grep -rnw "$es_systemsFile" -e 'Ryujinx (Standalone)') == "" ]]; then
#insert
xmlstarlet ed -S --inplace --subnode 'systemList/system[name="switch"]' --type elem --name 'commandP' -v "%EMULATOR_RYUJINX% %ROM%" \
--insert 'systemList/system/commandP' --type attr --name 'label' --value "Ryujinx (Standalone)" \
-r 'systemList/system/commandP' -v 'command' \
"$es_systemsFile"
#format doc to make it look nice
xmlstarlet fo "$es_systemsFile" > "$es_systemsFile".tmp && mv "$es_systemsFile".tmp "$es_systemsFile"
else
#update
ryujinxSwitchCommandString="%EMULATOR_RYUJINX% %ROM%"
xmlstarlet ed -L -u '/systemList/system/command[@label="Ryujinx (Standalone)"]' -v "$ryujinxSwitchCommandString" "$es_systemsFile"
fi
if [[ $(grep -rnw "$es_systemsFile" -e 'Yuzu (Standalone)') == "" ]]; then
#insert
xmlstarlet ed -S --inplace --subnode 'systemList/system[name="switch"]' --type elem --name 'commandP' -v "%INJECT%=%BASENAME%.esprefix %EMULATOR_YUZU% -f -g %ROM%" \
--insert 'systemList/system/commandP' --type attr --name 'label' --value "Yuzu (Standalone)" \
-r 'systemList/system/commandP' -v 'command' \
"$es_systemsFile"
#format doc to make it look nice
xmlstarlet fo "$es_systemsFile" > "$es_systemsFile".tmp && mv "$es_systemsFile".tmp "$es_systemsFile"
else
#update
yuzuSwitchCommandString="%INJECT%=%BASENAME%.esprefix %EMULATOR_YUZU% -f -g %ROM%"
xmlstarlet ed -L -u '/systemList/system/command[@label="Yuzu (Standalone)"]' -v "$yuzuSwitchCommandString" "$es_systemsFile"
fi
fi
echo "updating $es_settingsFile"
#configure roms Directory
esDE_romDir="<string name=\"ROMDirectory\" value=\"${romsPath}\" />" #roms
changeLine '<string name="ROMDirectory"' "${esDE_romDir}" "$es_settingsFile"
#Configure Downloaded_media folder
esDE_MediaDir="<string name=\"MediaDirectory\" value=\"${ESDEscrapData}\" />"
#search for media dir in xml, if not found, change to ours. If it's blank, also change to ours.
mediaDirFound=$(grep -rnw "$es_settingsFile" -e 'MediaDirectory')
mediaDirEmpty=$(grep -rnw "$es_settingsFile" -e '<string name="MediaDirectory" value="" />')
mediaDirEmulation=$(grep -rnw "$es_settingsFile" -e 'Emulation/tools/downloaded_media')
if [[ $mediaDirFound == '' ]]; then
echo "adding ES-DE ${esDE_MediaDir}"
sed -i -e '$a'"${esDE_MediaDir}" "$es_settingsFile" # use config file instead of link
elif [[ -z $mediaDirEmpty || -n $mediaDirEmulation ]]; then
echo "setting ES-DE MediaDirectory to ${esDE_MediaDir}"
changeLine '<string name="MediaDirectory"' "${esDE_MediaDir}" "$es_settingsFile"
fi
}
ESDE_setDefaultEmulators(){
#ESDE default emulators
mkdir -p "$ESDE_newConfigDirectory/gamelists/"
ESDE_setEmu 'Dolphin (Standalone)' gc
ESDE_setEmu 'PPSSPP (Standalone)' psp
ESDE_setEmu 'Dolphin (Standalone)' wii
ESDE_setEmu 'PCSX2 (Standalone)' ps2
ESDE_setEmu 'melonDS DS' nds
ESDE_setEmu 'Citra (Standalone)' n3ds
ESDE_setEmu 'Beetle Lynx' atarilynx
ESDE_setEmu 'DuckStation (Standalone)' psx
ESDE_setEmu 'Beetle Saturn' saturn
ESDE_setEmu 'ScummVM (Standalone)' scummvm
ESDE_setEmu 'Ryujinx (Standalone)' switch
}
ESDE_migrateDownloadedMedia(){
echo "ESDE: Migrate Downloaded Media."
originalESMediaFolder="$ESDE_newConfigDirectory/downloaded_media"
echo "processing $originalESMediaFolder"
if [ -L "${originalESMediaFolder}" ] ; then
echo "link found"
unlink "${originalESMediaFolder}" && echo "unlinked"
elif [ -e "${originalESMediaFolder}" ] ; then
if [ -d "${originalESMediaFolder}" ]; then
echo -e ""
echo -e "Moving $ESDE_toolName downloaded_media to $toolsPath"
echo -e ""
rsync -a "$originalESMediaFolder" "$toolsPath/" && rm -rf "$originalESMediaFolder" #move it, merging files if in both locations
fi
else
echo "downloaded_media not found on original location"
fi
}
ESDE_setEmu(){
local emu=$1
local system=$2
local gamelistFile="$ESDE_newConfigDirectory/gamelists/$system/gamelist.xml"
if [ ! -f "$gamelistFile" ]; then
mkdir -p "$ESDE_newConfigDirectory/gamelists/$system" && cp "$EMUDECKGIT/configs/emulationstation/gamelists/$system/gamelist.xml" "$gamelistFile"
else
gamelistFound=$(grep -rnw "$gamelistFile" -e 'gameList')
if [[ $gamelistFound == '' ]]; then
sed -i -e '$a\<gameList />' "$gamelistFile"
fi
alternativeEmu=$(grep -rnw "$gamelistFile" -e 'alternativeEmulator')
if [[ $alternativeEmu == '' ]]; then
echo "<alternativeEmulator><label>$emu</label></alternativeEmulator>" >> "$gamelistFile"
fi
sed -i "s|<?xml version=\"1.0\">|<?xml version=\"1.0\"?>|g" "$gamelistFile"
fi
}
ESDE_addSteamInputProfile(){
addSteamInputCustomIcons
#setMSG "Adding $ESDE_toolName Steam Input Profile."
#rsync -r "$ESDE_addSteamInputFile" "$steam_input_templateFolder"
}
ESDE_IsInstalled(){
if [ -e "$ESDE_toolPath" ]; then
echo "true"
else
echo "false"
fi
}
ESDE_symlinkGamelists(){
linkToSaveFolder es-de gamelists "$ESDE_newConfigDirectory/gamelists/"
}
ESDE_migrateEpicNoir(){
FOLDER="$ESDE_newConfigDirectory/themes/es-epicnoir"
if [ -f "$FOLDER" ]; then
rm -rf "$FOLDER"
git clone https://github.com/anthonycaccese/epic-noir-revisited-es-de "$ESDE_newConfigDirectory/themes/epic-noir-revisited" --depth=1
changeLine '<string name="ThemeSet"' '<string name="ThemeSet" value="epic-noir-revisited-es-de" />' "$es_settingsFile"
fi
}
ESDE_flushToolLauncher(){
mkdir -p "$toolsPath/launchers/es-de"
cp "$EMUDECKGIT/tools/launchers/es-de/es-de.sh" "$toolsPath/launchers/es-de/es-de.sh"
chmod +x "$toolsPath/launchers/es-de/es-de.sh"
}