Skip to content
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

Add Non-Steam Game: Refactor Shortcut Entry Creation #965

Merged
merged 9 commits into from
Nov 2, 2023
Merged

Add Non-Steam Game: Refactor Shortcut Entry Creation #965

Changes from all commits
Commits
Show all changes
9 commits
Select commit Hold shift + click to select a range
08e0076
Add Non-Steam Game: Refactor how VDF values are written
sonic2kk Oct 30, 2023
d5e2def
Add Non-Steam Game: Refactor how VDF values are written
sonic2kk Oct 30, 2023
e191f53
Add Non-Steam Game: Default boolean values to blank if not 1 or 0
sonic2kk Oct 30, 2023
3089bc3
Add Non-Steam Game: Simplify checkValidVDFBoolean
sonic2kk Oct 30, 2023
8f4b004
minor
sonic2kk Oct 30, 2023
a40a4a8
minor
sonic2kk Oct 30, 2023
f0227d7
Add Non-Steam Game: Fix using checkValidVDFBoolean for tags
sonic2kk Nov 1, 2023
9c06e61
Add Non-Steam Game: Write out bytes instead of string using printf
sonic2kk Nov 2, 2023
4323556
version bump
sonic2kk Nov 2, 2023
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
80 changes: 23 additions & 57 deletions steamtinkerlaunch
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -6,7 +6,7 @@
PREFIX="/usr"
PROGNAME="SteamTinkerLaunch"
NICEPROGNAME="Steam Tinker Launch"
PROGVERS="v14.0.20231031-1"
PROGVERS="v14.0.20231103-1"
PROGCMD="${0##*/}"
PROGINTERNALPROTNAME="Proton-stl"
SHOSTL="stl"
Expand Down Expand Up @@ -23320,6 +23320,10 @@ function addNonSteamGame {
fi
SCPATH="$STUIDPATH/config/$SCVDF"

function checkValidVDFBoolean {
[ "$1" -eq 1 ] || [ "$1" -eq 0 ] && echo "$1"
}

function getCRC {
echo -n "$1" | gzip -c | tail -c 8 | od -An -N 4 -tx4
}
Expand All @@ -23331,9 +23335,8 @@ function addNonSteamGame {
## Notes on how Non-Steam AppIDs work, because it took me almost a year to figure this out
## ----------------------
## Steam stores shortcuts in a binary file called 'shortcuts.vdf', stored in SROOT/userdata/<id>/config
## This file stores information about Steam shortcuts, with many values being written out in hex, such as the Steam AppID and boolean values
##
## Non-Steam Game AppIDs are 32bit little-endian (reverse byte order) signed integers, stores as hexidecimal
## Non-Steam Game AppIDs are 32bit little-endian (reverse byte order) signed integers, stored as hexidecimal
## This AppID is probably generated using some combination of the AppName and Exe with a crc32 generated from them, but it can actually be anything
## Steam likely does things this way in an attempt to ensure "uniqueness" among entries. Projects like Steam-ROM-Manager do the same thing likely for similar reasons
##
Expand All @@ -23344,7 +23347,6 @@ function addNonSteamGame {
##
## We can later re-use these functions to do several things:
## - Check for and remove stray STL configs for no longer stored Non-Steam Game AppIDs (if we had Non-Steam Games we previously used with STL that we no longer use, we can remove these configs in case there is a conflict in future)
## ----------------------

### BEGIN MAGIC APPID FUNCTIONS
## ----------
Expand Down Expand Up @@ -23449,16 +23451,16 @@ function addNonSteamGame {
NOSTLAOP="${i#*=}"
shift ;;
-hd=*|--hide=*)
NOSTHIDE="${i#*=}"
NOSTHIDE="$( checkValidVDFBoolean "${i#*=}" )"
shift ;;
-adc=*|--allowdesktopconf=*)
NOSTADC="${i#*=}"
NOSTADC="$( checkValidVDFBoolean "${i#*=}" )"
shift ;;
-ao=*|--allowoverlay=*)
NOSTAO="${i#*=}"
NOSTAO="$( checkValidVDFBoolean "${i#*=}" )"
shift ;;
-vr=*|--openvr=*)
NOSTVR="${i#*=}"
NOSTVR="$( checkValidVDFBoolean "${i#*=}" )"
shift ;;
-t=*|--tags=*)
NOSTTAGS="${i#*=}"
Expand Down Expand Up @@ -23639,9 +23641,9 @@ function addNonSteamGame {
# Regular artwork
notiShow "$NOTY_SGDBDL"

# The entered name to search on will take priority over the actual game EXE name, only one will be used and we will always prefer the entered custom name
# For example if a user naames their Non-Steam Game "The Elder Scrolls IV: Oblivion" but they enter a custom search name because they want artwork for "The Elder Scrolls IV: Oblivion Game of the Year Edition"
# If art is not found for the custom name, users should enter either the Steam AppID or the SteamGridDB Game ID to use as a fallback (Steam AppID will always be preferred because it will always be exact)
# The entered search name is prioritised over actual game EXE name, only one will be used and we will always prefer custom name
# Ex: user names Non-Steam Game "The Elder Scrolls IV: Oblivion" but they enter a custom search name because they want artwork for "The Elder Scrolls IV: Oblivion Game of the Year Edition"
# In case art is not found for the custom name, users should enter either the Steam AppID or the SteamGridDB Game ID to use as a fallback (Steam AppID will always be preferred because it will always be exact)
#
# Therefore, the order of priority for artwork searching is:
# 1. Name search (only ONE of the below will be used)
Expand Down Expand Up @@ -23690,66 +23692,31 @@ function addNonSteamGame {
fi

writelog "INFO" "${FUNCNAME[0]} - Adding new set '$NEWSET'"

{
printf '\x00%s\x00' "$NEWSET"
printf '\x02%s\x00%b' "appid" "$NOSTAIDVDFHEXFMT"
printf '\x01%s\x00%s\x00' "AppName" "$NOSTAPPNAME"
printf '\x01%s\x00%s\x00' "Exe" "$NOSTEXEPATH"
printf '\x01%s\x00%s\x00' "StartDir" "$NOSTSTDIR"
printf '\x01%s\x00%s\x00' "icon" "$NOSTICONPATH"
printf '\x01%s\x00%s\x00' "ShortcutPath" ""
printf '\x01%s\x00%s\x00' "LaunchOptions" "$NOSTLAOP"

if [ -n "$NOSTICONPATH" ]; then
printf '\x01%s\x00%s\x00' "icon" "$NOSTICONPATH"
else
printf '\x01%s\x00\x00' "icon"
fi

printf '\x01%s\x00\x00' "ShortcutPath"

if [ -n "$NOSTLAOP" ]; then
printf '\x01%s\x00%s\x00' "LaunchOptions" "$NOSTLAOP"
else
printf '\x01%s\x00\x00' "LaunchOptions"
fi

if [ "$NOSTHIDE" -eq 1 ]; then
printf '\x02%s\x00\x01\x00\x00\x00' "IsHidden"
else
printf '\x02%s\x00\x00\x00\x00\x00' "IsHidden"
fi

if [ "$NOSTADC" -eq 1 ]; then
printf '\x02%s\x00\x01\x00\x00\x00' "AllowDesktopConfig"
else
printf '\x02%s\x00\x00\x00\x00\x00' "AllowDesktopConfig"
fi

if [ "$NOSTAO" -eq 1 ]; then
printf '\x02%s\x00\x01\x00\x00\x00' "AllowOverlay"
else
printf '\x02%s\x00\x00\x00\x00\x00' "AllowOverlay"
fi

if [ "$NOSTVR" -eq 1 ]; then
printf '\x02%s\x00\x01\x00\x00\x00' "OpenVR"
else
printf '\x02%s\x00\x00\x00\x00\x00' "OpenVR"
fi
# Before we had an ifelse for this, checking if the var -eq 1, but we can just write the value as-is to the VDF
# Use either the defined value, which should be 1 or 0, or default to 0
printf '\x02%s\x00%b\x00\x00\x00' "IsHidden" "\x0${NOSTHIDE:-0}"
printf '\x02%s\x00%b\x00\x00\x00' "AllowDesktopConfig" "\x0${NOSTADC:-0}"
printf '\x02%s\x00%b\x00\x00\x00' "AllowOverlay" "\x0${NOSTAO:-0}"
printf '\x02%s\x00%b\x00\x00\x00' "OpenVR" "\x0${NOSTVR:-0}"

printf '\x02%s\x00\x00\x00\x00\x00' "Devkit"
printf '\x01%s\x00\x00' "DevkitGameID"
printf '\x02%s\x00\x00\x00\x00\x00' "DevkitOverrideAppID"

printf '\x02%s\x00\x00\x00\x00\x00' "LastPlayTime"
printf '\x01%s\x00\x00' "FlatpakAppID"
printf '\x00%s\x00' "tags"
splitTags "$NOSTTAGS"
printf '\x08'
printf '\x08'

#file end:
printf '\x08'
printf '\x08'
printf '\x08\x08\x08\x08'
} >> "$SCPATH"

writelog "INFO" "${FUNCNAME[0]} - Finished writing out new Non-Steam Game Shortcut"
Expand All @@ -23769,7 +23736,6 @@ function addNonSteamGame {
fi

writelog "INFO" "${FUNCNAME[0]} - Finished adding new $NSGA"

SGACOPYMETHOD="" # Unset doesn't work for some reason with '--flag'
}

Expand Down