Feat/satellaview

automation-tools/alchemist/version_policy.sh

@@ -379,6 +379,13 @@ export XENIA_EDGE_VERSION_POLICY="newest"
 # ------------------------------------------------------------------------------
 export ZESARUX_VERSION_POLICY="latest"
 
+# ------------------------------------------------------------------------------
+# Satellaview - Super Famicom Add-on
+# ------------------------------------------------------------------------------
+export SATELLAVIEW_PLUS_VERSION_POLICY="V5"
+export SATELLAVIEW_PLUS_SNES9X_VERSION_POLICY="latest"
+
+
 
 
 # ==============================================================================

satellaview_plus/LICENSE

@@ -0,0 +1 @@
+Satellite tuning sound by https://pixabay.com/users/freesound_community-46691455/

satellaview_plus/TODO.txt

@@ -0,0 +1,4 @@
+snes9x:
+- controller config
+
+what about load/save state?

satellaview_plus/component_functions.sh

@@ -0,0 +1,161 @@
+#!/bin/bash
+
+export satellaview_plus_download_path="$storage_path/satellaview_plus/"
+export satellaview_plus_bsx_path="$storage_path/satellaview_plus/roms/bs-x"
+export satellaview_plus_config_path="$XDG_CONFIG_HOME/satellaview_plus"
+export satellaview_plus_rd_config_dir="$rd_components/satellaview_plus/rd_config"
+export satellaview_plus_esde_assets_dir="$rd_components/satellaview_plus/es-de"
+export satellaview_plus_config_file="$satellaview_plus_config_path/config.json"
+export satellaview_plus_snes9x_config="$XDG_CONFIG_HOME/satellaview_plus/snes9x/snes9x/snes9x.conf"
+export satellaview_soundlink_stream="https://howlingf-gecko.radioca.st/stream"
+
+_set_setting_value::satellaview_plus() {
+
+  local file="$1"
+
+  if [[ "$file" =~ \.json$ ]]; then
+
+    local name="$2" value="$3"
+
+    local tmp_file
+    tmp_file="$(mktemp)"
+
+    jq --arg name "$name" --arg value "$value" '.[$name] = $value' "$file" > "$tmp_file" && mv -f "$tmp_file" "$file"
+
+  elif [[ "$file" =~ \.conf$ ]]; then
+
+    local name=$(sed_escape_pattern "$2") value=$(sed_escape_replacement "$3") section="${4:-}"
+
+    if [[ -n "$section" ]]; then
+      section=$(sed_escape_pattern "$section")
+      sed -i '\^\['"$section"'\]^,\^\^'"$name"'[[:space:]]*=^s^\^'"$name"'[[:space:]]*=.*^'"$name"' = '"$value"'^' "$file"
+    else
+      sed -i 's^\^'"$name"'[[:space:]]*=.*^'"$name"' = '"$value"'^' "$file"
+    fi
+
+  fi
+
+}
+
+_get_setting_value::satellaview_plus() {
+  local file="$1" name="$2" section="${3:-}"
+
+  if [[ "$file" =~ \.json$ ]]; then
+
+    if [[ -z "$section" ]]; then
+      jq -r --arg name "$name" '.[$name] // empty' "$file"
+    elif jq -e --arg section "$section" '.presets | has($section)' "$file" > /dev/null 2>&1; then
+      jq -r --arg section "$section" --arg name "$name" \
+        '.presets[$section] | .. | objects | select(has($name)) | .[$name] // empty' "$file"
+    else
+      local section_parts section_json
+      IFS='.' read -ra section_parts <<< "$section"
+      section_json=$(printf '%s\n' "${section_parts[@]}" | jq -R . | jq -sc .)
+      jq -r --argjson path "$section_json" --arg name "$name" \
+        'getpath($path + [$name]) // empty' "$file"
+    fi
+
+  elif [[ "$file" =~ \.conf$ ]]; then
+
+    if [[ -n "$section" ]]; then
+      KEY="$name" SECTION="[$section]" awk -F'=' \
+        'NR==1 { sub(/^\xEF\xBB\xBF/, "") }
+        BEGIN { key=ENVIRON["KEY"]; section=ENVIRON["SECTION"] }
+        $0 == section { in_section=1; next }
+        /^\[/ { in_section=0 }
+        in_section && $0 ~ "^" key "[[:space:]]*=" {
+          gsub(/^[[:space:]]*/, "", $2)
+          print $2; exit
+        }' "$file"
+    else
+      KEY="$name" awk -F'=' \
+        'NR==1 { sub(/^\xEF\xBB\xBF/, "") }
+        BEGIN { key=ENVIRON["KEY"] }
+        $0 ~ "^" key "[[:space:]]*=" {
+          gsub(/^[[:space:]]*/, "", $2)
+          print $2; exit
+        }' "$file"
+    fi
+
+  fi
+}
+
+_prepare_component::satellaview_plus() {
+  local action="$1"
+  shift
+
+  local component_path="$(get_own_component_path)"
+
+  case "$action" in
+
+    reset)
+      log i "-----------------------"
+      log i "Resetting Satellaview+"
+      log i "-----------------------"
+
+      log i "Clearing BS-X satellite data directory"
+      create_dir -d "$satellaview_plus_download_path"
+
+      log i "Clearing BS-X ROM directory"
+      create_dir -d "$satellaview_plus_bsx_path"
+
+      log i "Initializing Satellaview+ Launcher configuration"
+      create_dir -d "$satellaview_plus_config_path"
+      cp -fv "$satellaview_plus_rd_config_dir/config.json" "$satellaview_plus_config_file"
+      set_setting_value "$satellaview_plus_config_file" "DownloadLocation" "$satellaview_plus_download_path" "satellaview_plus"
+
+      log i "Initializing Snes9x configuration for Satellaview+"
+      create_dir -d "$(dirname "$satellaview_plus_snes9x_config")"
+      cp -fv "$satellaview_plus_rd_config_dir/snes9x.conf" "$satellaview_plus_snes9x_config"
+      set_setting_value "$satellaview_plus_snes9x_config" "SRAMDirectory" "$saves_path/satellaview_plus" "satellaview_plus" "Files"
+      set_setting_value "$satellaview_plus_snes9x_config" "SaveStateDirectory" "$states_path/satellaview_plus" "satellaview_plus" "Files"
+
+      log i "Creating ROMs directory and copying launchers"
+      create_dir "$roms_path/satellaview_plus"
+      cp -rfv "$satellaview_plus_esde_assets_dir/launchers/"* "$roms_path/satellaview_plus/"
+
+      log i "Populating gamelist.xml for ES-DE"
+      local source_gamelist="$component_path/es-de/gamelist/gamelist.xml"
+      local dest_gamelist="$rd_home_path/ES-DE/gamelists/satellaview_plus/gamelist.xml"
+      create_dir "$(dirname "$dest_gamelist")"
+
+      log i "Populating ES-DE media assets"
+      create_dir "$rd_home_path/ES-DE/downloaded_media/satellaview_plus"
+      cp -rfv "$satellaview_plus_esde_assets_dir/downloaded_media/satellaview_plus/"* "$rd_home_path/ES-DE/downloaded_media/satellaview_plus/"
+    ;;
+
+  esac
+}
+
+satellaview_toggle_soundlink(){
+
+  if [[ "$(get_component_option satellaview_plus satellaview_plus_soundlink_stream_toggle)" == "true" ]]; then
+    local status="enabled"
+  else
+    local status="disabled"
+  fi
+
+  zenity --question --no-wrap \
+          --window-icon="/app/share/icons/hicolor/scalable/apps/net.retrodeck.retrodeck.svg" \
+          --title "RetroDECK: Satellaview+ - Toggle Soundlink+ Stream" \
+          --text="Soundlink+ stream is currently $status.\n\nDo you want to toggle it?"
+
+  # If not cancel
+  if [[ $? -eq 0 ]]; then
+
+    if [[ "$(get_component_option satellaview_plus satellaview_plus_soundlink_stream_toggle)" == "true" ]]; then
+      set_component_option "satellaview_plus" "satellaview_plus_soundlink_stream_toggle" "false" && log i "Soundlink+ stream disabled"
+      zenity --info --no-wrap \
+            --window-icon="/app/share/icons/hicolor/scalable/apps/net.retrodeck.retrodeck.svg" \
+            --title "RetroDECK: Satellaview+ - Soundlink+ Stream" \
+            --text="Soundlink+ stream is now disabled.\n\nYou should start hearing the music within a few seconds after launching a game.\n\nMake sure to have your audio output set up correctly and enjoy the authentic Satellaview+ experience!"
+    else
+      set_component_option "satellaview_plus" "satellaview_plus_soundlink_stream_toggle" "true" && log i "Soundlink+ stream enabled"
+      zenity --info --no-wrap \
+            --window-icon="/app/share/icons/hicolor/scalable/apps/net.retrodeck.retrodeck.svg" \
+            --title "RetroDECK: Satellaview+ - Soundlink+ Stream" \
+            --text="Soundlink+ stream is now enabled.\n\nYou will no longer hear the music from the Soundlink+ stream when launching a game."
+    fi
+
+  fi
+}

