Skip to content

0xsequence/sequence-unreal

Repository files navigation

header

Sequence Unreal SDK

The Sequence Unreal Embedded Wallet SDK provides full Sequence Embedded Wallet and Indexer integration for your Unreal Framework games.

Docs Boilerplate

Intro

Supported Platforms

  • Unreal Engine 5.2, 5.3, or 5.4
  • PC Standalone
  • Mac Standalone
  • Android
  • iOS

Samples

The SDK comes with a number of samples that can be imported used from the SequencePlugin Content/Core directory.

How to release a new version

  1. Increase the "VersionName" field inside the SequencePlugin.uplugin & SequenceRPCManager.h files.
  2. Merge the master branch into the 5_2_downgrade branch and check if it compiles.
  3. Merge the 5_2_downgrade branch into the 5_3_downgrade branch and check if it compiles.
  4. In the Unreal Editor, go inside the Plugins Window and package the plugin for all supported versions.
    1. Before packaging, make sure to temporarily remove IOS from SupportedTargetPlatforms. Add it back to the list inside the packaged files.
    2. Remove the Intermediate and Binaries inside the packaged folder.
    3. Create a zip files of the packaged folder without compression.
      1. MacOS command: ditto -c -k --sequesterRsrc --keepParent --zlibCompressionLevel 0 ./SequencePlugin SequenceUnreal_1-5-0_UE-5-4.zip
      2. Windows PowerShell: Compress-Archive -CompressionLevel NoCompression -Path 'SequencePlugin' -DestinationPath 'SequenceUnreal_1-5-0_UE-5-4.zip'
  5. Create a git tag of the master branch including the version name, like Sequence_1_0_0.
  6. Create a release on GitHub, collect changelogs and upload the file builds for all supported versions.

Upgrading to Unreal 5.4

If your project is currently on 5.2 or 5.3, then for this version you'll want to upgrade to 5.4. To do this close the Unreal Editor, Close your Code Editor. Right-click on your Unreal Project file. Then select Switch Unreal Engine Version, Choose 5.4 and click okay. Once done. Open your code editor and rebuild your source code.

As a way of future proofing we recommend installing visual studio 2022 in accordance with these docs as Unreal 5.4 and onward will be dropping support for visual studio 2019.

TroubleShooting

In events where the editor crashes on launch, try deleting the following file, Saved/SaveGames/Cr.sav This file contains the savegame data for credentials and if modified can result in an engine crash. Deleting this file deletes local credentials, so you'll need to log back in.