This repository contains an Unreal Engine 5 sample project that uses the Unreal Engine Web Browser module (and Web Browser Widget) to embed the Ready Player Me character creator inside an application to create a seamless integration.
NOTE: The Web Browser module will only work with our readyplayer.me website in Unreal Engine 5. The Web Browser module in Unreal Engine 4 uses a very old version of chromium which does not support all the modern web browser features.
The WebBrowserDemo map located in the Content folder is a good starting point for anybody wanting to use the Web Browser module to seamlessly integrate our RPM web platform into you game or application. The logic for this is rather simple, if you open up the Level Blueprint you will see this network of nodes.
In the first group of nodes, connected to the BeginPlay event we create and add our custom Ready Player Me Browser widget to the viewport before setting ShowMouseCursor to true so that the user can see the cursor and interact with the browser widget.
Next we bind the RPM Browser widget's Avatar Generated Event to run the Load New Avatar event on a RPM Actor blueprint present in the map. The Avatar Generated Event is called from the web browser widget once the avatar creation process is complete and it returns a URL to the RPM avatar GLB file, which we subsequently load into the scene.
To display and interact with the a web browser inside unreal you need to use a UI Widget. For this demo we created the RPM_BrowserWidget located in Content > Blueprints. If you open up the widget you will in the Hierarchy panel that it consists of a CanvasPanel and a RPM Web Browser widget inside of it.
It is set up this way so that the RPM Browser Widgets position, padding and anchor settings can be easily adjusted relative to the Canvas Panel. If you select the RPM_Browser object in the hierachy you will most likely need to update the InitialUrl setting. This is the Url that will be loaded when this Widget is created/added to the scene.
By default we set it to demo.readyplayer.me/avatar however as the name suggests this is only recommended for demo's. we highly recommend you become a Ready Player Me partner and get your own partner space. For example "yourprojectname.readyplayer.me". Once you have your own partner space setup you update this Initial Url accordingly.
Next open up the Graph for the Ready Player Me Browser Widget and you will see this network of nodes.
Lets take at the first group of nodes connected to the widget's construct event. Here bind a custom event to the WebBrowserWidgets OnUrlChanged event that runs the RunBrowserSetup function. This is done on OnUrlChanged to ensure the the browser has actually started loading the website before starting to load the initial Url. Without this there is issues when it comes to injecting custom javascript. Lastly we also unbind the event so it doesn't run the setup again.
As you may have noticed the Setup Browser function above has a callback function called Response. To make use of this there is the AvatarGeneratedCallback event which will call the AvatarGeneratedEvent. The AvatarGenerated event it a an Event Dispatcher that can be subscribed to. This was added to make it easy to connect callback functions whenever an avatar has been created. Next we also have a groud of nodes to handle an optional AutoHide feature. If the HideAfterAvatarGeneration property is set to true it will automatically hide the widget after character creation is complete.
The Web Link class is a simple UObject with the sole purpose of linking Web Browser javascript events back to Unreal engine via a dynamic delegate. By doing this we can listen to specific javascript events inside the Web Browser Widget to trigger functions and receive data from the browser.
The SetAvatarUrlCallback function is what we use to assign the callback (delegate) function to be run once the avatar creation process is complete.
void UWebLink::SetAvatarUrlCallback(FReadyPlayerWebBrowserResponse webBrowserCallback)
{
UWebLink::WebBrowserResponse = webBrowserCallback;
}The AvatarGenerated function is run when the browser event is triggered upon completion of avatar creation. In here we simply check the response is a Ready Player Me avatar url by searching for ".glb", otherwise it exits the function.
FString url = "";
if (jsonResponse.Contains(TEXT(".glb"))) {
UE_LOG(LogTemp, Warning, TEXT(".glb found "));
url = jsonResponse;
}
if (url.IsEmpty()) {
return;
}If a Ready Player Me avatar url is found then we run the callback function, passing the Url as a parameter. We also store the url in in a lastAvatarUrl property in case we need to check it later.
UWebLink::WebBrowserResponse.Execute(url);
lastAvatarUrl = url;This is another rather simple class, based on the UWebBrowser class it adds a few extra functions for setting up the connection between the Web Browser and Unreal engine using the Web Link object we covered previously.
To understand how this works we will first look at the BindBrowserToObject() function.
Initially it creates a UWebLink object, if it doesn't already exist.
UReadyPlayerMeWebBrowser::webLinkObject = NewObject<UWebLink>(UWebLink::StaticClass());Then we rename it, this part is important as the name is used as an ID when linking back the javascript event.
webLinkObject->Rename(*UReadyPlayerMeWebBrowser::linkObjectName);Lastly we bind the WebLink object to the browser widget to ensure it's permanantly connected.
WebBrowserWidget->BindUObject(UReadyPlayerMeWebBrowser::linkObjectName, webLinkObject, true);Now lets take a look at the SetupBrowser(FReadyPlayerWebBrowserResponse webBrowserCallback) function.
To begin it runs the BindBrowserToObject function mentioned previously.
UReadyPlayerMeWebBrowser::BindBrowserToObject();Next we set the callback function (delegate) to be run once creation is complete.
webLinkObject->SetAvatarUrlCallback(webBrowserCallback);Finally we execute the custom javascript that we use to listen to the website event that fires when the avatar creation process is complete.
this->ExecuteJavascript(UReadyPlayerMeWebBrowser::javascriptSnippet);- Ready Player Me Unreal SDK
- glTFRuntime (Third party plugin)
Ready Player Me Unreal SDK
glTFRuntime