Skip to main content

Installing PnP Unreal Engine SDK

Installation​

Follow these instructions to install the web3auth-unreal-sdk plugin:

  • Close your existing Unreal Engine app.
  • Create a directory in your app root called Plugins.
  • Clone with
git clone https://github.com/Web3Auth/web3auth-unreal-sdk/tree/main/Plugins/Web3AuthSDK ./Plugins/Web3AuthSDK
  • Open UE5 Editor, navigator to Menu → Edit → Plugins , check the option to enable Web3AuthSDK.
  • Start your app & it will ask to compile the plugin. Proceed with that.

Manual Installation​

Download the Unreal Package from our latest release and import the package file into your existing Unreal Engine project.

Configuration​

Configure a Plug n Play project​

  • Go to Developer Dashboard, create or select an Web3Auth project:

  • Add {{SCHEMA}}://{YOUR_APP_PACKAGE_NAME} to Whitelist URLs.

  • Copy the Client ID for usage later.

To setup Android sdk and ndk for unreal editor. Please see the unreal documentation.

  • To add redirect URI into your Android app, open the <Project-Path>/Plugins/Web3AuthSDK/Source/Web3AuthSDK_Android.xml file.

  • Find the <androidManifestUpdates> tag and inside that, will be a <data> tag element. Replace the exisitng redirect URI with one that you have registered on your Web3Auth Dashboard.

android deep link

To setup iOS for unreal editor. Please see the unreal documentation.

To add redirect URI in your iOS configuration, you just have to add the redirect URI schema.

i.e. if web3authapp://com.web3auth.Web3AuthUnreal is your registered redirect URI then the schema is web3authapp.

  • Update the following xml object and replace the {schema} with your own redirectURI schema.
<key>CFBundleURLTypes</key>
<array>
	<dict>
		<key>CFBundleURLName</key>
		<string>{schema}</string>
		<key>CFBundleURLSchemes</key>
		<array>
			<string>{schema}</string>
		</array>
	</dict>
</array>
  • Paste the above string with updated schema into Edit → Project Settings → IOS → Extra Plist Data
iOS Extra Plist data