Skip to content

Commit d40b7e0

Browse files
authored
Update README.md
Signed-off-by: Firekeeper <0xFirekeeper@gmail.com>
1 parent e91b1d1 commit d40b7e0

File tree

1 file changed

+25
-28
lines changed

1 file changed

+25
-28
lines changed

README.md

Lines changed: 25 additions & 28 deletions
Original file line numberDiff line numberDiff line change
@@ -1,20 +1,7 @@
1-
<p align="center">
2-
<br />
3-
<a href="https://thirdweb.com">
4-
<img src="https://github.com/thirdweb-dev/js/blob/main/legacy_packages/sdk/logo.svg?raw=true" width="200" alt=""/>
5-
</a>
6-
<br />
7-
<h1 align="center">thirdweb Unity SDK</h1>
8-
<p align="center">
9-
<a href="https://discord.gg/thirdweb">
10-
<img alt="Join our Discord!" src="https://img.shields.io/discord/834227967404146718.svg?color=7289da&label=discord&logo=discord&style=flat"/>
11-
</a>
12-
<br />
13-
<a href="https://thirdweb-dev.github.io/unity-sdk/">
14-
<img alt="Preview" src="https://img.shields.io/badge/Preview-Unity%20WebGL-brightgreen?logo=unity&style=flat"/>
15-
</a>
16-
</p>
17-
</p>
1+
![Thirdweb Unity SDK](https://github.com/thirdweb-dev/unity-sdk/assets/43042585/0eb16b66-317b-462b-9eb1-9425c0929c96)
2+
3+
[<img alt="Discord" src="https://img.shields.io/discord/834227967404146718.svg?color=7289da&label=discord&logo=discord&style=for-the-badge" height="30">](https://discord.gg/thirdweb)
4+
[<img alt="Preview" src="https://img.shields.io/badge/Preview-Unity%20WebGL-brightgreen?logo=unity&style=for-the-badge" height="30">](https://thirdweb-dev.github.io/unity-sdk/)
185

196
# Documentation
207

@@ -26,13 +13,24 @@ Try out our multichain game that leverages Embedded and Smart Wallets to create
2613

2714
![image](https://github.com/thirdweb-dev/unity-sdk/assets/43042585/171198b2-83e7-4c8a-951b-79126dd47abb)
2815

29-
# Supported platforms
16+
# Supported Platforms & Wallets
17+
18+
**Build games for WebGL, Desktop and Mobile using 1000+ supported chains, with various login options!**
3019

31-
Build games for WebGL, Standalone and Mobile using 1000+ supported chains.
20+
| Wallet Provider | WebGL | Desktop | Mobile |
21+
| --------------------------------------------- | :-------: | :-------: | :-------: |
22+
| **In-App Wallet** (Email, Social, Phone) | ✔️ | ✔️ | ✔️ |
23+
| **Local Wallet** (Guest Mode) | ✔️ | ✔️ | ✔️ |
24+
| **Wallet Connect** | ✔️ | ✔️ | ✔️ |
25+
| **MetaMask** | ✔️ | ✔️ | ✔️ |
26+
| **Coinbase** | ✔️ |||
27+
| **Smart Wallet** (ERC4337) | ✔️ | ✔️ | ✔️ |
28+
| **Injected** | ✔️ |||
29+
| **HyperPlay** || ✔️ ||
3230

33-
![tw_wallets](https://github.com/thirdweb-dev/unity-sdk/assets/43042585/0c7f5ad1-263e-4cc8-9dfa-97a7f84bc471)
31+
<sub>✔️ Supported</sub> &nbsp; <sub>❌ Not Supported</sub> &nbsp; <sub>— Not Applicable</sub>
3432

35-
# Installation
33+
# Getting Started
3634

3735
Head over to the [releases](https://github.com/thirdweb-dev/unity-sdk/releases) page and download the latest `.unitypackage` file.
3836

@@ -44,12 +42,12 @@ Various blockchain interaction examples are available in our `Scene_Prefabs` sce
4442

4543
Payment related interaction examples are available in our `Scene_Pay` scene.
4644

47-
Notes:
48-
49-
- The SDK has been tested on Web, Desktop and Mobile platforms using Unity 2021 and 2022 LTS. We highly recommend using 2022 LTS.
45+
**Notes:**
46+
- The SDK has been tested on Web, Desktop and Mobile platforms using Unity 2021 and 2022 LTS. We **highly recommend** using 2022 LTS.
5047
- The example scenes are built using Unity 2022 LTS, it may look off in previous versions of Unity.
5148
- The Newtonsoft DLL is included as part of the Unity Package, feel free to deselect it if you already have it installed as a dependency to avoid conflicts.
5249
- If using .NET Framework and encountering an error related to HttpUtility, create a file `csc.rsp` that includes `-r:System.Web.dll` and save it under `Assets`.
50+
- If you have conflicting DLLs from other SDKs, in most cases our SDK will be compatible with previous versions, use version control and test removing duplicates.
5351

5452
# Usage
5553

@@ -90,9 +88,7 @@ var res = await contract.Read<string>("myReadFunction", arg1, arg2, ...);
9088
var txRes = await contract.Write("myWriteFunction", arg1, arg2, ...);
9189
```
9290

93-
94-
95-
# Build
91+
# Build Instructions
9692

9793
## General
9894

@@ -211,12 +207,13 @@ If you don't want to use Minimal Stripping, you could instead create a `link.xml
211207
- [Starter Template: Blockventure](https://github.com/thirdweb-example/blockventure)
212208
- [Example Template: Enhancing Unity IAP with Blockchain Interactions](https://blog.thirdweb.com/guides/enhancing-unity-iap-with-blockchain-interactions/)
213209
- [Example Template: Pioneer](https://github.com/thirdweb-example/pioneer)
210+
- [Separate, Standalone .NET SDK](https://github.com/thirdweb-dev/thirdweb-dotnet)
214211
215212
# Prefab Examples
216213

217214
![image](https://github.com/thirdweb-dev/unity-sdk/assets/43042585/a213b668-0273-400f-a6c1-92a582a35535)
218215
219-
The `Examples` folder contains a demo scene `Scene_Prefabs` using our user-friendly prefabs - they include script examples to get inspired and are entirely optional.
216+
The `Examples` folder contains a demo scene `Scene_Prefabs` using our user-friendly prefabs - they include script examples to get inspired and are entirely **optional**. You do not need to use any of them to recreate their functionality. We recommend creating your own UI once you are familiar with the SDK.
220217

221218
All Prefabs require the [ThirdwebManager](https://github.com/thirdweb-dev/unity-sdk/blob/main/Assets/Thirdweb/Core/Scripts/ThirdwebManager.cs) prefab to get the SDK Instance, drag and drop it into your scene and select the networks you want to support from the Inspector.
222219

0 commit comments

Comments
 (0)