diff --git a/config/retrodeck/reference_lists/features.json b/config/retrodeck/reference_lists/features.json index 1612bfb1..8732bb1a 100644 --- a/config/retrodeck/reference_lists/features.json +++ b/config/retrodeck/reference_lists/features.json @@ -960,8 +960,7 @@ "system": [ "arcade" ], - "launch": "mame", - "launch-args": "-inipath /var/config/mame/ini -rompath $(dirname \"$game\") $game" + "launch": "mame" }, "citra": { "description": "Citra Nintendo 3DS Emulator (via Ponzu)", @@ -997,7 +996,6 @@ "url": "https://retrodeck.readthedocs.io/en/latest/wiki_emulator_guides/pcsx2/pcsx2-guide/", "system": "ps2", "launch": "pcsx2-qt", - "launch-args": "-batch $game", "properties": [ { "ask_to_exit": true, @@ -1010,7 +1008,6 @@ "description": "PlayStation Emulator", "url": "https://retrodeck.readthedocs.io/en/latest/wiki_emulator_guides/duckstation/duckstation-guide/", "launch": "duckstation-qt", - "launch-args": "-batch $game", "system": "psx", "properties": [ { @@ -1037,8 +1034,7 @@ "description": "Vita3K PSVita Emulator", "url": "https://retrodeck.readthedocs.io/en/latest/wiki_emulator_guides/vita3k/vita3k-guide/", "system": "psvita", - "launch": "Vita3K", - "launch-args": "-r $game.psvita" + "launch": "Vita3K" }, "rpcs3": { "name": "RPCS3", @@ -1066,7 +1062,6 @@ "url": "https://retrodeck.readthedocs.io/en/latest/wiki_about/what-is-retrodeck/", "launch": "Yuzu", "system": "switch", - "launch-args": "-f -g $game", "ponzu": true, "abxy_button": true }, @@ -1075,7 +1070,6 @@ "description": "Dolphin Wii and GameCube Emulator", "url": "https://retrodeck.readthedocs.io/en/latest/wiki_emulator_guides/dolphin-primehack/dolphin-primehack-guide/", "launch": "dolphin-emu-wrapper", - "launch-args": "-e $game", "system": [ "gc", "wii" @@ -1095,7 +1089,6 @@ "description": "A fork of Dolphiin to enhance Metroid Prime experience", "url": "https://retrodeck.readthedocs.io/en/latest/wiki_emulator_guides/dolphin-primehack/dolphin-primehack-guide/", "launch": "primehack-wrapper", - "launch-args": "-e $game", "system": [ "wii" ], @@ -1112,7 +1105,6 @@ "url": "https://retrodeck.readthedocs.io/en/latest/wiki_emulator_guides/cemu/cemu-guide/", "system": "wiiu", "launch": "Cemu-wrapper", - "launch-args": "-g $game", "properties": [ { "abxy_button": true, @@ -1125,8 +1117,7 @@ "name": "xemu", "url": "https://retrodeck.readthedocs.io/en/latest/wiki_emulator_guides/xemu/xemu-guide/", "system": "xbox", - "launch": "xemu", - "launch-args": "-dvd_path $game" + "launch": "xemu" }, "es-de": { "description": "ES-DE Emulation Frontend", diff --git a/developer_toolbox/hooks/pre-commit b/developer_toolbox/hooks/pre-commit new file mode 100755 index 00000000..31210b0a --- /dev/null +++ b/developer_toolbox/hooks/pre-commit @@ -0,0 +1,25 @@ +#!/bin/bash +# A pre-commit hook to lint features.json if it is edited + +# Check if any path contains 'features.json' +if git diff --cached --name-only | grep -q 'config/retrodeck/reference_lists/features.json'; then + # Run the linting script + echo "Linting config/retrodeck/reference_lists/features.json..." + if ! bash developer_toolbox/lint_features.json.sh; then + echo "Linting failed. Please fix the issues and try again." + exit 1 # Exit with a non-zero status to block the commit + fi +fi + +# Lint Manifest +# if git diff --cached --name-only | grep -q 'net.retrodeck.retrodeck.yml'; then +# # Run the linting script +# echo "Linting net.retrodeck.retrodeck.yml..." +# if ! bash developer_toolbox/lint_manifest.sh; then +# echo "Linting failed. Please fix the issues and try again." +# exit 1 # Exit with a non-zero status to block the commit +# fi +# fi + +# Continue with the commit if all checks passed +exit 0 diff --git a/developer_toolbox/install_hooks.sh b/developer_toolbox/install_hooks.sh new file mode 100755 index 00000000..d2510ce0 --- /dev/null +++ b/developer_toolbox/install_hooks.sh @@ -0,0 +1,4 @@ +#!/bin/bash + +mkdir -p .git/hooks +cp -f developer_toolbox/hooks/* .git/hooks \ No newline at end of file diff --git a/developer_toolbox/lint_manifest.sh b/developer_toolbox/lint_manifest.sh new file mode 100755 index 00000000..9147e142 --- /dev/null +++ b/developer_toolbox/lint_manifest.sh @@ -0,0 +1,3 @@ +#!/bin/bash + +yamllint net.retrodeck.retrodeck.yml diff --git a/functions/other_functions.sh b/functions/other_functions.sh index a16e1453..3942827e 100644 --- a/functions/other_functions.sh +++ b/functions/other_functions.sh @@ -909,11 +909,62 @@ start_retrodeck() { es-de } +find_emulator() { + local emulator_name=$1 + local found_path="" + local es_find_rules="/app/share/es-de/resources/systems/linux/es_find_rules.xml" + + # Search the es_find_rules.xml file for the emulator + emulator_section=$(xmllint --xpath "//emulator[@name='$emulator_name']" "$es_find_rules" 2>/dev/null) + + if [ -z "$emulator_section" ]; then + log e "Emulator not found: $emulator_name" + return 1 + fi + + # Search systempath entries + while IFS= read -r line; do + command_path=$(echo "$line" | sed -n 's/.*\(.*\)<\/entry>.*/\1/p') + if [ -x "$(command -v $command_path)" ]; then + found_path=$command_path + break + fi + done <<< "$(echo "$emulator_section" | xmllint --xpath "//rule[@type='systempath']/entry" - 2>/dev/null)" + + # If not found, search staticpath entries + if [ -z "$found_path" ]; then + while IFS= read -r line; do + command_path=$(eval echo "$line" | sed -n 's/.*\(.*\)<\/entry>.*/\1/p') + if [ -x "$command_path" ]; then + found_path=$command_path + break + fi + done <<< "$(echo "$emulator_section" | xmllint --xpath "//rule[@type='staticpath']/entry" - 2>/dev/null)" + fi + + if [ -z "$found_path" ]; then + log e "No valid path found for emulator: $emulator_name" + return 1 + else + log d "Found emulator: \"$found_path\"" + echo "$found_path" + return 0 + fi +} + + +# TODO: add the logic of alt emulator and default emulator + run_game() { + # call me with (-e emulator) (-s system) game/path, examples: + # run_game -e gambatte_libretro ~/retrodeck/roms/gb/Capumon.gb + # run_game ~/retrodeck/roms/gb/Capumon.gb + # run_game -s gbc ~/retrodeck/roms/gb/Capumon.gb # Initialize variables emulator="" system="" + es_systems="/app/share/es-de/resources/systems/linux/es_systems.xml" # Parse options while getopts ":e:s:" opt; do @@ -934,8 +985,8 @@ run_game() { # Check for game argument if [[ -z "$1" ]]; then - echo "Error: Game file is required." - echo "Usage: $0 --run [-e emulator] [-s system] game" + log e "Game path is required." + log i "Usage: $0 start [-e emulator] [-s system] game" exit 1 fi @@ -946,87 +997,165 @@ run_game() { system=$(echo "$game" | grep -oP '(?<=roms/)[^/]+') fi - log d "Emulator: $emulator" - log d "System: $system" - log d "Game: $game" + log d "Game: \"$game\"" + log d "System: \"$system\"" - # Query the features JSON for emulators that support the system - local emulators=$(jq -r --arg system "$system" ' - .emulator | to_entries[] | - select( - (.value.system == $system) or - (.value.system[]? == $system) - ) | .key' "$features") + # Function to handle the %INJECT% placeholder + # When %INJECT%=filename is found in the game command it will check for the existence of the file + # If the file is found the "%INJECT%=file" will be replaced with the contents of the found file + handle_inject_placeholder() { + local cmd="$1" + local rom_dir=$(dirname "$game") # Get the ROM directory based on the game path - # Check if the system is handled by RetroArch cores - local retroarch_cores=$(jq -r --arg system "$system" ' - .emulator.retroarch.cores | to_entries[] | - select( - .value.system == $system or - (.value.system[]? == $system) - ) | .key' "$features") + # Find and process all occurrences of %INJECT%='something'.extension + while [[ "$cmd" =~ (%INJECT%=\'([^\']+)\')(.[^ ]+)? ]]; do + inject_file="${BASH_REMATCH[2]}" # Extract the quoted file name + extension="${BASH_REMATCH[3]}" # Extract the extension (if any) + inject_file_full_path="$rom_dir/$inject_file$extension" # Form the full path - # if the emulator is given and it's a retroarch core just execute it - if [[ "$emulator" == *"_libretro" ]]; then - local core_path="/var/config/retroarch/cores/$emulator.so" - log d "Running RetroArch core: $core_path" - log d "Command: retroarch -L $core_path \"$game\"" - eval "retroarch -L $core_path \"$game\"" - return 1 - fi + log d "Found inject part: %INJECT%='$inject_file'$extension" - # If the system is handled by RetroArch cores, add them to the list of emulators - if [[ -n "$retroarch_cores" ]]; then - emulators=$(echo -e "$emulators\n$retroarch_cores") - fi + # Check if the file exists + if [[ -f "$inject_file_full_path" ]]; then + # Read the content of the file and replace newlines with spaces + inject_content=$(cat "$inject_file_full_path" | tr '\n' ' ') + log i "File \"$inject_file_full_path\" found. Replacing %INJECT% with content." - local pretty_system=$(jq -r --arg system "$system" '.system[$system].name' "$features") + # Escape special characters in the inject part for the replacement + escaped_inject_part=$(printf '%s' "%INJECT%='$inject_file'$extension" | sed 's/[]\/$*.^[]/\\&/g') - # Check if multiple emulators are found and prompt the user to select one with zenity - if [[ $(echo "$emulators" | wc -l) -gt 1 ]]; then - emulator=$(echo "$emulators" | zenity --list --title="Select Emulator" --text="Multiple emulators found for $pretty_system. Select one to run." --column="Emulator") - else - emulator="$emulators" - fi + # Replace the entire %INJECT%=...'something'.extension part with the file content + cmd=$(echo "$cmd" | sed "s|$escaped_inject_part|$inject_content|g") - # If no emulator was selected, exit - if [[ -z "$emulator" ]]; then - log e "No emulator selected. Exiting." - return 1 - fi + log d "Replaced cmd: $cmd" + else + log e "File \"$inject_file_full_path\" not found. Removing %INJECT% placeholder." - log d "Run game: selected emulator $emulator" + # Use sed to remove the entire %INJECT%=...'something'.extension + escaped_inject_part=$(printf '%s' "%INJECT%='$inject_file'$extension" | sed 's/[]\/$*.^[]/\\&/g') + cmd=$(echo "$cmd" | sed "s|$escaped_inject_part||g") - # Handle RetroArch core separately - if [[ "$emulator" == *"_libretro" ]]; then - local core_path="/var/config/retroarch/cores/$emulator.so" - log d "Running RetroArch core: $core_path" - log d "Command: retroarch -L $core_path \"$game\"" - eval "retroarch -L $core_path \"$game\"" - else - # Check if launch-override exists - local launch_override=$(jq -r ".emulator.$emulator.\"launch-override\"" "$features") - if [[ "$launch_override" != "null" ]]; then - # Use launch-override - launch_override=${launch_override//\$game/\"$game\"} - log d "Using launch-override: $launch_override" - eval "$launch_override" - else - # Use standard launch and launch-args - local launch_command=$(jq -r ".emulator.$emulator.launch" "$features") - local launch_args=$(jq -r ".emulator.$emulator.\"launch-args\"" "$features") - log d "launch args: $launch_args" + log d "sedded cmd: $cmd" + fi + done - # Only add launch_args if they are not null - if [[ "$launch_args" != "null" ]]; then - # Replace $game in launch_args with the actual game path, quoting it to handle spaces - launch_args=${launch_args//\$game/\"$game\"} - log d "Command: \"$launch_command $launch_args\"" - eval "$launch_command $launch_args" - else - log d "Command: \"$launch_command\"" - eval "$launch_command \"$game\"" + log d "Returning the command with injected content: $cmd" + echo "$cmd" + } + + + # Function to replace %EMULATOR_SOMETHING% with the actual path of the emulator + replace_emulator_placeholder() { + local placeholder=$1 + # Extract emulator name from placeholder without changing case + local emulator_name="${placeholder//"%EMULATOR_"/}" # Extract emulator name after %EMULATOR_ + emulator_name="${emulator_name//"%"/}" # Remove the trailing % + + # Use the find_emulator function to get the emulator path using the correct casing + local emulator_exec=$(find_emulator "$emulator_name") + + if [[ -z "$emulator_exec" ]]; then + log e "Emulator '$emulator_name' not found." + exit 1 fi - fi + echo "$emulator_exec" + } + + # Function to substitute the placeholders + substitute_placeholders() { + local cmd="$1" + local rom_path="$game" + local rom_dir=$(dirname "$rom_path") + + # Strip all file extensions from the base name + local base_name=$(basename "$rom_path") + base_name="${base_name%%.*}" + + local file_name=$(basename "$rom_path") + local rom_raw="$rom_path" + local rom_dir_raw="$rom_dir" + local es_path="" + local emulator_path="" + + # Manually replace %EMULATOR_*% placeholders + while [[ "$cmd" =~ (%EMULATOR_[A-Z0-9_]+%) ]]; do + placeholder="${BASH_REMATCH[1]}" + emulator_path=$(replace_emulator_placeholder "$placeholder") + cmd="${cmd//$placeholder/$emulator_path}" + done + + # Substitute %BASENAME% and other placeholders + cmd="${cmd//"%BASENAME%"/"'$base_name'"}" + cmd="${cmd//"%FILENAME%"/"'$file_name'"}" + cmd="${cmd//"%ROMRAW%"/"'$rom_raw'"}" + cmd="${cmd//"%ROMPATH%"/"'$rom_dir'"}" + + # Ensure paths are quoted correctly + cmd="${cmd//"%ROM%"/"'$rom_path'"}" + cmd="${cmd//"%GAMEDIR%"/"'$rom_dir'"}" + cmd="${cmd//"%GAMEDIRRAW%"/"'$rom_dir_raw'"}" + cmd="${cmd//"%CORE_RETROARCH%"/"/var/config/retroarch/cores"}" + + log d "Command after %BASENAME% and other substitutions: $cmd" + + # Now handle %INJECT% after %BASENAME% has been substituted + cmd=$(handle_inject_placeholder "$cmd") + + echo "$cmd" + } + + # Extracting the commands from es_systems.xml for the selected system + find_system_commands() { + local system_name=$system + # Use xmllint to extract the system commands from the XML + system_section=$(xmllint --xpath "//system[name='$system_name']" "$es_systems" 2>/dev/null) + + if [ -z "$system_section" ]; then + log e "System not found: $system_name" + exit 1 + fi + + # Extract commands and labels + commands=$(echo "$system_section" | xmllint --xpath "//command" - 2>/dev/null) + + # Prepare Zenity command list + command_list=() + while IFS= read -r line; do + label=$(echo "$line" | sed -n 's/.*label="\([^"]*\)".*/\1/p') + command=$(echo "$line" | sed -n 's/.*]*>\(.*\)<\/command>.*/\1/p') + + # Substitute placeholders in the command + command=$(substitute_placeholders "$command") + + # Add label and command to Zenity list (label first, command second) + command_list+=("$label" "$command") + done <<< "$commands" + + # Check if there's only one command + if [ ${#command_list[@]} -eq 2 ]; then + log d "Only one command found for $system_name, running it directly: ${command_list[1]}" + selected_command="${command_list[1]}" + else + # Show the list with Zenity and return the **command** (second column) selected + selected_command=$(zenity --list \ + --title="Select an emulator for $system_name" \ + --column="Emulator" --column="Hidden Command" "${command_list[@]}" \ + --width=800 --height=400 --print-column=2 --hide-column=2) + fi + + echo "$selected_command" + } + + # If the emulator is not specified, ask the user to select it or get it from the XML file + if [[ -z "$emulator" ]]; then + emulator=$(find_system_commands) + fi + + if [[ -n "$emulator" ]]; then + log d "Running: $emulator" + eval "$emulator" + else + log e "No emulator found or selected. Exiting." + return 1 fi } \ No newline at end of file diff --git a/retrodeck.sh b/retrodeck.sh index e76f8df0..94be9b78 100644 --- a/retrodeck.sh +++ b/retrodeck.sh @@ -32,7 +32,7 @@ Arguments: --reset-component \t Reset one or more component or emulator configs to the default values --reset-retrodeck \t Starts the initial RetroDECK installer (backup your data first!) - --run [-s ] [-e ] \t Run a game from cli, if no system is defined it will deducted from the path.\n\t\t\t\t\t\t For example --run ~/retrodeck/roms/system/game.ext will be run with the system "system".\n\t\t\t\t\t\t Optionally -e (emulator) and -s (system) can be passed as arguments. + start [-s ] [-e ] \t Start a game from cli, if no system is defined it will deducted from the path.\n\t\t\t\t\t\t For example flatpak run net.retrodeck.retrodeck start ~/retrodeck/roms/system/game.ext will be run with the system "system".\n\t\t\t\t\t\t Optionally -e (emulator) and -s (system) can be passed as arguments. For flatpak run specific options please run: flatpak run -h @@ -44,8 +44,8 @@ https://retrodeck.net echo "RetroDECK v$version" exit ;; - --run*) - shift # Remove --run + start*) + shift # Remove "start" run_game "$@" exit ;;