Xargon/RetroDECK
1
0
Fork 0
mirror of https://github.com/RetroDECK/RetroDECK.git synced 2025-04-10 19:15:12 +00:00
Code Issues Actions Packages Projects Releases Wiki Activity

FRAMEWORK, CONFIGURATOR, CLI: refactored Open Component and Reset Component

Browse source
This commit is contained in:
XargonWan 2025-02-07 15:35:08 +09:00
parent 4dab1d7493
commit 1a5db3ffa6
6 changed files with 941 additions and 1043 deletions
Show stats Download patch file Download diff file Expand all files Collapse all files

6
config/retrodeck/reference_lists/features.json
View file

@ -833,6 +833,12 @@
} }
}, },
"emulator": { "emulator": {
"retrodeck": {
"description": "RetroDECK Framework",
"name": "RetroDECK",
"url": "https://retrodeck.net/",
"cli-arg": "--version"
},
"retroarch": { "retroarch": {
"description": "RetroArch (Multi-emulator Frontend)", "description": "RetroArch (Multi-emulator Frontend)",
"name": "RetroArch", "name": "RetroArch",

8
functions/other_functions.sh
View file

@ -1025,7 +1025,7 @@ open_component(){
return return
fi fi
if [[ "$1" == "--getlist" ]]; then if [[ "$1" == "--list" ]]; then
cmd=$(jq -r '.emulator[] | select(.ponzu != true) | .name' "$features") cmd=$(jq -r '.emulator[] | select(.ponzu != true) | .name' "$features")
if [[ $(get_setting_value "$rd_conf" "akai_ponzu" "retrodeck" "options") == "true" ]]; then if [[ $(get_setting_value "$rd_conf" "akai_ponzu" "retrodeck" "options") == "true" ]]; then
cmd+="\n$(jq -r '.emulator.citra | .name' "$features")" cmd+="\n$(jq -r '.emulator.citra | .name' "$features")"
@ -1049,6 +1049,12 @@ open_component(){
return return
fi fi
launch_exists=$(jq -r --arg name "$1" '.emulator[] | select(.name == $name) | has("launch")' "$features")
if [[ "$launch_exists" != "true" ]]; then
echo "Error: The component '$1' cannot be opened."
return 1
fi
cmd=$(jq -r --arg name "$1" '.emulator[] | select(.name == $name and .ponzu != true) | .launch' "$features") cmd=$(jq -r --arg name "$1" '.emulator[] | select(.name == $name and .ponzu != true) | .launch' "$features")
if [[ -z "$cmd" && $(get_setting_value "$rd_conf" "akai_ponzu" "retrodeck" "options") == "true" && "$1" == "citra" ]]; then if [[ -z "$cmd" && $(get_setting_value "$rd_conf" "akai_ponzu" "retrodeck" "options") == "true" && "$1" == "citra" ]]; then
cmd=$(jq -r '.emulator.citra | .launch' "$features") cmd=$(jq -r '.emulator.citra | .launch' "$features")

1710
functions/prepare_component.sh
View file

File diff suppressed because it is too large Load diff

6
net.retrodeck.retrodeck.metainfo.xml
View file

@ -65,8 +65,11 @@
<description> <description>
<p>New Additions:</p> <p>New Additions:</p>
<ul> <ul>
<li>CONFIGURATOR: reset components menu simplified and allowed multiple choices</li>
<li>CONFIGURATOR: refacotred open component menu</li>
<li>New CLI argument `--set` to set presets, call retrodeck with `--set help` for more information</li> <li>New CLI argument `--set` to set presets, call retrodeck with `--set help` for more information</li>
<li>New CLI argument `--open` to open a component or emulator. Call retrodeck with `--open --getlist` for a list of available components or emulator to open</li> <li>New CLI argument `--open` to open a component or emulator. Call retrodeck with `--open --list` for a list of available components or emulator to open</li>
<li>New CLI argument `--reset` that replaces the previous ones</li>
<li>CHEATS: added basic cheats support for RetroArch, PCSX2, PPSSPP and MAME</li> <li>CHEATS: added basic cheats support for RetroArch, PCSX2, PPSSPP and MAME</li>
</ul> </ul>
<p>Bug fixes:</p> <p>Bug fixes:</p>
@ -82,6 +85,7 @@
<ul> <ul>
<li>Function `make_preset_changes` enhanced to be 100% headless</li> <li>Function `make_preset_changes` enhanced to be 100% headless</li>
<li>New `fetch_all_presets` function to list all the presets globally of per-system</li> <li>New `fetch_all_presets` function to list all the presets globally of per-system</li>
<li>`preapre_components` can now act/reset multiple components at once</li>
</ul> </ul>
</description> </description>
</release> </release>

53
retrodeck.sh
View file

@ -2,17 +2,6 @@
source /app/libexec/global.sh source /app/libexec/global.sh
# uses jq to extract all the emulators (components) that don't have resettable: false in the features.json and separate them with "|"
resettable_components=$(jq -r '
[(.emulator | to_entries[]) |
select(.value.core == null and .value.resettable != false) |
.key] | sort | join("|")
' "$features")
# uses sed to create, a, list, like, this
pretty_resettable_components=$(echo "$resettable_components" | sed 's/|/, /g')
show_cli_help() { show_cli_help() {
echo -e " echo -e "
Usage: Usage:
@ -26,11 +15,10 @@ Arguments:
--configurator \t Starts the RetroDECK Configurator --configurator \t Starts the RetroDECK Configurator
--compress-one <file> \t Compresses target file to a compatible format --compress-one <file> \t Compresses target file to a compatible format
--compress-all <format> \t Compresses all supported games into a compatible format.\n\t\t\t\t\t\t Available formats are \"chd\", \"zip\", \"rvz\" and \"all\" --compress-all <format> \t Compresses all supported games into a compatible format.\n\t\t\t\t\t\t Available formats are \"chd\", \"zip\", \"rvz\" and \"all\"
--reset-component <component> \t Reset one or more component or emulator configs to the default values --reset <component> \t Reset RetroDECK or one or more component/emulator configurations to default values. WARNING: no confirmation prompt
--reset-retrodeck \t Starts the initial RetroDECK installer (backup your data first!)
--test-upgrade <version> \t Test upgrading RetroDECK to a specific version, developer use only --test-upgrade <version> \t Test upgrading RetroDECK to a specific version, developer use only
--set <preset> <system/all> [value] \t Configure or toggle a preset. Examples: --set borders, --set borders all true,\n\t\t\t\t\t\t --set borders gba false. Use --set help for more information --set <preset> <system/all> [value] \t Configure or toggle a preset. Examples: --set borders, --set borders all true,\n\t\t\t\t\t\t --set borders gba false. Use --set help for more information
--open <component/emulator> \t Open a specific component or emulator\n\t\t\t\t\t\t --open --getlist for a list of available components --open <component/emulator> \t Open a specific component or emulator\n\t\t\t\t\t\t --open --list for a list of available components
Game Launch: Game Launch:
[<options>] <game_path> \t Start a game using the default emulator or\n\t\t\t\t\t\t the one defined in ES-DE for game or system [<options>] <game_path> \t Start a game using the default emulator or\n\t\t\t\t\t\t the one defined in ES-DE for game or system
@ -93,42 +81,17 @@ for i in "$@"; do
# shift # shift
# fi # fi
# ;; # ;;
--reset-component*) --reset*)
component="$2" component="${@:2}"
if [ -z "$component" ]; then if [ -z "$component" ]; then
echo "You are about to reset one or more RetroDECK components or emulators." echo "You are about to reset one or more RetroDECK components or emulators."
echo -e "Available options are:\nall, $pretty_resettable_components" echo -e "Available options are:\nall, $(prepare_component --list | tr ' ' ',' | sed 's/,/, /g')"
read -p "Please enter the component you would like to reset: " component read -p "Please enter the component you would like to reset: " component
component=$(echo "$component" | tr '[:upper:]' '[:lower:]') component=$(echo "$component" | tr '[:upper:]' '[:lower:]')
fi fi
log d "Resetting component: $component"
if [[ "$component" =~ ^(all|$resettable_components)$ ]]; then prepare_component "reset" "$component"
read -p "You are about to reset $component to default settings. Enter 'y' to continue, 'n' to stop: " response exit
if [[ $response == [yY] ]]; then
prepare_component "reset" "$component" "cli"
read -p "The process has been completed, press Enter key to start RetroDECK."
shift # Continue launch after previous command is finished
else
read -p "The process has been cancelled, press Enter key to exit."
exit
fi
else
echo "$component is not a valid selection, exiting..."
exit
fi
;;
--reset-retrodeck*)
echo "You are about to reset RetroDECK completely!"
read -p "Enter 'y' to continue, 'n' to stop: " response
if [[ $response == [yY] ]]; then
rm -f "$lockfile"
rm -f "$rd_conf"
read -p "The process has been completed, press Enter key to exit. Please run RetroDECK again to start the initial setup process."
exit 1
else
read -p "The process has been cancelled, press Enter key to exit."
exit
fi
;; ;;
--test-upgrade*) --test-upgrade*)
if [[ "$2" =~ ^.+ ]]; then if [[ "$2" =~ ^.+ ]]; then

201
tools/configurator.sh
View file

@ -23,7 +23,7 @@ source /app/libexec/global.sh
# - Toggle Universal Dynamic Input for Primehack # - Toggle Universal Dynamic Input for Primehack
# - PortMaster # - PortMaster
# - Open Component (Behind one-time power user warning dialog) # - Open Component (Behind one-time power user warning dialog)
# - Dynamically generated list of emulators from open_component --getlist and --getdesc (features.json) # - Dynamically generated list of emulators from open_component --list and --getdesc (features.json)
# - Reset Component # - Reset Component
# - Reset Emulator or Engine # - Reset Emulator or Engine
# - Reset RetroArch # - Reset RetroArch
@ -98,7 +98,7 @@ configurator_welcome_dialog() {
welcome_menu_options=( welcome_menu_options=(
"Settings" "Here you will find various presets, tweaks and settings to customize your RetroDECK experience" "Settings" "Here you will find various presets, tweaks and settings to customize your RetroDECK experience"
"Open Component" "Launch and configure each emulator or component's settings (for advanced users)" "Open Component" "Launch and configure each emulator or component's settings (for advanced users)"
"Reset Component" "Reset specific parts or all of RetroDECK" "Reset Components" "Reset specific parts or all of RetroDECK"
"Tools" "Games Compressor, move RetroDECK and install optional features" "Tools" "Games Compressor, move RetroDECK and install optional features"
"Steam Sync" "Sync all favorited games with Steam" "Steam Sync" "Sync all favorited games with Steam"
"Data Management" "Move RetroDECK folders between internal/SD card or to a custom location" "Data Management" "Move RetroDECK folders between internal/SD card or to a custom location"
@ -126,7 +126,7 @@ configurator_welcome_dialog() {
configurator_power_user_warning_dialog configurator_power_user_warning_dialog
;; ;;
"Reset Component" ) "Reset Components" )
log i "Configurator: opening \"$choice\" menu" log i "Configurator: opening \"$choice\" menu"
configurator_reset_dialog configurator_reset_dialog
;; ;;
@ -372,7 +372,7 @@ configurator_power_user_warning_dialog() {
configurator_open_emulator_dialog() { configurator_open_emulator_dialog() {
# This function displays a dialog to the user for selecting an emulator to open. # This function displays a dialog to the user for selecting an emulator to open.
# It first constructs a list of available emulators and their descriptions by reading # It first constructs a list of available emulators and their descriptions by reading
# from the output of `open_component --getlist` and `open_component --getdesc`. # from the output of `open_component --list` and `open_component --getdesc`.
# If certain settings (kiroi_ponzu or akai_ponzu) are enabled, it adds Yuzu and Citra # If certain settings (kiroi_ponzu or akai_ponzu) are enabled, it adds Yuzu and Citra
# to the list of emulators. # to the list of emulators.
# The function then uses `rd_zenity` to display a graphical list dialog with the # The function then uses `rd_zenity` to display a graphical list dialog with the
@ -383,8 +383,10 @@ configurator_open_emulator_dialog() {
local emulator_list=() local emulator_list=()
while IFS= read -r emulator && IFS= read -r desc; do while IFS= read -r emulator && IFS= read -r desc; do
emulator_list+=("$emulator" "$desc") if [[ "$emulator" != "RetroDECK" ]]; then
done < <(paste -d '\n' <(open_component --getlist) <(open_component --getdesc)) emulator_list+=("$emulator" "$desc")
fi
done < <(paste -d '\n' <(open_component --list) <(open_component --getdesc))
emulator=$(rd_zenity --list \ emulator=$(rd_zenity --list \
--title "RetroDECK Configurator Utility - Open Component" --cancel-label="Back" \ --title "RetroDECK Configurator Utility - Open Component" --cancel-label="Back" \
@ -979,163 +981,48 @@ configurator_check_multifile_game_structure() {
configurator_reset_dialog() { configurator_reset_dialog() {
local choices=( # This function displays a dialog to the user for selecting components to reset.
"Reset Emulator or Engine" "Reset only one specific emulator or engine to default settings" # It first constructs a list of available components and their descriptions by reading
"Reset RetroDECK Component" "Reset a single component, components are parts of RetroDECK that are not emulators" # from the features.json file.
"Reset All Emulators and Components" "Reset all emulators and components to default settings" # The function then uses `rd_zenity` to display a graphical checklist dialog with the
"Reset RetroDECK" "Reset RetroDECK to default settings" # available components and their descriptions.
) # If the user selects components, it calls `prepare_component` with the selected components.
# If the user cancels the dialog, it calls `configurator_welcome_dialog` to return to the welcome screen.
choice=$(rd_zenity --list --title="RetroDECK Configurator Utility - Reset Component" --cancel-label="Back" \ local components_list=()
while IFS= read -r emulator; do
# Extract the description and name of the current emulator using jq
desc=$(jq -r --arg emulator "$emulator" '.emulator[$emulator].description' "$features")
name=$(jq -r --arg emulator "$emulator" '.emulator[$emulator].name' "$features")
components_list+=("FALSE" "$emulator" "$name" "$desc")
done < <(prepare_component --list | tr ' ' '\n')
choice=$(rd_zenity --list \
--title "RetroDECK Configurator Utility - Reset Components" --cancel-label="Cancel" \
--window-icon="/app/share/icons/hicolor/scalable/apps/net.retrodeck.retrodeck.svg" --width=1200 --height=720 \ --window-icon="/app/share/icons/hicolor/scalable/apps/net.retrodeck.retrodeck.svg" --width=1200 --height=720 \
--column="Choice" --column="Action" \ --checklist --ok-label="Reset Selected" --extra-button="Reset All" \
"${choices[@]}") --print-column=2 \
--text="Which components do you want to reset?" \
--column "Reset" \
--column "Emulator" --hide-column=2 \
--column "Name" \
--column "Description" \
"${components_list[@]}")
local emulator_list=( if [[ $? == 0 && -n "$choice" ]]; then
"RetroArch" "Reset the multi-emulator frontend RetroArch to default settings" choice=$(echo "$choice" | tr '|' ' ')
"Cemu" "Reset the Wii U emulator Cemu to default settings" log d "User selected \"Reset Selected\" and selected: ${choice// / }"
"Dolphin" "Reset the Wii/GameCube emulator Dolphin to default settings" prepare_component "reset" ${choice// / }
"Duckstation" "Reset the PSX emulator Duckstation to default settings" configurator_process_complete_dialog "resetting selected emulators"
"GZDoom" "Reset the GZDoom Doom engine to default settings" elif [[ $? == 1 ]]; then
"MAME" "Reset the Multiple Arcade Machine Emulator (MAME) to default settings" log "User selected \"Reset All\""
"MelonDS" "Reset the NDS emulator MelonDS to default settings" prepare_ccomponent "reset" "all"
"PCSX2" "Reset the PS2 emulator PCSX2 to default settings" configurator_process_complete_dialog "resetting all emulators"
"PPSSPP" "Reset the PSP emulator PPSSPP to default settings"
"PortMaster" "Reset PortMaster to default settings"
"Primehack" "Reset the Metroid Prime emulator Primehack to default settings"
"Ruffle" "Reset the Flash emulator Ruffle to default settings"
"RPCS3" "Reset the PS3 emulator RPCS3 to default settings"
"Ryujinx" "Reset the Switch emulator Ryujinx to default settings"
"Steam ROM Manager" "Reset Steam ROM Manager to default settings"
"Vita3k" "Reset the PS Vita emulator Vita3k to default settings"
"XEMU" "Reset the XBOX emulator XEMU to default settings"
)
# Check if any ponzu is true before adding Yuzu or Citra to the list
if [[ $(get_setting_value "$rd_conf" "kiroi_ponzu" "retrodeck" "options") == "true" ]]; then
emulator_list+=("Yuzu" "Reset the Switch emulator Yuzu")
fi
if [[ $(get_setting_value "$rd_conf" "akai_ponzu" "retrodeck" "options") == "true" ]]; then
emulator_list+=("Citra" "Reset the 3DS emulator Citra")
fi
case $choice in
"Reset Emulator or Engine" )
log i "Configurator: opening \"$choice\" menu"
component_to_reset=$(rd_zenity --list \
--title "RetroDECK Configurator Utility - Reset Specific Standalone Emulator" --cancel-label="Back" \
--window-icon="/app/share/icons/hicolor/scalable/apps/net.retrodeck.retrodeck.svg" --width=1200 --height=720 \
--text="Which emulator or engine do you want to reset to default?" \
--column="Emulator" --column="Action" \
"${emulator_list[@]}")
case $component_to_reset in
"RetroArch" | "Vita3k" | "XEMU" ) # Emulators that require network access
if [[ $(check_network_connectivity) == "true" ]]; then
if [[ $(configurator_reset_confirmation_dialog "$component_to_reset" "Are you sure you want to reset the $component_to_reset emulator to default settings?\n\nThis process cannot be undone.") == "true" ]]; then
prepare_component "reset" "$component_to_reset" "configurator"
configurator_process_complete_dialog "resetting $component_to_reset"
else
configurator_generic_dialog "RetroDeck Configurator - Reset Component" "Reset process cancelled."
configurator_reset_dialog
fi
else
configurator_generic_dialog "RetroDeck Configurator - Reset Component" "Resetting this emulator requires active network access.\nPlease try again when you are connected to an Internet-capable network.\n\nReset process cancelled."
configurator_reset_dialog
fi
;;
"Cemu" | "Citra" | "Dolphin" | "Duckstation" | "GZDoom" | "Yuzu" | "MelonDS" | "MAME" | "PCSX2" | "PPSSPP" | "PortMaster" | "Primehack" | "Ruffle" | "RPCS3" | "Ryujinx" | "SteamROMManager" )
if [[ $(configurator_reset_confirmation_dialog "$component_to_reset" "Are you sure you want to reset the $component_to_reset emulator to default settings?\n\nThis process cannot be undone.") == "true" ]]; then
prepare_component "reset" "$component_to_reset" "configurator"
configurator_process_complete_dialog "resetting $component_to_reset"
else
configurator_generic_dialog "RetroDeck Configurator - Reset Component" "Reset process cancelled."
configurator_reset_dialog
fi
;;
"" ) # No selection made or Back button clicked
configurator_reset_dialog
;;
esac
;;
"Reset RetroDECK Component" )
component_to_reset=$(rd_zenity --list \
--title "RetroDECK Configurator Utility - Reset Specific RetroDECK Component" --cancel-label="Back" \
--window-icon="/app/share/icons/hicolor/scalable/apps/net.retrodeck.retrodeck.svg" --width=1200 --height=720 \
--text="Which component do you want to reset to default settings?" \
--column="Component" --column="Action" \
"Steam ROM Manager" "Reset SRM that manages the sync and scraping toward Steam library" \
"ES-DE" "Reset the ES-DE frontend" \ )
# TODO: "GyroDSU" "Reset the gyroscope manager GyroDSU"
case $component_to_reset in
"Steam ROM Manager" | "ES-DE" ) # TODO: GyroDSU
if [[ $(configurator_reset_confirmation_dialog "$component_to_reset" "Are you sure you want to reset $component_to_reset to default settings?\n\nThis process cannot be undone.") == "true" ]]; then
prepare_component "reset" "$component_to_reset" "configurator"
configurator_process_complete_dialog "resetting $component_to_reset"
else
configurator_generic_dialog "RetroDeck Configurator - Reset Component" "Reset process cancelled."
configurator_reset_dialog
fi
;;
"" ) # No selection made or Back button clicked
configurator_reset_dialog
;;
esac
;;
"Reset All Emulators and Components" )
log i "Configurator: opening \"$choice\" menu"
if [[ $(check_network_connectivity) == "true" ]]; then
if [[ $(configurator_reset_confirmation_dialog "all emulators" "Are you sure you want to reset all emulators to default settings?\n\nThis process cannot be undone.") == "true" ]]; then
(
prepare_component "reset" "all"
) |
rd_zenity --icon-name=net.retrodeck.retrodeck --progress --no-cancel --pulsate --auto-close \
--window-icon="/app/share/icons/hicolor/scalable/apps/net.retrodeck.retrodeck.svg" \
--title "RetroDECK Finishing Initialization" \
--text="RetroDECK is finishing the reset process, please wait."
configurator_process_complete_dialog "resetting all emulators"
else
configurator_generic_dialog "RetroDeck Configurator - Reset Component" "Reset process cancelled."
configurator_reset_dialog
fi
else else
configurator_generic_dialog "RetroDeck Configurator - Reset Component" "Resetting all emulators requires active network access.\nPlease try again when you are connected to an Internet-capable network.\n\nReset process cancelled." log d "User selected \"Cancel\""
configurator_reset_dialog configurator_welcome_dialog
fi fi
;;
"Reset RetroDECK" )
log i "Configurator: opening \"$choice\" menu"
if [[ $(configurator_reset_confirmation_dialog "RetroDECK" "Are you sure you want to reset RetroDECK entirely?\n\nThis process cannot be undone.") == "true" ]]; then
rd_zenity --icon-name=net.retrodeck.retrodeck --info --no-wrap \
--window-icon="/app/share/icons/hicolor/scalable/apps/net.retrodeck.retrodeck.svg" \
--title "RetroDECK Configurator Utility - Reset RetroDECK" \
--text="You are resetting RetroDECK to its default state.\n\nAfter the process is complete you will need to exit RetroDECK and run it again, where you will go through the initial setup process."
rm -f "$lockfile"
rm -f "$rd_conf"
configurator_process_complete_dialog "resetting RetroDECK"
else
configurator_generic_dialog "RetroDeck Configurator - Reset Component" "Reset process cancelled."
configurator_reset_dialog
fi
;;
"" ) # No selection made or Back button clicked
configurator_welcome_dialog
;;
esac
} }
configurator_about_retrodeck_dialog() { configurator_about_retrodeck_dialog() {