openfort-xyz / openfort-unreal-engine

UE5 SDK for building games that interact with blockchains. 🎮

Website | Documentation | API Docs | Twitter

Openfort UE5 SDK

Installation

1. Create a Plugins folder at the root of your project
2. Copy the Openfort plugin there
3. Open your project in Unreal Editor
4. Verify that the plugin is installed
5. Reduild your project

Components

• Openfort - the main component of the plugin, which includes the functionality related to the session keys and has integration with Openfort API

Functions

Session key related

• GenerateSessionKey - generates a new key pair for the Openfort session
• InitializeSessionKey - initialize Openfort component based on the private key hex (privateKey parameter), saved in the game
• GetSessionPublicKeyHex - returns the public key in the hex format for the current session key pair
• GetSessionPrivateKeyHex - returns the private key in the hex format for the current session key pair
• GetSessionAddressHex - returns the address in the hex format for the current session key pair
• SignMessage - signs with the session key the message provided as a parameter for the function

API Client

• SetApiKey - set the API key to the Openfort client to be able to connect to the Openfort API
• SignatureSession - sends the signature session request to the Openfort API
• SignatureTransactionIntent - sends the signature transaction intent request to the Openfort API

Getting Started

The following blueprints are provided as examples of the basic functionality and can be modified according to the architecture and needs of the project

Generate key

Load key

Calling Signature Session API method