Skip to content

Commit 92861e6

Browse files
authored
Update README.md
1 parent 94c6684 commit 92861e6

File tree

1 file changed

+20
-3
lines changed

1 file changed

+20
-3
lines changed

README.md

Lines changed: 20 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -32,15 +32,21 @@ Note: The Newtonsoft DLL is included as part of the Unity Package, feel free to
3232

3333
# Build
3434

35+
## WebGL
3536
- Open your `Build settings`, select `WebGL` as the target platform.
3637
- Open `Player settings` > `Resolution and Presentation` and under `WebGLTemplate` choose `Thirdweb`.
3738
- Save and click `Build and Run` to test out your game in a browser.
3839

3940
If you're uploading your build, set `Compression Format` to `Disabled` in `Player Settings` > `Publishing Settings`.
4041

41-
Note that in order to communicate with the SDK, you need to `Build and run` your project so it runs in a browser context.
42+
Note that in order to communicate with the SDK on WebGL, you need to `Build and run` your project so it runs in a browser context.
4243

43-
#### _**Interacting with the SDK within the Unity Editor is NOT supported.**_
44+
## Other Platforms
45+
- Requires a ThirdwebManager prefab in your scene.
46+
- Use IL2CPP over Mono when possible in the Player Settings.
47+
- Use Smaller (faster) Builds in the Build Settings.
48+
- Using the SDK in the editor (pressing Play) is an accurate reflection of what you can expect to see on native platforms.
49+
- If using prefabs, use Prefab_ConnectWalletNative instead of Prefab_ConnectWallet.
4450

4551
# Usage
4652

@@ -86,7 +92,16 @@ All Prefabs require the [ThirdwebManager](https://github.com/thirdweb-dev/unity-
8692
[Connect Wallet](https://github.com/thirdweb-dev/unity-sdk/blob/main/Assets/Thirdweb/Examples/Scripts/Prefabs/Prefab_ConnectWallet.cs) - All-in-one drag & drop wallet supporting multiple wallet providers, network switching, balance displaying and more!
8793
- Drag and drop it into your scene and select the wallet providers you want to support from the Inspector.
8894
- You may also choose whether you want to activate the Network Switching feature (leave unchecked if your app only requires one network).
89-
- You can add callbacks from the inspector for when the wallet is connected, disconnected, or the ntwork is switched.
95+
- You can add callbacks from the inspector for when the wallet is connected, disconnected, fails to connect or disconnect.
96+
97+
[Connect Wallet Native](https://github.com/thirdweb-dev/unity-sdk/blob/main/Assets/Thirdweb/Examples/Scripts/Prefabs/Prefab_ConnectWalletNative.cs)
98+
- All-in-one drag & drop wallet supporting WalletConnect and Device Wallets (with or without passwords)
99+
- Drag and drop it into your scene and select the wallet options you want to provide (recommend using only one).
100+
- For device wallets, exporting will open the local encrypted keystore file on Standalone platforms (Application.persistentDataPath/account.json)
101+
- Opening a local file is not supported on iOS/Android 7+ so it also copies its contents to your clipboard.
102+
- You can import said keystore to Metamask or other wallet providers with the password needed to decrypt it.
103+
- When using DeviceWalletNoPassword, the password is your device UID.
104+
- You can add callbacks from the inspector for when the wallet is connected, disconnected, fails to connect or disconnect.
90105

91106
[NFT Loader](https://github.com/thirdweb-dev/unity-sdk/blob/main/Assets/Thirdweb/Examples/Scripts/Prefabs/Prefab_NFTLoader.cs) - Standalone drag & drop grid/scroll view of NFTs you ask it to display!
92107
- Go to the prefab's Settings in the Inspector.
@@ -118,12 +133,14 @@ nftPrefabScript.LoadNFT(nft);
118133
- Fetch ERC721 NFT(s).
119134
- Fetch ERC1155 NFT(s).
120135
- Fetch Marketplace Listing(s).
136+
- Fetch Pack contents.
121137

122138
[Writing](https://github.com/thirdweb-dev/unity-sdk/blob/main/Assets/Thirdweb/Examples/Scripts/Prefabs/Prefab_Writing.cs) - Writing to a contract!
123139
- Mint ERC20 Token(s).
124140
- Mint ERC721 NFT(s).
125141
- Mint ERC1155 NFT(s).
126142
- Buy Marketplace Listing(s).
143+
- Buy a Pack.
127144

128145
[Miscellaneous](https://github.com/thirdweb-dev/unity-sdk/blob/main/Assets/Thirdweb/Examples/Scripts/Prefabs/Prefab_Miscellaneous.cs) - More examples!
129146
- Get (Native) Balance.

0 commit comments

Comments
 (0)