Fetch SteamGridDB assets when adding game to Steam#3662
Fetch SteamGridDB assets when adding game to Steam#3662EmoonX wants to merge 10 commits intobottlesdevs:mainfrom
Conversation
(`bottle name + program name`` is used instead)
| except: | ||
| # Unreachable host or issue saving files, nothing we can do | ||
| break |
There was a problem hiding this comment.
I believe it'll be better to specify which exception(s).
| cmd = "xdg-open" | ||
| args = "bottles:run/'{0}'/'{1}'" | ||
| args = f"bottles:run/'{self.config.Name}'/'{program_name}'" | ||
| appid = crc32(str.encode(self.config.Name + program_name)) | 0x80000000 |
There was a problem hiding this comment.
0x80000000 should have an accompanying source/context
|
|
||
| confs = glob(os.path.join(self.userdata_path, "*/config/")) | ||
| shortcut = { | ||
| "appid": appid - 0x100000000, |
There was a problem hiding this comment.
0x100000000 should have an accompanying source/context
| res = requests.get(f"https://steamgrid.usebottles.com/api/search/{name}") | ||
| except: | ||
| return | ||
| # url = f"https://steamgrid.usebottles.com/api/search/{program_name}" |
There was a problem hiding this comment.
Any reason why this is commented?
| res = requests.get(url) | ||
| res.raise_for_status() | ||
| ext = os.path.splitext(url)[-1] | ||
| asset_path += ext | ||
| with open(asset_path, "wb") as img: | ||
| img.write(res.content) |
There was a problem hiding this comment.
For increased readability, I'd avoid abbreviating variable names, i.e. use result as opposed to res, etc.
| program_name, asset_path, asset_type, reraise_exceptions=True | ||
| ) | ||
| except HTTPError: | ||
| # Usually missing asset (404), keep trying for the rest |
There was a problem hiding this comment.
This comment can be removed
This would be a good idea. I'll convert this to a draft until it's deemed "good to go". |
Keep in mind that it isn't exclusive to this PR. The same system is used for the Either way, this one isn't going anywhere until https://steamgrid.usebottles.com/api is finally updated (I beg of you, @francescomasala... you're our only hope). |
|
I would keep this MR open even if old because the changes were good, just need a few changes. @EmoonX are you still interested or should I jump in? |
Description
(reopening #3543)
As of now, when using the "Add to Steam" feature, games are added to Steam in a barebones state. This PR improves upon that by fuzzy-searching the game title (program name) on SteamGridDB and, when available, downloading the respective assets and saving them to the designated user directory (
.../steam/userdata/<user_id>/config/grid); in a similar vein to what happens when using Steam ROM Manager.Since Steam relies on appIDs for game identification, one is now generated by a hash method (for uniqueness) and saved to
shortcuts.vdf. Same appID is then used for naming downloaded assets.Makes use of
steamgrid-proxy, in particular the changes introduced by bottlesdevs/steamgrid-proxy#1 and bottlesdevs/steamgrid-proxy#2. However, these don't seem to be in production (https://steamgrid.usebottles.com/api) yet, so the only way to currently test it is by running the API webserver locally.Further improvements?
SteamGridDB search can occasionally fail or even return the wrong match. Perhaps one way to solve that would be adding a
Custom SteamGridDB Game IDsetting for individual programs. Will wait for further feedback.Type of change
How Has This Been Tested?
First of all, make sure
steamgrid-proxyis running, on the correct port and with the right SteamGridDB API key.Add a game executable to a bottle, renaming it if needed. Then right click ->
Add to Steam. Open (or restart) Steam as needed. All the available assets (grid, hgrid, hero, logo and icon) should be loaded as expected.You can check for match correctness by comparing it to the
Add to Libraryoption: if the latter produces a nonempty grid for Bottles's library, then likewise both it and its sibling assets should be visible on Steam.before:


after:

