scripts/games/save.game.steam

310 lines
14 KiB
Bash
Executable File
Raw Blame History

This file contains invisible Unicode characters

This file contains invisible Unicode characters that are indistinguishable to humans but may be processed differently by a computer. If you think that this is intentional, you can safely ignore this warning. Use the Escape button to reveal them.

This file contains Unicode characters that might be confused with other characters. If you think that this is intentional, you can safely ignore this warning. Use the Escape button to reveal them.

#!/bin/sh
# Purpose {{{
## Try to centralize all game's save in order to:
## easily backup all save
## easily restore it
## be able to access it from anywhere
## … all you can do with a Nextcloud (share, versionning,…)
##
## 1. Move save directories of a list of known games from Steam's
## userdata to a remote directory (Nextcloud, remote mount,…).
## Then create a symlink in userdata directory to the remote game
## directory.
##
## 2. If a directory doesn't exist, check if a remote one is
## available and symlink it.
##
## 3. List directories without symlinks.
##
## KISS: Only manage save directories from Steam userdata. For other
## paths ($XDG_DATA_HOME,…) check other scripts.
# }}}
# Vars {{{
debug=0
## Steam {{{
steam_id="112595584"
steam_userdata=".steam/steam/userdata/${steam_id}"
steam_compatdata=".steam/steam/steamapps/compatdata"
steam_common=".steam/steam/steamapps/common"
## List of Steam saves in userdata to backup {{{
### 760 Steam Screenshots https://steamdb.info/app/760/
### 35700 Trine Enchanted Edition https://pcgamingwiki.com/wiki/Trine_Enchanted_Edition
### 35720 Trine 2 Complete Story https://pcgamingwiki.com/wiki/Trine_2
### 55230 Saints Row: The Third https://pcgamingwiki.com/wiki/Saints_Row:_The_Third
### 204360 Castle Crashers https://pcgamingwiki.com/wiki/Castle_Crashers
### 206420 Saints Row IV https://pcgamingwiki.com/wiki/Saints_Row_IV
### 218820 Mercenary Kings https://pcgamingwiki.com/wiki/Mercenary_Kings
### 247080 Crypt of the Necrodancer https://pcgamingwiki.com/wiki/Crypt_of_the_Necrodancer
### 255870 PixelJunk Shooter https://pcgamingwiki.com/wiki/PixelJunk_Shooter
### 312530 Duck Game https://pcgamingwiki.com/wiki/Duck_Game
### 359840 Shift Happens https://pcgamingwiki.com/wiki/Shift_Happens
steam_userdata_games="760 35700 35720 55230 204360 206420 218820 247080 255870 312530 359840"
## }}}
## Pattern of Steam saves in common to backup {{{
### Add the directory name of the game and the directory|file name to backup
### separated by a slash.
### To be able to manage white space in directory name, the field separator is %.
### eg. GAME NAME/data.save%other game/*.sav
### 620 Portal 2 https://pcgamingwiki.com/wiki/Portal_2 (solo only, multiplayer is on Steam cloud)
### 251470 TowerFall Ascension https://pcgamingwiki.com/wiki/TowerFall_Ascension (not managed cause no substree, check $XDG_DATA_HOME)
### 274190 Broforce https://pcgamingwiki.com/wiki/Broforce
steam_common_games_pattern="Portal 2/*.sav%Broforce/*.sav"
# }}}
## Pattern of Steam saves in compatdata to backup {{{
### Compatdata contains directories for games using Steam play so it's too big
### to be fully moved to a remote storage.
### Add the game id and the directory|file name to backup separated by a slash
### eg. GAME_ID/savedata.xml
### 213670 South Park: The Stick of Truth https://pcgamingwiki.com/wiki/South_Park:_The_Stick_of_Truth
### 312610 Metal Slug X https://pcgamingwiki.com/wiki/Metal_Slug_X
### 359840 Shift Happens https://pcgamingwiki.com/wiki/Shift_Happens (don't work yet)
### 480490 Prey (2017) https://pcgamingwiki.com/wiki/Prey_(2017) (don't work yet)
### 686200 Door Kickers: Action Squad https://pcgamingwiki.com/wiki/Door_Kickers:_Action_Squad
steam_compatdata_games_pattern="213670/save 312610/UserDefault.xml 686200/userdata.bin"
# }}}
## Ids without backups in userdata {{{
### 7 Unknown
### 49520 Borderlands 2 https://pcgamingwiki.com/wiki/Borderlands_2
### 219150 Hotline Miami https://pcgamingwiki.com/wiki/Hotline_Miami
### 241100 Steam Controller Configs https://steamdb.info/app/241100/
### 242680 Nuclear Throne https://pcgamingwiki.com/wiki/Nuclear_Throne
### 251470 TowerFall Ascension https://pcgamingwiki.com/wiki/TowerFall_Ascension
### 255870 PixelJunk Shooter https://pcgamingwiki.com/wiki/PixelJunk_Shooter
### 268990 The Dishwasher: Vampire Smile https://pcgamingwiki.com/wiki/The_Dishwasher:_Vampire_Smile
### 295790 Never Alone https://pcgamingwiki.com/wiki/Never_Alone
### 416600 Full Metal Furies https://pcgamingwiki.com/wiki/Full_Metal_Furies
### 474210 Butcher https://pcgamingwiki.com/wiki/Butcher
### 697660 Jump Gunners https://pcgamingwiki.com/wiki/Jump_Gunners
### 728880 Overcooked! 2 https://pcgamingwiki.com/wiki/Overcooked!_2
ignore_pattern_steam_id="(7|620|49520|55230|213670|219150|241100|242680|251470|255870|268990|274190|295790|416600|474210|480490|686200|697660|728880|config|ugc|ugcmsgcache|\.)$"
## }}}
## }}}
remote_dir="${HOME}/Nextcloud/games/linux.sgl.script"
local_unmanaged_games_list="/tmp/unmanaged_games_list"
# }}}
# Functions {{{
# Move one Steam save game dir {{{
move_steam_game_dir() {
_game_id="${1}"
_steam_dir="${2}"
_local_game_path="${HOME}/${_steam_dir}/${_game_id}"
_remote_game_path="${remote_dir}/${_steam_dir}/${_game_id}"
## If a remote directory doesn't already exists for this game
if [ ! -d "${_remote_game_path}" ]; then
### Ensure to create tree directories on remote storage
mkdir -p -- "$(dirname "${_remote_game_path}")"
### Move data to remote storage
mv -- "${_local_game_path}" "${_remote_game_path}"
[ "${debug}" -eq "0" ] && printf '\e[1;35m%-6s\e[m\n' "DEBUG: Move Steam game The data of ${_game_id} ${_local_game_path} moved to remote storage."
### Then ask to create a symbolic link to local storage
symlink_steam_game_dir "${_game_id}" "${_steam_dir}"
else
printf '\e[1;35m%-6s\e[m\n' "Move Steam game ${_game_id} already have data on remote storage: ${_remote_game_path}. Abort to avoid to override data."
exit 5
fi
}
# }}}
# Symlink one Steam save game dir from remote to local {{{
symlink_steam_game_dir() {
_game_id="${1}"
_steam_dir="${2}"
_local_game_path="${HOME}/${_steam_dir}/${_game_id}"
_remote_game_path="${remote_dir}/${_steam_dir}/${_game_id}"
if [ -d "${_remote_game_path}" ]; then
ln -s -- "${_remote_game_path}" "${_local_game_path}"
[ "${debug}" -eq "0" ] && printf '\e[1;35m%-6s\e[m\n' "DEBUG: Symlink Steam game — Symlink remote data of ${_game_id} to local storage."
else
[ "${debug}" -eq "0" ] && printf '\e[1;35m%-6s\e[m\n' "DEBUG: Symlink Steam game — ${_game_id} doesn't have remote data."
fi
}
# }}}
# }}}
# Tests {{{
## Ensure remote dir exist {{{
if [ ! -d "${remote_dir}" ]; then
printf '\e[1;35m%-6s\e[m\n' "The directory for save game doesn't exists: ${remote_dir}"
exit 1
fi
## }}}
## Ensure Steam directories exist {{{
for steam_dir in "${steam_userdata}" "${steam_common}" "${steam_compatdata}"; do
local_steam_path="${HOME}/${steam_dir}"
if [ ! -d "${local_steam_path}" ]; then
printf '\e[1;35m%-6s\e[m\n' "The Steam directory ${steam_dir} for your ID (${steam_id}) doesn't exists yet… Should it must be create (for restoration,…) [Y/n]?"
read -r create_local_steam_userdata
if [ "${create_local_steam_userdata}" = "" ] || [ "${create_local_steam_userdata}" = "Y" ] || [ "${create_local_steam_userdata}" = "y" ]; then
mkdir -p -- "${local_steam_path}"
else
printf '\e[1;35m%-6s\e[m\n' "Steam directory (${steam_dir}) doesn't exists, abort script."
exit 2
fi
fi
done
## }}}
# }}}
# Manage Steam userdata save game {{{
for game_id in ${steam_userdata_games}; do
local_game_path="${HOME}/${steam_userdata}/${game_id}"
local_game_path_type="$(file "${local_game_path}" | cut -d' ' -f2)"
case ${local_game_path_type} in
## Data is already a symlink
"symbolic")
link_name="$(file "${local_game_path}" | sed 's;.* symbolic link to \(.*\);\1;')"
[ "${debug}" -eq "0" ] && printf '\e[1;35m%-6s\e[m\n' "DEBUG: Steam userdata for loop — The data of ${game_id} are already symlinked to ${link_name} . Skip."
;;
## Data is still a directory
"directory")
move_steam_game_dir "${game_id}" "${steam_userdata}"
;;
## Data doesn't exist
"cannot")
[ "${debug}" -eq "0" ] && printf '\e[1;35m%-6s\e[m\n' "DEBUG: Steam userdata for loop — The data of ${game_id} ${local_game_path} doesn't exist. Skip."
symlink_steam_game_dir "${game_id}" "${steam_userdata}"
;;
## Data can't be managed
*)
printf '\e[1;35m%-6s\e[m\n' "Data of ${game_id} (userdata) ${local_game_path} are not managed. Type: ${local_game_path_type}. Abort"
exit 3
;;
esac
done
# }}}
# Manage Steam common save game {{{
IFS="%"
for game_pattern in ${steam_common_games_pattern}; do
## Separate the game_name and the directory|file to backup|symlink
game_name="$(echo "${game_pattern}" | cut -d"/" -f1)"
save_pattern="$(echo "${game_pattern}" | cut -d"/" -f2)"
## If the game is installed
if [ -d "${HOME}/${steam_common}/${game_name}" ]; then
### Follow symbolic links but avoid links to dosdevices and keep only one result
temp_local_save_path="$(find -L "${HOME}/${steam_common}/${game_name}" -iname "${save_pattern}" -print -quit)"
local_save_path="$(dirname "${temp_local_save_path}")"
local_save_path_type="$(ls -ld "${local_save_path}" | sed 's/\(^.\).*/\1/')"
## Path independent from local or remote base directory
steam_dir="$(printf "%s" "${local_save_path}" | sed -e "s;${HOME}/;;")"
## Print vars {{{
#if [ "${debug}" -eq "0" ]; then
#printf '\e[1;35m%-6s\e[m\n' "DEBUG: game name: ${game_name}"
#printf '\e[1;35m%-6s\e[m\n' "DEBUG: save pattern: ${save_pattern}"
#printf '\e[1;35m%-6s\e[m\n' "DEBUG: temp local save path: ${temp_local_save_path}"
#printf '\e[1;35m%-6s\e[m\n' "DEBUG: local save path: ${local_save_path}"
#printf '\e[1;35m%-6s\e[m\n' "DEBUG: local save type: ${local_save_path_type}"
#printf '\e[1;35m%-6s\e[m\n' "DEBUG: steam dir: ${steam_dir}"
#fi
## }}}
case ${local_save_path_type} in
## Data is already a symlink
"symbolic"|"symboliclink"|"l")
link_name="$(file "${local_save_path}" | sed 's;.* symbolic link to \(.*\);\1;')"
[ "${debug}" -eq "0" ] && printf '\e[1;35m%-6s\e[m\n' "DEBUG: Steam common for loop — The data of ${game_name} are already symlinked to ${link_name} . Skip."
;;
## Data is still a directory, try to move it
"directory"|"d")
move_steam_game_dir "$(basename "${steam_dir}")" "$(dirname "${steam_dir}")"
;;
## Data doesn't exist
"cannot")
[ "${debug}" -eq "0" ] && printf '\e[1;35m%-6s\e[m\n' "DEBUG: Steam common for loop — The data of ${game_name} ${local_save_path} doesn't exist. Skip."
### TODO: Try to symlink
;;
## Data can't be managed
*)
printf '\e[1;35m%-6s\e[m\n' "Data of ${game_name} (common) ${local_save_path} are not managed. Type: ${local_save_path_type}. Abort."
exit 3
;;
esac
else ## The game is not present on the system
[ "${debug}" -eq "0" ] && printf '\e[1;35m%-6s\e[m\n' "DEBUG: Steam common for loop — ${game_name} doesn't seems to be installed on the system, check the path: ${HOME}/${steam_common}/${game_name} . Skip."
fi
done
# }}}
# Manage Steam compatdata save game {{{
for game_pattern in ${steam_compatdata_games_pattern}; do
## Separate the game_id and the directory|file to backup|symlink
game_id="$(echo "${game_pattern}" | cut -d"/" -f1)"
save_pattern="$(echo "${game_pattern}" | cut -d"/" -f2)"
## If the game is installed
if [ -d "${HOME}/${steam_compatdata}/${game_id}" ]; then
### Follow symbolic links but avoid links to dosdevices and keep only one result
temp_local_save_path="$(find -L "${HOME}/${steam_compatdata}/${game_id}" -ipath "*dosdevices*" -prune -o -iname "${save_pattern}" | grep -v "dosdevices" | head -n 1)"
local_save_path="$(dirname "${temp_local_save_path}")"
local_save_path_type="$(ls -ld "${local_save_path}" | sed 's/\(^.\).*/\1/')"
## Path independent from local or remote base directory
steam_dir="$(printf "%s" "${local_save_path}" | sed -e "s;${HOME}/;;")"
## Print vars {{{
#if [ "${debug}" -eq "0" ]; then
#printf '\e[1;35m%-6s\e[m\n' "DEBUG: game ID: ${game_id}"
#printf '\e[1;35m%-6s\e[m\n' "DEBUG: save pattern: ${save_pattern}"
#printf '\e[1;35m%-6s\e[m\n' "DEBUG: temp local save path: ${temp_local_save_path}"
#printf '\e[1;35m%-6s\e[m\n' "DEBUG: local save path: ${local_save_path}"
#printf '\e[1;35m%-6s\e[m\n' "DEBUG: local save type: ${local_save_path_type}"
#printf '\e[1;35m%-6s\e[m\n' "DEBUG: steam dir: ${steam_dir}"
#fi
## }}}
case ${local_save_path_type} in
## Data is already a symlink
"symbolic"|"symboliclink"|"l")
link_name="$(file "${local_save_path}" | sed 's;.* symbolic link to \(.*\);\1;')"
[ "${debug}" -eq "0" ] && printf '\e[1;35m%-6s\e[m\n' "DEBUG: Steam compatdata for loop — The data of ${game_id} are already symlinked to ${link_name} . Skip."
;;
## Data is still a directory, try to move it
"directory"|"d")
move_steam_game_dir "$(basename "${steam_dir}")" "$(dirname "${steam_dir}")"
;;
## Data doesn't exist
"cannot")
[ "${debug}" -eq "0" ] && printf '\e[1;35m%-6s\e[m\n' "DEBUG: Steam compatdata for loop — The data of ${game_id} ${local_save_path} doesn't exist. Skip."
### TODO: Try to symlink
;;
## Data can't be managed
*)
printf '\e[1;35m%-6s\e[m\n' "Data of ${game_id} (compatdata) ${local_save_path} are not managed. Type: ${local_save_path_type}. Abort."
exit 3
;;
esac
else ## The game is not present on the system
[ "${debug}" -eq "0" ] && printf '\e[1;35m%-6s\e[m\n' "DEBUG: Steam compatdata for loop — ${game_id} doesn't seems to be installed on the system. Skip."
fi
done
# }}}
# List userdata unmanage game id {{{
cd -- "${HOME}/${steam_userdata}" || exit 1
rm -f -- "${local_unmanaged_games_list}"
find . -maxdepth 1 -type d | grep -vE "${ignore_pattern_steam_id}" > "${local_unmanaged_games_list}"
if [ -s "${local_unmanaged_games_list}" ]; then
printf '\e[1;35m%-6s\e[m\n' "List of unmanaged directories:"
cat "${local_unmanaged_games_list}"
fi
rm -f -- "${local_unmanaged_games_list}"
cd -- - > /dev/null || exit 1
# }}}
exit 0