Skip to main content

Get Started

This plugin was created using UE 5.0.3. It should be supported by any UE 5 version, and could probably be converted to late UE 4 without too much trouble. Follow the steps below to integrate it to your project.

Integration

Unreal plugins are easily integrated to any project in a few steps.

There is currenly no packaged version of the plugin available, you need to download the source directly from this Repository. Once downloaded, copy it into the Plugins folder at the root of the project. Create it if necesserary.

You must then activate the plugin.

  • Open the project in the Unreal Editor.
  • Go to Edit > Plugins.
  • In Project > Other, select Web3ByRustLibrary.
  • Restart for the change to take effect.

The plugin is setup. You can access its classes and functionalities. Try browsing the available blueprint functions under "Web3" !

Configuration

Most functionnalities do not require a configuration. However, if you plan on signing challenges without wallet, add the following to DefaultGame.ini :

[/Script/Web3ByRustLibrary.GISubWcClient]
OwnerPrivateKey=<PrivateKey to sign with, as hex without 0x>
OwnerPublicKey=<Corresponding PublicKey as hex without 0x, should be Identity manager>
IdentityAddress=<Identity contract address on which to verify claims, as hex with 0x>

Available functionalities

Before jumping into it, we suggest you look a little further into how to properly use the plugin :