|
1 | | - |
| 1 | + |
2 | 2 |
|
3 | | -[<img alt="Unreal Documentation" src="https://img.shields.io/badge/Unreal SDK-Documentation-red?logo=unreal&style=for-the-badge" height="30">](https://portal.thirdweb.com/unreal) |
| 3 | +[][documentation-url] |
| 4 | +[][marketplace-url] |
4 | 5 |
|
5 | 6 | # Thirdweb Unreal Engine SDK Plugin |
6 | 7 |
|
7 | | -A Code Plugin for Unreal Engine that enables developers to create thirdweb Private Key Wallets, In-App Wallets and Smart Wallets for their games and applications. The plugin provides a simple API and blueprints to interact with wallets, login with email or socials as well as create Smart Wallet session keys. |
| 8 | +A Code Plugin for Unreal Engine that enables developers to create thirdweb Private Key Wallets, In-App Wallets and |
| 9 | +Smart Wallets for their games and applications. The plugin provides a simple API and blueprints to interact with |
| 10 | +wallets, login with email or socials as well as create Smart Wallet session keys. |
8 | 11 |
|
9 | | -With this plugin, you can keep the onboarding of your users in-client and grant a session key to your [thirdweb Engine](https://portal.thirdweb.com/engine) powered backend to interact with the blockchain, no signature in sight. |
| 12 | +With this plugin, you can keep the onboarding of your users in-client and grant a session key to your |
| 13 | +[thirdweb Engine](https://portal.thirdweb.com/engine) powered backend to interact with the blockchain, |
| 14 | +no signature in sight. |
10 | 15 |
|
11 | | -The Thirdweb Unreal Plugin is distributed as an [Unreal Marketplace Code Plugin](https://www.unrealengine.com/marketplace/en-US/product/f21200c2610146f3888172994448e50d). |
| 16 | +## Supported Unreal Engine Versions |
| 17 | + |
| 18 | +Thirdweb adheres to Unreal Engine's Marketplace Guidelines in supporting the 3 most recent versions[^1]. |
| 19 | +We aim to release an updated plugin version as expediently as possible once a minor version change has released. |
| 20 | +If you or your company require compatibility with an older version, please reach out to [support][support-url]. |
12 | 21 |
|
13 | 22 | ## Installation |
14 | 23 |
|
15 | | -The Unreal SDK is distributed as an [Unreal Marketplace Plugin](https://www.unrealengine.com/marketplace/). |
| 24 | +In addition to the source code provided, the plugin is available on the [Unreal Marketplace][marketplace-url]. |
16 | 25 |
|
17 | 26 | The plugin's core logic is built from Rust, making it lightning-fast and minimizing the clutter in your Unreal project. |
18 | 27 |
|
19 | | -It currently is built to support Win64 platforms and was tested in UE 5.4. |
| 28 | +## Packaging |
| 29 | + |
| 30 | +Windows, Linux, and Android all package natively and can be used in blueprint-only projects |
| 31 | + |
| 32 | +### Mac |
| 33 | + |
| 34 | +The plugin currently makes use of the [Web Browser][web-browser-doc] runtime module which bundles [CEF3][cef-forum]. |
| 35 | +Changes to the engine are currently required for modern xcode targets as Unreal Engine does not properly link |
| 36 | +the framework during packaging. This requires either an engine patch or moving the framework post-build and |
| 37 | +then codesigning your build again. |
| 38 | + |
| 39 | +In the [CEF3.build.cs][cef3-build-cs] you need to bypass the `if` check for modern xcode. This can be accomplished by |
| 40 | +adding `|| true` to the end of the if check on line 102. |
| 41 | + |
| 42 | +Additionally, you need to add `bCompileCEF3 = true;` to your build target |
| 43 | + |
| 44 | +## Supported Platforms & Architectures |
| 45 | + |
| 46 | +| Platform | x64 | arm64 | |
| 47 | +|----------|:---:|:-----:| |
| 48 | +| Windows | ✅ | ➖ | |
| 49 | +| Linux | ✅ | ✅ | |
| 50 | +| Mac | ✅ | ✅ | |
| 51 | +| IOS | ➖ | ❌ | |
| 52 | +| TVOS | ➖ | ❌ | |
| 53 | +| VisionOS | ➖ | ❌ | |
| 54 | +| Android | ➖ | ❌ | |
| 55 | + |
| 56 | +Legend: ✅ Supported | ❌ Unsupported | ➖ Not applicable |
| 57 | + |
| 58 | + |
20 | 59 |
|
21 | 60 |
|
22 | 61 | ## Documentation |
23 | 62 |
|
24 | 63 | Documentation is available at https://portal.thirdweb.com/unreal |
| 64 | + |
| 65 | +[^1]: Unreal Engine's Marketplace Guidelines - Section 3.1.b https://www.unrealengine.com/en-US/marketplace-guidelines#31b |
| 66 | + |
| 67 | +[support-url]: https://thirdweb.com/support |
| 68 | +[documentation-url]: https://portal.thirdweb.com/unreal |
| 69 | +[marketplace-url]: https://www.unrealengine.com/marketplace/en-US/product/f21200c2610146f3888172994448e50d |
| 70 | +[web-browser-doc]: https://dev.epicgames.com/documentation/en-us/unreal-engine/API/Runtime/WebBrowser |
| 71 | +[cef-forum]: https://www.magpcss.org/ceforum/index.php |
| 72 | +[cef3-build-cs]: https://github.com/EpicGames/UnrealEngine/blob/release/Engine/Source/ThirdParty/CEF3/CEF3.build.cs#L102 |
0 commit comments