Steam achievements for PC & MAC Instructions

BlitzMax Forums/BlitzMax Programming/Steam achievements for PC & MAC Instructions

coffeedotbean (Posted 2016) [#1]

After struggling today I wanted to put this together to clear up the old discussion posts about integrating steam achievements on PC and MAC, more so for MAC as PC is super easy. http://www.blitzmax.com/Community/posts.php?topic=84183 http://www.blitzmax.com/Community/posts.php?topic=96950 skidracer did all the work in getting integration going with his steamstub so a big thankyou to him; below I aim to clear up how you get it working, MAC is rather involved, I have included a new example.bmx with a steam.type to show achievements working with the test application. If you can get this working with the example.bmx, it should be clear how to integrate it to your own projects, big thanks again to skidracer. Tested with STEAM_SDK v138a, BMax 1.50/1.51, windows 10, OS X 10.11 MAC 1. Download latest Steam SDK from https://partner.steamgames.com/ (you need to be a member) 2. Extract to Desktop (recommended) 3. Download steamstub4a.zip from https://code.google.com/archive/p/max-edit/downloads 4. Extract some place 5. ** Copy the steamstub.cpp text from this forum post and save as steamstub.cpp within the steamstub4a folder (might need to use xcode editor) 6. Copy and paste example.bmx code to a file and save inside steamstub4a folder 7. Open example.bmx and edit the 1st IMPORT under ?MacOS to point to the the ‘osx32’ folder in the steam SDK folder (/users/?/desktop/sdk_x/sdk/redist_bin/osx32) 8. Open example.bmx and edit the 3rd IMPORT under ?MacOS to point to the ‘steamstub.cpp’ file you saved 9. Open steamstub.cpp and edit the ‘steam_api.h’ path at the top to point to the steam_api.h file inside the steam SDK folder (/users/?/desktop/sdk_x/sdk/public/steam) 10. Compile and run example.bmx (it will fail with error: dyld: Library not loaded: @loader_path/libsteam_api.dylib) 11. Right click and open the example.debug.app or example.app file that's been created, show package contents, in the Contents/MacOS folder copy over the ‘libsteam_api.dylib’ found in the steam SDK folder ’/users/?/desktop/sdk_x/sdk/redist_bin/osx32 12. Compile and run example.bmx All being good it should work. Remember to do step 11 if you delete the app. ** I am no MAC expert but I had issues saving this in TextEdit (it seemed to have mangled the file when saved), had to save in 'xcode > file:new > os x > other > empty' else I got error 'error: expected unqualified-id' when I compiled. PC 1. Download steamstub4a.zip from https://code.google.com/archive/p/max-edit/downloads 2. Extract some place 3. Copy and paste example.bmx code to a file and save inside steamstub4a folder 4. Compile and run example.bmx All being good it should work. example.bmx SuperStrict '// Tested with STEAM_SDK v138a and BMax 1.50/1.51 '// This is only for achievements '// Huge thanks to skidracer for doing the real work in creating the externals '// Download skidracers steamstub here <a href="https://code.google.com/archive/p/max-edit/downloads" target="_blank">https://code.google.com/archive/p/max-edit/downloads</a> '// See <a href="http://www.blitzmax.com/Community/posts.php?topic=107444" target="_blank">http://www.blitzmax.com/Community/posts.php?topic=107444</a> for setup '// Useful <a href="http://www.blitzmax.com/Community/posts.php?topic=84183" target="_blank">http://www.blitzmax.com/Community/posts.php?topic=84183</a> & <a href="http://www.blitzmax.com/Community/posts.php?topic=96950" target="_blank">http://www.blitzmax.com/Community/posts.php?topic=96950</a> '// REMEMBER '// -------- '// Include a file called steam_appid.txt with the games steam ID in the same location as the application '// Not doing this or the ID being wrong will trigger Steam.NotRunning() ?Win32 Import "steamstub.lib" ? ?MacOS Import "-L/Users/dave/Desktop/sdk_138a/sdk/redistributable_bin/osx32" Import "-lsteam_api" Import "steamstub.cpp" ? Extern "C" Function OpenSteam:Int(gameid:Int) Function ReadSteam$z() Function GetSteamStat:Int(id$z) Function SetSteamStat(id$z,value%) Function GetSteamAchievement:Int(id$z) Function SetSteamAchievement(id$z) Function StoreSteamStats() Function ClearSteamAchievement(id$z) Function CloseSteam() End Extern '// Achievement string names (as set on <a href="http://partner.steamgames.com)" target="_blank">http://partner.steamgames.com)</a> '// Using the test game achievements called "spacewar" (480) Const STEAM_ACHIEVEMENT_01:String = "ACH_WIN_ONE_GAME" Const STEAM_ACHIEVEMENT_02:String = "ACH_WIN_100_GAMES" Const STEAM_ACHIEVEMENT_03:String = "ACH_TRAVEL_FAR_SINGLE" '// Main steam object Global Steam:TSteam = New TSteam '// Initialse Steam with game ID (480, spacewar 'values test game'), also remember set number in steam_appid.txt Steam.Initialise(480) '// Steam not running If Steam.NotRunning() Then Notify "steam not running, open steam and run the game again" ; Steam.Close() ; End '// Set graphics Graphics(640, 480, 0) '// Main Loop ------------------------------- Repeat;Cls '// Save Steam events (optional) Steam.LogEvents() '// Instructions DrawText "Press 1,2,3 to toogle achievements, press SPACE to clear all, ESC to Exit",0,0 '// Draw Achievement status' DrawText "Achievement 1: " + Steam.GetAchievement(STEAM_ACHIEVEMENT_01), 300, 100 DrawText "Achievement 2: " + Steam.GetAchievement(STEAM_ACHIEVEMENT_02), 300, 150 DrawText "Achievement 3: " + Steam.GetAchievement(STEAM_ACHIEVEMENT_03), 300, 200 '// Toggle Acheivement 1 If KeyHit(KEY_1) If Steam.GetAchievement(STEAM_ACHIEVEMENT_01)="0" Steam.SetAchievement(STEAM_ACHIEVEMENT_01) Else Steam.ClearAchievement(STEAM_ACHIEVEMENT_01) EndIf EndIf '// Toggle Acheivement 2 If KeyHit(KEY_2) If Steam.GetAchievement(STEAM_ACHIEVEMENT_02)="0" Steam.SetAchievement(STEAM_ACHIEVEMENT_02) Else Steam.ClearAchievement(STEAM_ACHIEVEMENT_02) EndIf EndIf '// Toggle Acheivement 3 If KeyHit(KEY_3) If Steam.GetAchievement(STEAM_ACHIEVEMENT_03)="0" Steam.SetAchievement(STEAM_ACHIEVEMENT_03) Else Steam.ClearAchievement(STEAM_ACHIEVEMENT_03) EndIf EndIf '// Clear All Achivements If KeyHit(KEY_SPACE) Steam.ClearAchievement(STEAM_ACHIEVEMENT_01) Steam.ClearAchievement(STEAM_ACHIEVEMENT_02) Steam.ClearAchievement(STEAM_ACHIEVEMENT_03) End If '// Draw event log (optional) Steam.DrawEventLog() Flip;Until KeyHit(KEY_ESCAPE) '// --------------------------------------- '// Close steam Steam.Close() '// Steam Object Type TSteam Const STATE_STEAM_ONLINE:Int = 1 Const STATE_STEAM_OFFLINE:Int = 0 Const STATE_STEAM_NOT_RUNNING:Int = -1 Field state:Int Field eventlog:TList = New TList Rem bbdoc: Initialise steam and the game assosiated with the ID End Rem Method Initialise:Int(steamid:Int) state = OpenSteam(steamid) End Method Rem bbdoc: Call before quiting the program to end steam integration, also does a sync End Rem Method Close:Int() CloseSteam() End Method Rem bbdoc: Print steam events to console as they happen, and save in the log (optional) End Rem Method LogEvents:Int(SaveToLog:Int = True) Local a:String = ReadSteam() If a <> "" Then brl.standardio.Print(a) If a <> "" And SaveToLog Then eventlog.AddLast(a) End Method Rem bbdoc: Draw steam events to the screen (optional) End Rem Method DrawEventLog:Int() Local y:Int For Local a:String = EachIn eventlog DrawText(a, 0, y+20) ; y:+10 Next End Method Rem bbdoc: Is steam online? if not achievements are saved locally and synced later when online End Rem Method Online:Int() If state = STATE_STEAM_ONLINE Then Return True End Method Rem bbdoc: Is steam offline? if it is achievemens are saved locally and synced later when online End Rem Method Offline:Int() If state = STATE_STEAM_OFFLINE Then Return True End Method Rem bbdoc: Is steam running? probably best to prevent the game from running if true End Rem Method NotRunning:Int() If state = STATE_STEAM_NOT_RUNNING Then Return True End Method Rem bbdoc: Get state of the achievement, if an INT achievement 0 = not achieved or 1 = achieved, returned as String for compatability End Rem Method GetAchievement:String(steam_api_achievement_name:String) Return GetSteamAchievement(steam_api_achievement_name) End Method Rem bbdoc: Set achievement as achieved, by default store and sync to steam End Rem Method SetAchievement:String(steam_api_achievement_name:String, store:Int = True) SetSteamAchievement(steam_api_achievement_name) If store Then Self.StoreStats() End Method Rem bbdoc: Clear achievement then store and sync to steam End Rem Method ClearAchievement:String(steam_api_achievement_name:String, store:Int = True) ClearSteamAchievement(steam_api_achievement_name) If store Then Self.StoreStats() End Method Rem bbdoc: Call to sync achievments to steam, typically after getting an acheivement, also called by CloseSteam() end rem Method StoreStats() StoreSteamStats() End Method End Type steamstub.cpp #define _CRT_SECURE_NO_WARNINGS //#include <windows.h> #include <string> #include "/Users/dave/Desktop/sdk_138a/sdk/public/steam/steam_api.h" #define BBDECL extern "C" //_declspec(dllexport) SteamLeaderboard_t handle=0; std::string steamlog; class CStatsAndAchievements { public: CGameID m_GameID; CStatsAndAchievements( void *pGameEngine,int gameID ); STEAM_CALLBACK( CStatsAndAchievements, OnUserStatsReceived, UserStatsReceived_t, m_CallbackUserStatsReceived ); STEAM_CALLBACK( CStatsAndAchievements, OnUserStatsStored, UserStatsStored_t, m_CallbackUserStatsStored ); STEAM_CALLBACK( CStatsAndAchievements, OnAchievementStored, UserAchievementStored_t, m_CallbackAchievementStored ); STEAM_CALLBACK( CStatsAndAchievements, OnFindScores, LeaderboardFindResult_t, m_CallbackFindScores ); STEAM_CALLBACK( CStatsAndAchievements, OnDownload, LeaderboardScoresDownloaded_t, m_CallbackDownloaded ); STEAM_CALLBACK( CStatsAndAchievements, OnUpload, LeaderboardScoreUploaded_t, m_CallbackUploaded ); STEAM_CALLBACK( CStatsAndAchievements, OnCount, NumberOfCurrentPlayers_t, m_CallbackCount ); }; CStatsAndAchievements::CStatsAndAchievements( void *pGameEngine ,int gameID ): m_CallbackUserStatsReceived( this, &CStatsAndAchievements::OnUserStatsReceived ), m_CallbackUserStatsStored( this, &CStatsAndAchievements::OnUserStatsStored ), m_CallbackAchievementStored( this, &CStatsAndAchievements::OnAchievementStored ), m_CallbackFindScores( this, &CStatsAndAchievements::OnFindScores ), m_CallbackDownloaded( this, &CStatsAndAchievements::OnDownload ), m_CallbackUploaded( this, &CStatsAndAchievements::OnUpload ), m_CallbackCount( this, &CStatsAndAchievements::OnCount ), m_GameID( gameID ) { // m_GameID..Set( uint32 unAccountID, EUniverse eUniverse, EAccountType eAccountType ) } void CStatsAndAchievements::OnDownload( LeaderboardScoresDownloaded_t *download ){ LeaderboardEntry_t entry; int32 details[256]; char buffer[128]; int n; _snprintf( buffer, 128, "download=%d!", download->m_cEntryCount ); steamlog.append(buffer); for ( int index = 0; index < download->m_cEntryCount; index++ ){ SteamUserStats()->GetDownloadedLeaderboardEntry( download->m_hSteamLeaderboardEntries, index, &entry, details, 256 ); //n=_snprintf( buffer, 128, "%d:%d:%d:", entry.m_nScore,entry.m_nGlobalRank,entry.m_steamIDUser); steamlog.append(buffer); for( int i=0;i<entry.m_cDetails;i++){ steamlog.push_back((char)details[i]); } steamlog.append("!"); } } void CStatsAndAchievements::OnUpload( LeaderboardScoreUploaded_t *up ){ char buffer[128]; if(up->m_bSuccess && up->m_bScoreChanged){ _snprintf( buffer, 128, "upload=%d:%d:%d!", up->m_nScore,up->m_nGlobalRankNew,up->m_nGlobalRankPrevious ); steamlog.append(buffer); } } void CStatsAndAchievements::OnFindScores( LeaderboardFindResult_t *t ){ char buffer[128]; if(t->m_bLeaderboardFound){ handle=t->m_hSteamLeaderboard; _snprintf( buffer, 128, "found=%s:%d!", SteamUserStats()->GetLeaderboardName(t->m_hSteamLeaderboard), SteamUserStats()->GetLeaderboardEntryCount(t->m_hSteamLeaderboard)); steamlog.append(buffer); } } void CStatsAndAchievements::OnCount(NumberOfCurrentPlayers_t *n){ char buffer[128]; _snprintf( buffer, 128, "playercount=%d!", n->m_cPlayers); steamlog.append(buffer); } void CStatsAndAchievements::OnUserStatsReceived( UserStatsReceived_t *pCallback ) { // we may get callbacks for other games' stats arriving, ignore them if ( m_GameID.ToUint64() == pCallback->m_nGameID ) { if ( k_EResultOK == pCallback->m_eResult ) { steamlog.append("stats received!"); } else { char buffer[128]; _snprintf( buffer, 128, "stats failed %d!", pCallback->m_eResult ); steamlog.append( buffer ); } } } void CStatsAndAchievements::OnUserStatsStored( UserStatsStored_t *pCallback ) { // we may get callbacks for other games' stats arriving, ignore them if ( m_GameID.ToUint64() == pCallback->m_nGameID ) { if ( k_EResultOK == pCallback->m_eResult ) { steamlog.append("stats stored!"); } else { char buffer[128]; _snprintf( buffer, 128, "stats stored failed %d!", pCallback->m_eResult ); steamlog.append( buffer ); } } } void CStatsAndAchievements::OnAchievementStored( UserAchievementStored_t *pCallback ) { // we may get callbacks for other games' stats arriving, ignore them if ( m_GameID.ToUint64() == pCallback->m_nGameID ) { if ( 0 == pCallback->m_nMaxProgress ) { char buffer[128]; _snprintf( buffer, 128, "Achievement '%s' unlocked!", pCallback->m_rgchAchievementName ); steamlog.append(buffer); } else { char buffer[128]; _snprintf( buffer, 128, "Achievement '%s' progress %d:%d!", pCallback->m_rgchAchievementName, pCallback->m_nCurProgress, pCallback->m_nMaxProgress ); steamlog.append( buffer ); } } } #define MAXPLAYERFETCH 256 #define BUFFERSIZE 4096+MAXPLAYERFETCH*512 char rbuffer[BUFFERSIZE]; BBDECL char *ReadSteam(){ SteamAPI_RunCallbacks(); _snprintf(rbuffer,BUFFERSIZE,"%s",steamlog.c_str()); steamlog=""; return rbuffer; } CStatsAndAchievements *stats; BBDECL void StoreSteamStats(){ SteamUserStats()->StoreStats(); } // stats BBDECL int GetSteamStat(const char *id){ int32 res; if (!SteamUserStats()->GetStat(id,&res )){ return -1; } return res; } BBDECL void SetSteamStat(const char *id,int32 value){ SteamUserStats()->SetStat(id,value); } // achieves BBDECL int GetSteamAchievement(char *id){ bool res; SteamUserStats()->GetAchievement(id,&res ); return res?1:0; } BBDECL void SetSteamAchievement(const char *id){ SteamUserStats()->SetAchievement(id); } BBDECL void ClearSteamAchievement(const char *id){ SteamUserStats()->ClearAchievement(id); } BBDECL int GetSteamAchievementIcon(const char *pchName){ return SteamUserStats()->GetAchievementIcon( pchName ); } // Get general attributes (display name / text, etc) for an Achievement BBDECL const char *GetAchievementDisplayAttribute( const char *pchName, const char *pchKey ){ return SteamUserStats()->GetAchievementDisplayAttribute( pchName, pchKey ); } // Achievement progress - triggers an AchievementProgress callback, that is all. // Calling this w/ N out of N progress will NOT set the achievement, the game must still do that. BBDECL int IndicateAchievementProgress( const char *pchName, uint32 nCurProgress, uint32 nMaxProgress ){ return SteamUserStats()->IndicateAchievementProgress( pchName, nCurProgress, nMaxProgress )?1:0; } char leadname[256]; BBDECL void FindOrCreateLeaderboard( char *name, ELeaderboardSortMethod sortmethod, ELeaderboardDisplayType displaytype ){ handle=0; sprintf(leadname,name); SteamUserStats()->FindOrCreateLeaderboard(leadname,sortmethod,displaytype); } BBDECL void FindLeaderboard( char *name ){ handle=0; sprintf(leadname,name); SteamUserStats()->FindLeaderboard(leadname); } BBDECL void UploadLeaderboardScore( ELeaderboardUploadScoreMethod method, int32 score, char *details ) { int data[256]; int i; if(handle==0){ steamlog.append( "no leaderboard open!" ); return; } for(i=0;i<255;i++){ if ((data[i]=details[i])==0){ break; } } data[i++]=0; SteamUserStats()->UploadLeaderboardScore(handle,method,score,data,i); } BBDECL void FindNumberOfCurrentPlayers() { SteamUserStats()->GetNumberOfCurrentPlayers(); } BBDECL void DownloadLeaderboardEntries( ELeaderboardDataRequest request, int start, int end ) { if(handle==0){ steamlog.append( "no leaderboard open!" ); return; } if(end-start>MAXPLAYERFETCH){ end=start+MAXPLAYERFETCH; } SteamUserStats()->DownloadLeaderboardEntries(handle,request,start,end); } BBDECL void CloseSteam(){ SteamAPI_Shutdown(); } BBDECL int OpenSteam(int gameID){ if(!SteamAPI_Init()){ return -1; } CSteamID steamid; bool loggedon; steamid=SteamUser()->GetSteamID(); loggedon=SteamUser()->BLoggedOn(); int res=1; // engine=new CGameEngine( hInstance, nCmdShow, 1024, 768 ); stats=new CStatsAndAchievements(&res,gameID); SteamUserStats()->RequestCurrentStats(); // SteamUserStats()->SetStat("Player hatched",50); // SteamUserStats()->StoreStats(); return loggedon?1:0; }

Pingus (Posted 2016) [#2]

Thanks, it will be definitivly usefull one day.