Migration from v4.x.x to v5.0.x

If you have already developed your online gaming architecture using the protobuf.net and SDK 4.2 you probably don’t want to migrate to this SDK. By using Protobuf C# and *.proto files, the SDK 5 essentially helps new projects. You may also be interested in SDK 5 if you need the latests features of the Scalable Server: we are up to date with the latest version of the communication protocol.

  • Scalable Server:

    Previously you had to create an external C# project in order to generate the serializer for your game messages. All this part has been removed from the SDK. Starting with SDK 5.0 we rely on the official Protobuf C# and all transfer protocol must be declared in *.proto files. ServerConnection is still responsible for sending and receiving raw requests, and we provide high level services with completion actions.

  • REST API:

    • GameStatus enum has become a flag which can create serialization problems with custom serialiazer

    • News endpoints :
      Endpoint name Link to the documentation
      GameAvatarGetListEndpoint http://apidoc.asmodee.net/#api-game-GetAvatarsList
      GameAvatarGetFiltersListEndpoint http://apidoc.asmodee.net/#api-game-GetAvatarFilterList
      UserBuddiesGetCollectionEndpoint http://apidoc.asmodee.net/#api-user-GetUserBuddiesCollection
      GameGameGetListEndpoint http://apidoc.asmodee.net/#api-game-GetGameList
      UserOnlineGameGetUserGameArchivesEndpoint http://apidoc.asmodee.net/#api-user-GetUserAllGames
      UserOnlineFeatureGiveEndpoint http://apidoc.asmodee.net/#api-user-PostOnlineFeature
      UserOnlineGameGetHistorySummariesEndpoint http://apidoc.asmodee.net/#api-user-GetAllGamesSummary
      UserSubscriptionsEditSubscriptionsEndpoint http://apidoc.asmodee.net/#api-user-UserSubscribe
      UserSubscriptionsGetListEndpoint http://apidoc.asmodee.net/#api-user-UserSubscriptions
      UserSubscriptionsUnsubscribeEndpoint http://apidoc.asmodee.net/#api-user-UserSubscribe
      ShowcaseShowcaseGetLastChangeEndpoint http://apidoc.asmodee.net/#api-showcase-GetShowcaseV1LastChange
    • Renamed endpoints :
      Previous New
      GetAchievementByIdEndpoint GameAchievementGetByIDEndpoint
      GetAchievementByTagEndpoint GameAchievementGetByTagEndpoint
      GetAchievementListEndpoint GameAchievementGetListEndpoint
      AvatarGetFiltersEndpoint GameAvatarGetFiltersListEndpoint
      AddAwardsEndpoint UserAwardAddEndpoint
      GetAwardsEndpoint UserAwardGetListEndpoint
      RemoveAwardsEndpoint UserAwardRemoveEndpoint
      AddBuddyEndpoint UserBuddiesAddEndpoint
      GetBuddyEndpoint UserBuddiesGetListEndpoint
      RemoveBuddyEndpoint UserBuddiesRemoveEndpoint
      FetchGameRankEndpoint GameRanksFetchEndpoint
      GameRanksFetchEndpoint UserRankFetchEndpoint
      GetGameDataEndpoint UserGameDataGetEndpoint
      RemoveGameDataEndpoint UserGameDataRemoveEndpoint
      SetGameDataEndpoint UserGameDataSetEndpoint
      AddIgnoredEndpoint UserIgnoreAddEndpoint
      RemoveIgnoredEndpoint UserIgnoreRemoveEndpoint
      GetIgnoredEndpoint UserIgnoreGetListEndpoint
      LeaderboardGetRankAndScoreEndpoint UserLeaderboardGetRankScoreEndpoint
      LeaderboardPublishScoreForAllPeriodEndpoint UserLeaderboardPublishScoreInAllPeriodEndpoint
      LeaderboardPublishScoreForOnePeriodEndpoint UserLeaderboardPublicScoreForOnePeriodEndpoint
      LeaderboardRequestGivenGameEndpoint GameLeaderboardGetLeaderboardForGameEndpoint
      AddRemoveMultipleEndpoint UserOnlineFeatureAddRemoveFeaturesEndpoint
      GetLastGamesEndpoint UserOnlineGameGetRecentGamesEndpoint
      GetUserAllGamesEndpoint UserOnlineGameGetUserGameArchivesEndpoint
      GetLastOpponentsEndpoint UserOnlineGameGetRecentOpponentsEndpoint
      SearchByEmailEndpoint UserSearchByEmailEndpoint
      SearchByPartnerEndpoint UserSearchByIdEndpoint
      SearchByIdEndpoint UserSearchSearchByIdEndpoint
      SearchLoginsStartingWithEndpoint UserSearchByLoginNameEndpoint
      RequestBannerEndpoint ShowcaseProductGetBannerEndpoint
      RequestGamesEndpoint ShowcaseProductGetGameEndpoint
      RequestInterstitialEndpoint ShowcaseProductGetInterstitialEndpoint
      GetUserDetailsEndpoint UserUserGetUserDetailsEndpoint
      UpdateUserDetailsEndpoint UserUserUpdateDetailsEndpoint
      UpdateEmailEndpoint UserEmailNewsletterUpdateEmailEndpoint
      UpdateNewsletterEndpoint UserEmailNewsletterUpdateSubscriptionEndpoint
      UpdateEmailAndNewsletterEndpoint UserEmailNewsletterUpdateEndpoint
      LinkUnlinkMultipleEndpoint UserPartnerLinkUnlinkPartnersEndpoint
      UserSignUpEndpoint UserUserSignUpEndpoint
      ResetPasswordEndpoint UserPasswordResetPasswordEndpoint
    • Renamed endpoint datas :
      Previous New
      ApiShowcaseProduct ShowcaseProductGetBannerData
      Award AwardData
      BuddyOrIgnored BuddyOrIgnoredData
      Achievement GameAchievementGetData
      ApiAvatarGetList GameAvatarGetFiltersListData
      ApiAvatarGet GameAvatarGetListData
      ApiGameGetList GameGameGetGameListData
      GameLeaderboard GameLeaderboardGetLeaderboardForGameData
      FetchGameRank GameRanksFetchData
      BuddyCollection UserBuddiesGetCollectionData
      LeaderboardScoringInfo UserLeaderboardData
      OnlineGame UserOnlineGameGameData
      RecentOpponent UserOnlineGameRecentOpponentsData
      PartnerAccount UserPartnerPartnerData
      FetchRank UserRankGetUserRankData