satellaview_plus/component_launcher.sh

@@ -0,0 +1,114 @@
+#!/bin/bash
+
+source /app/libexec/launcher_functions.sh
+source /app/libexec/components.sh
+
+if [[ ! -f "$roms_path/satellaview_plus/bs-x.sfc" ]]; then
+  zenity --error --no-wrap \
+        --window-icon="/app/share/icons/hicolor/scalable/apps/net.retrodeck.retrodeck.svg" \
+        --title "RetroDECK: Satellaview+ - Error: ROM not found" \
+        --text="Satellaview+ ROM not found.\n\nPlease provide the 'bs-x.sfc' ROM file in the\n\n'$roms_path/satellaview_plus'\n\ndirectory and try again.\n\nNote: you would need either an \"English + No DRM\" or \"Japanese + No DRM\" version to work with Satellaview+.\nRun the BIOS Checker Tool in the Configurator for more information about the required ROMs and their checksums."
+  exit 1
+else
+  cp "$roms_path/satellaview_plus/bs-x.sfc" "$satellaview_plus_bsx_path/bs-x.sfc"
+  # TODO: if we need to patch the roms we can do it here
+fi
+
+# Setting component name and path based on the directory name
+component_name="$(basename "$(dirname "$(readlink -f "${BASH_SOURCE[0]}")")")"
+component_path="$(cd "$(dirname "${BASH_SOURCE[0]}" )" && pwd)"
+
+log i "RetroDECK is now launching $component_name"
+log d "Library path is: $LD_LIBRARY_PATH"
+
+satellaview_tuner() {
+
+    export LD_LIBRARY_PATH="$component_path/usr/lib/:$component_path/lib:$rd_shared_libs:${DEFAULT_LD_LIBRARY_PATH}"
+    export QT_PLUGIN_PATH="${QT_PLUGIN_PATH}"
+    export QT_QPA_PLATFORM_PLUGIN_PATH="${QT_QPA_PLATFORM_PLUGIN_PATH}"
+
+    log i "Opening Satellaview+ Tuner command"
+
+    # We move here because the config file is read from ./
+    cd "$satellaview_plus_config_path"
+    exec "$component_path/AppRun"
+
+}
+
+run_satellaview(){
+
+    export satellaview_plus_download_path="$storage_path/satellaview_plus/"
+    export satellaview_plus_bsx_path="$storage_path/satellaview_plus/roms/bs-x"
+
+    log i "Running Satellaview+ SNES9X"
+
+    cd "$storage_path/satellaview_plus/"
+
+    # WORKAROUND: the launcher is supposed to move the doiwnloaded satdata into the rom folder (in storage) but is not doing it,
+    # so we are symlinking it by ourselves before launching the game and cleaning it up later
+    ln -s "$satellaview_plus_download_path/satdata/"* "$satellaview_plus_bsx_path/"
+
+    if [ "$(get_component_option satellaview_plus satellaview_plus_soundlink_stream_toggle)" == "true" ]; then
+
+      log i "Soundlink+ stream toggle is enabled, starting the stream"
+
+      # Start soundlink+ streaming in the background
+      ffplay -nodisp -autoexit "$satellaview_soundlink_stream" >/dev/null 2>&1 &
+      STREAM_PID=$!
+
+      # Auto cleanup the stream when the game is closed
+      cleanup() {
+          kill "$STREAM_PID" 2>/dev/null
+      }
+
+      trap cleanup EXIT INT TERM
+
+    else
+      log i "Soundlink+ stream toggle is disabled, skipping the stream"
+    fi
+
+    XDG_CONFIG_HOME="$XDG_CONFIG_HOME/satellaview_plus/snes9x" "$component_path/bin/snes9x-gtk" "$satellaview_plus_bsx_path/bs-x.sfc"
+
+    # Cleanup the symlinks after the game is closed
+    log d "Cleaning up symlinks in BS-X ROM directory"
+    find "$satellaview_plus_bsx_path" -type l -delete
+
+}
+
+# This function is called by the .sh launchers in the rom folder and it decides which command to run based on the content of the launcher script
+if [[ -f "$1" ]]; then
+  log i "Reading command from file '$1'"
+    command=$(cat "$1")
+    log i "Command read from file '$1': $command"
+elif [[ -n "$1" ]]; then
+    log i "\"$1\" appears to be a command argument. Using the argument as command."
+    command="$1"
+else
+    log w "Command file '$1' not found, falling back to default run command"
+    command="run"
+fi
+
+case $command in
+
+  tuner|--tuner|-t)
+    satellaview_tuner
+  ;;
+
+  run|--run|-r)
+    run_satellaview
+  ;;
+
+  help|--help|-h)
+    log i "Available commands in the launcher script:"
+    log i "  tuner, --tuner, -t: Launch the Satellaview+ Tuner"
+    log i "  run, --run, -r: Run the Satellaview+ SNES9X emulator"
+    log i "  help, --help, -h: Show this help message"
+  ;;
+
+  *)
+    log e "Unknown command '$command' in launcher script '$1'"
+    log w "Falling back to Satellaview+ run command"
+    run_satellaview
+  ;;
+
+esac