Skip to content

initial rework of fgmod to make install more cannonical to upstream opti #165

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Open
xXJSONDeruloXx wants to merge 1 commit into
base: main
Choose a base branch
from
Open

initial rework of fgmod to make install more cannonical to upstream opti #165

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
125 changes: 48 additions & 77 deletions defaults/assets/fgmod.sh
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -16,8 +16,8 @@ error_exit() {

# === CONFIG ===
fgmod_path="$HOME/fgmod"
dll_name="${DLL:-dxgi.dll}"
preserve_ini="${PRESERVE_INI:-true}"
opti_path="$fgmod_path/opti"
int8_path="$fgmod_path/int8"

# === Resolve Game Path ===
if [[ "$#" -lt 1 ]]; then
Expand Down Expand Up @@ -93,83 +93,64 @@ fi
[[ ! -w "$exe_folder_path" ]] && error_exit "🛑 No write permission to the game folder!"

logger -t fgmod "🟢 Target directory: $exe_folder_path"
logger -t fgmod "🧩 Using DLL name: $dll_name"
logger -t fgmod "📄 Preserve INI: $preserve_ini"

# === Cleanup Old Injectors ===
rm -f "$exe_folder_path"/{dxgi.dll,winmm.dll,nvngx.dll,_nvngx.dll,nvngx-wrapper.dll,dlss-enabler.dll,OptiScaler.dll}

# === Optional: Backup Original DLLs ===
original_dlls=("d3dcompiler_47.dll" "amd_fidelityfx_dx12.dll" "amd_fidelityfx_framegeneration_dx12.dll" "amd_fidelityfx_upscaler_dx12.dll" "amd_fidelityfx_vk.dll")
for dll in "${original_dlls[@]}"; do
[[ -f "$exe_folder_path/$dll" && ! -f "$exe_folder_path/$dll.b" ]] && mv -f "$exe_folder_path/$dll" "$exe_folder_path/$dll.b"
done
# === Copy all OptiScaler files from ~/fgmod/opti to game directory ===
echo "📦 Copying OptiScaler files from $opti_path to $exe_folder_path"
if [[ ! -d "$opti_path" ]]; then
error_exit "❌ OptiScaler directory not found at $opti_path. Please run Setup OptiScaler first."
fi

# === Remove nvapi64.dll and its backup (conflicts from previous fakenvapi versions) ===
rm -f "$exe_folder_path/nvapi64.dll" "$exe_folder_path/nvapi64.dll.b"
echo "🧹 Cleaned up nvapi64.dll and backup (legacy fakenvapi conflicts)"
# Copy all files from opti directory to game directory
cp -rf "$opti_path"/* "$exe_folder_path/" || error_exit "❌ Failed to copy OptiScaler files"
echo "✅ Copied all OptiScaler files to game directory"

# === Core Install ===
if [[ -f "$fgmod_path/renames/$dll_name" ]]; then
echo "✅ Using pre-renamed $dll_name"
cp "$fgmod_path/renames/$dll_name" "$exe_folder_path/$dll_name" || error_exit "❌ Failed to copy $dll_name"
else
echo "⚠️ Pre-renamed $dll_name not found, falling back to OptiScaler.dll"
cp "$fgmod_path/OptiScaler.dll" "$exe_folder_path/$dll_name" || error_exit "❌ Failed to copy OptiScaler.dll as $dll_name"
# === Copy int8 upscaler DLL if it exists ===
if [[ -f "$int8_path/amd_fidelityfx_upscaler_dx12.dll" ]]; then
echo "📦 Copying int8 upscaler DLL to $exe_folder_path"
cp -f "$int8_path/amd_fidelityfx_upscaler_dx12.dll" "$exe_folder_path/" || true
echo "✅ Copied int8 upscaler DLL"
fi

# === OptiScaler.ini Handling ===
if [[ "$preserve_ini" == "true" && -f "$exe_folder_path/OptiScaler.ini" ]]; then
echo "📄 Preserving existing OptiScaler.ini (user settings retained)"
logger -t fgmod "📄 Existing OptiScaler.ini preserved in $exe_folder_path"
else
echo "📄 Installing OptiScaler.ini from plugin defaults"
cp "$fgmod_path/OptiScaler.ini" "$exe_folder_path/OptiScaler.ini" || error_exit "❌ Failed to copy OptiScaler.ini"
logger -t fgmod "📄 OptiScaler.ini installed to $exe_folder_path"
fi
# === Apply OptiScaler setup (what setup_linux.sh does) ===
# We do this directly instead of running setup_linux.sh to avoid interaction issues
echo "🔧 Setting up OptiScaler files"

# === ASI Plugins Directory ===
if [[ -d "$fgmod_path/plugins" ]]; then
echo "🔌 Installing ASI plugins directory"
cp -r "$fgmod_path/plugins" "$exe_folder_path/" || true
logger -t fgmod "🔌 ASI plugins directory installed to $exe_folder_path"
# Rename OptiScaler.dll to dxgi.dll (equivalent to selecting option 1)
if [[ -f "$exe_folder_path/OptiScaler.dll" ]]; then
if [[ -f "$exe_folder_path/dxgi.dll" ]]; then
echo "⚠️ Removing existing dxgi.dll"
rm -f "$exe_folder_path/dxgi.dll"
fi
mv "$exe_folder_path/OptiScaler.dll" "$exe_folder_path/dxgi.dll"
echo "✅ Renamed OptiScaler.dll to dxgi.dll"
else
echo "⚠️ No plugins directory found in fgmod"
echo "⚠️ OptiScaler.dll not found, may already be renamed"
fi

# === Supporting Libraries ===
cp -f "$fgmod_path/libxess.dll" "$exe_folder_path/" || true
cp -f "$fgmod_path/libxess_dx11.dll" "$exe_folder_path/" || true
cp -f "$fgmod_path/libxess_fg.dll" "$exe_folder_path/" || true
cp -f "$fgmod_path/libxell.dll" "$exe_folder_path/" || true
cp -f "$fgmod_path/amd_fidelityfx_dx12.dll" "$exe_folder_path/" || true
cp -f "$fgmod_path/amd_fidelityfx_framegeneration_dx12.dll" "$exe_folder_path/" || true
cp -f "$fgmod_path/amd_fidelityfx_upscaler_dx12.dll" "$exe_folder_path/" || true
cp -f "$fgmod_path/amd_fidelityfx_vk.dll" "$exe_folder_path/" || true
cp -f "$fgmod_path/nvngx.dll" "$exe_folder_path/" || true

# === Nukem FG Mod Files (now in fgmod directory) ===
cp -f "$fgmod_path/dlssg_to_fsr3_amd_is_better.dll" "$exe_folder_path/" || true
# Note: dlssg_to_fsr3.ini is not included in v0.9.0-pre4 archive

# === FakeNVAPI Files ===
# Remove legacy nvapi64.dll to avoid conflicts
# rm -f "$exe_folder_path/nvapi64.dll"
# echo "🧹 Removed legacy nvapi64.dll"
# Disable spoofing for non-Nvidia (equivalent to answering 'n' then 'y')
# The script asks: "Are you using Nvidia?" - we answer 'n'
# Then asks: "Will you try to use DLSS inputs?" - we answer 'y' (enable spoofing)
# Spoofing stays enabled (Dxgi=auto), so we don't need to change OptiScaler.ini

# Copy fakenvapi.dll with original name (v1.3.8.1)
cp -f "$fgmod_path/fakenvapi.dll" "$exe_folder_path/" || true
cp -f "$fgmod_path/fakenvapi.ini" "$exe_folder_path/" || true
echo "📦 Installed fakenvapi.dll and fakenvapi.ini"
# Clean up setup script and windows batch file
rm -f "$exe_folder_path/setup_linux.sh" "$exe_folder_path/setup_windows.bat"
rm -f "$exe_folder_path/!! EXTRACT ALL FILES TO GAME FOLDER !!"

# === Additional Support Files ===
# cp -f "$fgmod_path/d3dcompiler_47.dll" "$exe_folder_path/" || true
# Create uninstaller script (simplified version)
cat > "$exe_folder_path/remove_optiscaler.sh" << 'UNINSTALL_EOF'
#!/usr/bin/env bash
echo "Removing OptiScaler files..."
rm -f OptiScaler.log OptiScaler.ini dxgi.dll fakenvapi.dll fakenvapi.ini fakenvapi.log
rm -f dlssg_to_fsr3_amd_is_better.dll dlssg_to_fsr3.log
rm -rf D3D12_Optiscaler DlssOverrides Licenses
echo "OptiScaler removed!"
rm -f "$0"
UNINSTALL_EOF
chmod +x "$exe_folder_path/remove_optiscaler.sh"

# Note: d3dcompiler_47.dll is not included in v0.9.0-pre4 archive
echo "✅ OptiScaler setup completed"

echo "✅ Installation completed successfully!"
echo "📄 For Steam, add this to the launch options: \"$fgmod_path/fgmod\" %COMMAND%"
echo "📄 For Heroic, add this as a new wrapper: \"$fgmod_path/fgmod\""
logger -t fgmod "🟢 Installation completed successfully for $exe_folder_path"

# === Execute original command ===
Expand All @@ -184,9 +165,9 @@ if [[ $# -gt 1 ]]; then
logger -t fgmod "Final executable path: $exe_folder_path"
logger -t fgmod "=================="

# Execute the original command
# Execute the original command with proper environment variables
export SteamDeck=0
export WINEDLLOVERRIDES="$WINEDLLOVERRIDES,dxgi=n,b"
export WINEDLLOVERRIDES="dxgi=n,b${WINEDLLOVERRIDES:+,$WINEDLLOVERRIDES}"
exec "$@"
else
echo "Done!"
Expand All @@ -198,14 +179,4 @@ else
done
echo "Final executable path: $exe_folder_path"
echo "----------------------------------------"

# Also log standalone mode to journal
logger -t fgmod "=================="
logger -t fgmod "Debug Info (Standalone Mode):"
logger -t fgmod "Number of arguments: $#"
for i in $(seq 1 $#); do
logger -t fgmod "Arg $i: ${!i}"
done
logger -t fgmod "Final executable path: $exe_folder_path"
logger -t fgmod "=================="
fi
211 changes: 211 additions & 0 deletions defaults/assets/fgmod.sh.backup
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -0,0 +1,211 @@
#!/usr/bin/env bash

set -x
exec > >(tee -i /tmp/fgmod-install.log) 2>&1

error_exit() {
echo "❌ $1"
if [[ -n $STEAM_ZENITY ]]; then
$STEAM_ZENITY --error --text "$1"
else
zenity --error --text "$1" || echo "Zenity failed to display error"
fi
logger -t fgmod "❌ ERROR: $1"
exit 1
}

# === CONFIG ===
fgmod_path="$HOME/fgmod"
dll_name="${DLL:-dxgi.dll}"
preserve_ini="${PRESERVE_INI:-true}"

# === Resolve Game Path ===
if [[ "$#" -lt 1 ]]; then
error_exit "Usage: $0 program [program_arguments...]"
fi

exe_folder_path=""
if [[ $# -eq 1 ]]; then
[[ "$1" == *.exe ]] && exe_folder_path=$(dirname "$1") || exe_folder_path="$1"
else
for arg in "$@"; do
if [[ "$arg" == *.exe ]]; then
[[ "$arg" == *"Cyberpunk 2077"* ]] && arg=${arg//REDprelauncher.exe/bin/x64/Cyberpunk2077.exe}
[[ "$arg" == *"Witcher 3"* ]] && arg=${arg//REDprelauncher.exe/bin/x64_dx12/witcher3.exe}
[[ "$arg" == *"Baldurs Gate 3"* ]] && arg=${arg//Launcher\/LariLauncher.exe/bin/bg3_dx11.exe}
[[ "$arg" == *"HITMAN 3"* ]] && arg=${arg//Launcher.exe/Retail/HITMAN3.exe}
[[ "$arg" == *"HITMAN World of Assassination"* ]] && arg=${arg//Launcher.exe/Retail/HITMAN3.exe}
[[ "$arg" == *"SYNCED"* ]] && arg=${arg//Launcher\/sop_launcher.exe/SYNCED.exe}
[[ "$arg" == *"2KLauncher"* ]] && arg=${arg//2KLauncher\/LauncherPatcher.exe/DoesntMatter.exe}
[[ "$arg" == *"Warhammer 40,000 DARKTIDE"* ]] && arg=${arg//launcher\/Launcher.exe/binaries/Darktide.exe}
[[ "$arg" == *"Warhammer Vermintide 2"* ]] && arg=${arg//launcher\/Launcher.exe/binaries_dx12/vermintide2_dx12.exe}
[[ "$arg" == *"Satisfactory"* ]] && arg=${arg//FactoryGameSteam.exe/Engine/Binaries/Win64/FactoryGameSteam-Win64-Shipping.exe}
[[ "$arg" == *"FINAL FANTASY XIV Online"* ]] && arg=${arg//boot\/ffxivboot.exe/game/ffxiv_dx11.exe}
exe_folder_path=$(dirname "$arg")
break
fi
done
fi

for arg in "$@"; do
if [[ "$arg" == lutris:rungameid/* ]]; then
lutris_id="${arg#lutris:rungameid/}"

# Get slug from Lutris JSON
slug=$(lutris --list-games --json 2>/dev/null | jq -r ".[] | select(.id == $lutris_id) | .slug")

if [[ -z "$slug" || "$slug" == "null" ]]; then
echo "Could not find slug for Lutris ID $lutris_id"
break
fi

# Find matching YAML file using slug
config_file=$(find ~/.config/lutris/games/ -iname "${slug}-*.yml" | head -1)

if [[ -z "$config_file" ]]; then
echo "No config file found for slug '$slug'"
break
fi

# Extract executable path from YAML
exe_path=$(grep -E '^\s*exe:' "$config_file" | sed 's/.*exe:[[:space:]]*//')

if [[ -n "$exe_path" ]]; then
exe_folder_path=$(dirname "$exe_path")
echo "Resolved executable path: $exe_path"
echo "Executable folder: $exe_folder_path"
else
echo "Executable path not found in $config_file"
fi

break
fi
done

[[ -z "$exe_folder_path" && -n "$STEAM_COMPAT_INSTALL_PATH" ]] && exe_folder_path="$STEAM_COMPAT_INSTALL_PATH"

if [[ -d "$exe_folder_path/Engine" ]]; then
ue_exe=$(find "$exe_folder_path" -maxdepth 4 -mindepth 4 -path "*Binaries/Win64/*.exe" -not -path "*/Engine/*" | head -1)
exe_folder_path=$(dirname "$ue_exe")
fi

[[ ! -d "$exe_folder_path" ]] && error_exit "❌ Could not resolve game directory!"
[[ ! -w "$exe_folder_path" ]] && error_exit "🛑 No write permission to the game folder!"

logger -t fgmod "🟢 Target directory: $exe_folder_path"
logger -t fgmod "🧩 Using DLL name: $dll_name"
logger -t fgmod "📄 Preserve INI: $preserve_ini"

# === Cleanup Old Injectors ===
rm -f "$exe_folder_path"/{dxgi.dll,winmm.dll,nvngx.dll,_nvngx.dll,nvngx-wrapper.dll,dlss-enabler.dll,OptiScaler.dll}

# === Optional: Backup Original DLLs ===
original_dlls=("d3dcompiler_47.dll" "amd_fidelityfx_dx12.dll" "amd_fidelityfx_framegeneration_dx12.dll" "amd_fidelityfx_upscaler_dx12.dll" "amd_fidelityfx_vk.dll")
for dll in "${original_dlls[@]}"; do
[[ -f "$exe_folder_path/$dll" && ! -f "$exe_folder_path/$dll.b" ]] && mv -f "$exe_folder_path/$dll" "$exe_folder_path/$dll.b"
done

# === Remove nvapi64.dll and its backup (conflicts from previous fakenvapi versions) ===
rm -f "$exe_folder_path/nvapi64.dll" "$exe_folder_path/nvapi64.dll.b"
echo "🧹 Cleaned up nvapi64.dll and backup (legacy fakenvapi conflicts)"

# === Core Install ===
if [[ -f "$fgmod_path/renames/$dll_name" ]]; then
echo "✅ Using pre-renamed $dll_name"
cp "$fgmod_path/renames/$dll_name" "$exe_folder_path/$dll_name" || error_exit "❌ Failed to copy $dll_name"
else
echo "⚠️ Pre-renamed $dll_name not found, falling back to OptiScaler.dll"
cp "$fgmod_path/OptiScaler.dll" "$exe_folder_path/$dll_name" || error_exit "❌ Failed to copy OptiScaler.dll as $dll_name"
fi

# === OptiScaler.ini Handling ===
if [[ "$preserve_ini" == "true" && -f "$exe_folder_path/OptiScaler.ini" ]]; then
echo "📄 Preserving existing OptiScaler.ini (user settings retained)"
logger -t fgmod "📄 Existing OptiScaler.ini preserved in $exe_folder_path"
else
echo "📄 Installing OptiScaler.ini from plugin defaults"
cp "$fgmod_path/OptiScaler.ini" "$exe_folder_path/OptiScaler.ini" || error_exit "❌ Failed to copy OptiScaler.ini"
logger -t fgmod "📄 OptiScaler.ini installed to $exe_folder_path"
fi

# === ASI Plugins Directory ===
if [[ -d "$fgmod_path/plugins" ]]; then
echo "🔌 Installing ASI plugins directory"
cp -r "$fgmod_path/plugins" "$exe_folder_path/" || true
logger -t fgmod "🔌 ASI plugins directory installed to $exe_folder_path"
else
echo "⚠️ No plugins directory found in fgmod"
fi

# === Supporting Libraries ===
cp -f "$fgmod_path/libxess.dll" "$exe_folder_path/" || true
cp -f "$fgmod_path/libxess_dx11.dll" "$exe_folder_path/" || true
cp -f "$fgmod_path/libxess_fg.dll" "$exe_folder_path/" || true
cp -f "$fgmod_path/libxell.dll" "$exe_folder_path/" || true
cp -f "$fgmod_path/amd_fidelityfx_dx12.dll" "$exe_folder_path/" || true
cp -f "$fgmod_path/amd_fidelityfx_framegeneration_dx12.dll" "$exe_folder_path/" || true
cp -f "$fgmod_path/amd_fidelityfx_upscaler_dx12.dll" "$exe_folder_path/" || true
cp -f "$fgmod_path/amd_fidelityfx_vk.dll" "$exe_folder_path/" || true
cp -f "$fgmod_path/nvngx.dll" "$exe_folder_path/" || true

# === Nukem FG Mod Files (now in fgmod directory) ===
cp -f "$fgmod_path/dlssg_to_fsr3_amd_is_better.dll" "$exe_folder_path/" || true
# Note: dlssg_to_fsr3.ini is not included in v0.9.0-pre4 archive

# === FakeNVAPI Files ===
# Remove legacy nvapi64.dll to avoid conflicts
# rm -f "$exe_folder_path/nvapi64.dll"
# echo "🧹 Removed legacy nvapi64.dll"

# Copy fakenvapi.dll with original name (v1.3.8.1)
cp -f "$fgmod_path/fakenvapi.dll" "$exe_folder_path/" || true
cp -f "$fgmod_path/fakenvapi.ini" "$exe_folder_path/" || true
echo "📦 Installed fakenvapi.dll and fakenvapi.ini"

# === Additional Support Files ===
# cp -f "$fgmod_path/d3dcompiler_47.dll" "$exe_folder_path/" || true

# Note: d3dcompiler_47.dll is not included in v0.9.0-pre4 archive

echo "✅ Installation completed successfully!"
echo "📄 For Steam, add this to the launch options: \"$fgmod_path/fgmod\" %COMMAND%"
echo "📄 For Heroic, add this as a new wrapper: \"$fgmod_path/fgmod\""
logger -t fgmod "🟢 Installation completed successfully for $exe_folder_path"

# === Execute original command ===
if [[ $# -gt 1 ]]; then
# Log to both file and system journal
logger -t fgmod "=================="
logger -t fgmod "Debug Info (Launch Mode):"
logger -t fgmod "Number of arguments: $#"
for i in $(seq 1 $#); do
logger -t fgmod "Arg $i: ${!i}"
done
logger -t fgmod "Final executable path: $exe_folder_path"
logger -t fgmod "=================="

# Execute the original command
export SteamDeck=0
export WINEDLLOVERRIDES="$WINEDLLOVERRIDES,dxgi=n,b"
exec "$@"
else
echo "Done!"
echo "----------------------------------------"
echo "Debug Info (Standalone Mode):"
echo "Number of arguments: $#"
for i in $(seq 1 $#); do
echo "Arg $i: ${!i}"
done
echo "Final executable path: $exe_folder_path"
echo "----------------------------------------"

# Also log standalone mode to journal
logger -t fgmod "=================="
logger -t fgmod "Debug Info (Standalone Mode):"
logger -t fgmod "Number of arguments: $#"
for i in $(seq 1 $#); do
logger -t fgmod "Arg $i: ${!i}"
done
logger -t fgmod "Final executable path: $exe_folder_path"
logger -t fgmod "=================="
fi
Loading