This course is a walkthrough for integrating and using the Epic Online Services (EOS) Online Subsystem (OSS) plugin in Unreal Engine. The course was written for UE 5.1, though the code should work in future versions of UE, in UE 5.0 and in UE4.27.
Important Note
I’m maintaining the code on the GitHub repo, but I’m not updating the code snippets in the course content. There will be some minor differences!
This is NOT an issue. I didn’t explain this well at all in the code comments. With bShouldAdvertise set to true, this will supersede the bAllowJoinViaPresence and bAllowJoinViaPresenceFriendsOnly on our backend and set them to true. With bShouldAdvertise set to true, the session is public and can be found by anyone. Sorry for the confusion this caused.
I would like to report (small) errors in the documentation:
in the chapter “Setting up a dedicated server to host EOS sessions”, the DestroySession() method is not provided. Instead we get a duplicate of the EndPlay() method.
in the HandleEndSessionCompleted() method, we clear the “Start” delegate instead of the End delegate: Session->ClearOnEndSessionCompleteDelegate_Handle(StartSessionDelegateHandle);
HI! I just discovered this course, after weeks of banging my head against the wall to get the EOS OSS plugin working, too bad I didn’t see it sooner!
Now I’m trying to implement Leaderboards and Achievements, and I see that should be the next Topic of the course!
Do you already have a release date planned for that chapter?
Thanks so much for this course, there is very little documentation on the subject online.
It’s currently in review. I don’t have a precise ETA to share, but it should be coming out in the next few weeks. If ever you’re in a jam and need help before, you can open a ticket on our EOSHelp platform: Epic Online Services (EOS) Developer Support
Yes there’s a few reason we opted for AGameSession over a UGameInstance. The project in this course is meant to be an example of a simple multiplayer game, where players join a session to play a match on the same map. Data isn’t persisted across sessions once a session is ended. In other words, the data is relevant to the session, not the entire game. The AGameSession is a nice wrapper around the session interface. As the EOS OSS uses this interface, you can leverage the functions, events, etc… in the base class or use overrides to tweak the behavior as needed (as I did in this course). Let us know if you have follow up questions.
I will have to go through this all again. At this moment I have dedicated servers running on PlayFAB but am using the Lyra Example Game as base. The register and update players part for me doesn’t seem to work as of now. And the backend says the servers are not active but they are (I can connect to them with the open {ip:port} command and get destroyed by the bots
Thank you very much for this course! You mentioned in the course, “query stat and achievements,” if you have time, I am curious about how to query stat and achievements. Thanks again!
Also for the register player. Doesn’t the UniqueID give the EOS string? (Epic account id + eos player user id (PUID with a | separator? Wouldn’t this always fail the register player part?)
Hey! Yes, with Epic Account Services being used, the UniqueId is “EpicAccountId | EOS PUID”. In FOnlineSessionEOS::RegisterPlayers() we have some code that will retrieve the EOS PUID
from the UniqueId and use this to register the player. If you’re running into an issue registering your player on the EOS backend, there should be a hint in your logs. You can also attach to your game and check the EOS_EResult in Data->ResultCode in the CallbackObj.
I’m a bit confused by your code to search for a dedicated server session? Why do you have LOBBYSEARCH in your QuerySettings?
Hi and thanks for responding, I already have it working I split the string so I will get both the Epic Account ID and the Player PUID.
I have the servers working / hosted on PlayFAB all is working fine (except the search). I define LOBBYSEARCH false ? and Dedicated to true? Or should I simply omit the LOBBYSEARCH all together.?
Here is some code for Stats. I’ll work on getting some code for achievements by end of week.
// Additional code to query stats - Example not included in course
void AEOSPlayerState::QueryStats(TArray<FString> StatNames)
{
// This function will query EOS Stats
IOnlineSubsystem* Subsystem = Online::GetSubsystem(GetWorld());
IOnlineIdentityPtr Identity = Subsystem->GetIdentityInterface();
IOnlineStatsPtr Stats = Subsystem->GetStatsInterface();
// Check if player is online before trying to update stat
FUniqueNetIdPtr NetId = Identity->GetUniquePlayerId(0);
if (!NetId || Identity->GetLoginStatus(*NetId) != ELoginStatus::LoggedIn)
{
return;
}
// Same idea as UpdateStats, use an inline lambda - We are only querying for local player only in this example.
// You need to pass in a list of StatNames. Querying for all stats is not supported.
TArray<TSharedRef<const FUniqueNetId>> Users;
Users.Add(NetId.ToSharedRef());
Stats->QueryStats(NetId.ToSharedRef(),Users, StatNames,
FOnlineStatsQueryUsersStatsComplete::CreateLambda([](
const FOnlineError& QueryResult,
const TArray<TSharedRef<const FOnlineStatsUserStats>>& UsersStats)
{
if (!QueryResult.bSucceeded)
{
UE_LOG(LogTemp, Warning, TEXT("Error querying player statistics: %s"), *QueryResult.ErrorCode);
return;
}
// double loop to loop through all users and all stats
for (auto UserStats : UsersStats)
{
// Account we are about to loop through stats
FUniqueNetIdRef NetId = UserStats->Account;
for (auto StatNameValuePair : UserStats->Stats)
{
FString StatName = StatNameValuePair.Key;
FVariantData StatValue = StatNameValuePair.Value;
}
}
}));
}
I split the string so I will get both the Epic Account ID and the Player PUID.