Retroachievements popups #11839
Retroachievements popups #11839
Conversation
LillyJadeKatrin
force-pushed
the
retroachievements-popups
branch
3 times, most recently
from
3fe0172
to
11fa0a5
Compare
Added an OnScreenDisplay message to HandleAchievementTriggeredEvent to display a message when a player has unlocked an achievement. The message includes the title of the achievement and its point value based on the game data. To match RetroAchievements' website interface, the message is blue if the unlock is casual and gold for challenge.
Added an OnScreenDisplay message to HandleLeaderboardTriggeredEvent to display a message when a player has completed a leaderboard. The message includes the title of the achievement and the player's score/time.
Added HandleLeaderboardStartedEvent with an OnScreenDisplay message when a player has triggered a leaderboard's start conditions. The message includes the title of the achievement.
Added HandleLeaderboardStartedEvent with an OnScreenDisplay message when a player has triggered a leaderboard's failure conditions. The message includes the title of the achievement.
Added OnScreenDisplay messages to LoadGameByFilenameAsync to notify the player when any of the potential failures occur.
Added a TallyScore method to AchievementManager to calculate the player's current scores (soft and hard) against the total number of points across all achievements. Includes a PointSpread structure to hold all points and counts. The Unlock Map now includes point values for each achievement to aid in this calculation; this is populated at insert time, and Unofficial achievements are tallied as zero.
Added an OnScreenDisplay message to LoadGameByFilenameAsync to display a message when a player starts a game with achievements, notifying them of their current score. The score displayed is challenge points if the player is in challenge mode or challenge + casual if the player is in casual mode. A second message tells the player which mode they are in. To match RetroAchievements' website interface, the messages are blue for casual and gold for challenge.
Added OnScreenDisplay messages to HandleAchievementTriggeredEvent to display an extra congratulations message if the player has completed (unlocked all achievements in casual) or mastered (unlocked all achievements in challenge) the game. This also uses the display name retrieved when verifying credentials, which has now been added as a member field on AchievementManager.
LillyJadeKatrin
force-pushed
the
retroachievements-popups
branch
from
11fa0a5
to
57290a4
Compare
| AchievementId game_data_index = it->second.game_data_index; | ||
| OSD::AddMessage(fmt::format("Unlocked: {} ({})", m_game_data.achievements[game_data_index].title, | ||
| m_game_data.achievements[game_data_index].points), | ||
| OSD::Duration::VERY_LONG, | ||
| (hardcore_mode_enabled) ? OSD::Color::YELLOW : OSD::Color::CYAN); |
There was a problem hiding this comment.
Note that this decouples the actual server-side unlocking process from the message displayed to the user. This might be fine, I'm not sure how other emulators handle this, but think about the implications.
There was a problem hiding this comment.
That is actually deliberate. Some cases (unofficial achievements, Encore Mode) we want to send a message even if we're not actively posting to the site. And a later change will add retry functionality in case the player loses connection to the server - honestly that one's more of a self-serving thing, so I can bring my Deck on flights and the site unlocks everything for me when I land and can turn airplane mode off again.
There was a problem hiding this comment.
In any case, to my understanding we want to notify the player as soon as the criteria are met, independent of what's going on with respect to the server, but I'll double check.
There was a problem hiding this comment.
Okay, then I suppose this is fine as-is for now. There probably also should be some kind of 'hey you're about to close Dolphin but there's still outstanding unlocks to RA, if you close Dolphin now you will lose achievement progress' kinda message in the future as well.
There was a problem hiding this comment.
There will be, haven't quite worked through how that all is going to work yet.
This is because we unfortunately don't have proper multilingual font support for the OSD. |
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 display on-screen popup messages to notify the player when important events such as achievement unlocks and leaderboard submissions take place, utilizing the imGui code in OnScreenDisplay to handle these messages.