RetroAchievements Load Game Data #11730

LillyJadeKatrin · 2023-04-06T01:43:18Z

This is a portion of an integration with the RetroAchievements tools and libraries for connecting to the website, downloading data, unlocking achievements and submitting to leaderboards for games running in Dolphin. In this PR, the AchievementsManager created in a previous PR is further implemented to generate and resolve the RetroAchievements hash for the requested game, open a session, and download the necessary information to process achievements, leaderboards, and rich presence for the game.

AdmiralCurtiss · 2023-04-07T00:59:23Z

One thing immediately strikes me here: Dolphin works with a large amount of different file formats for games, from plain ISOs to a lot of compressed and container formats to even launching an extracted disc filesystem. Wii software might even be installed in the virtual NAND and launched from there. Collecting all that into a single filename and attempting to implement a consistent hash for that on the library side seems somewhat... ill-advised for that. Are you sure you want to do it like this? If yes, what will be the limitations of this approach, ie. what file formats are you willing to support? Keep in mind that anything less than what Dolphin itself supports will cause a number of users to not have access to achievements even if they have a copy of the game (and probably angry support requests, which I'd rather not deal with).

Secondly, I find the way you're storing all the API replies as class members a bit weird. Do they really all need to live until game shutdown? Why can't you destroy them immediately after the function call is done?

Source/Core/Core/AchievementManager.cpp

Source/Core/Core/AchievementManager.h

Source/Core/Core/BootManager.cpp

Source/Core/Core/Core.cpp

LillyJadeKatrin · 2023-04-07T03:31:12Z

Put discussion about the file being used to hash in the Discord channel as that one will be a doozy. As for this:

Secondly, I find the way you're storing all the API replies as class members a bit weird. Do they really all need to live until game shutdown? Why can't you destroy them immediately after the function call is done?

Was mostly keeping them around for convenience, so I didn't have to extract and keep around the individual pieces of data I'm getting from the API replies. I suppose I could do this the not-lazy way if that's preferable.

LillyJadeKatrin · 2023-04-07T13:44:30Z

Please DO NOT run checks right now! Currently fifoci will fail until rcheevos is hotfixed, which is in progress.

Source/Core/Core/AchievementManager.cpp

AdmiralCurtiss · 2023-04-10T21:01:35Z

I still think you're storing too much state in the class that could just as well be local to the function. But this is mostly fine, so don't let me block you if no one else has problems with this.

Source/Core/Core/AchievementManager.cpp

AdmiralCurtiss · 2023-04-11T19:55:52Z

I think your first two commits should be squashed together.

Source/Core/Core/AchievementManager.cpp

Added the ResolveHash method to AchievementManager. This is a blocking function to send a hash string to the RetroAchievements server to verify it and get a game ID back.

Added a call to the RetroAchievements Start Session API to AchievementManager. This is primarily for client-side activation, so it doesn't return much of value, aside from its success/error information, but I'm storing the return structure in case this changes in the future.

FetchGameData is the big one - this retrieves the logic for all the achievements, leaderboards, and rich presence, and all the relevant metadata for the game.

LoadGameByFilenameAsync sets up a volume reader and hashes the volume, then uses that hash to make the three consecutive API requests to resolve hash, start session and load game data. CloseGame resets the m_is_game_loaded flag, wipes the queue, and destroys all the game data responses.

Update the rcheevos submodule to the most recent origin/develop, which contains a fix to the gamecube hash algorithm to politely exit if it is unable to open a file.