Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Docs for Unity SDK V4.0.0 #464

Merged
merged 46 commits into from
Jan 23, 2025
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
46 commits
Select commit Hold shift + click to select a range
f8290b0
WebGL support set up automatically
timothymcmackin Nov 4, 2024
d8288b3
wip
timothymcmackin Nov 4, 2024
f6c645b
WIP with working quickstart
timothymcmackin Nov 8, 2024
82e2bcc
Some API reference work
timothymcmackin Nov 11, 2024
2c62083
Reorganize
timothymcmackin Nov 11, 2024
68b95d4
Conencting with WalletConnect
timothymcmackin Nov 11, 2024
a4f7fd6
Complete disconnecting
timothymcmackin Nov 11, 2024
5d451ed
Why you want to sign messages
timothymcmackin Nov 11, 2024
4876026
Calling contracts
timothymcmackin Nov 11, 2024
33169ea
Constructing parameters
timothymcmackin Nov 12, 2024
8c02fee
WIP managing tokens
timothymcmackin Nov 12, 2024
98d1173
API updates
timothymcmackin Nov 12, 2024
55ac4c8
API method work
timothymcmackin Nov 13, 2024
38a4b97
WalletProvider methods
timothymcmackin Nov 13, 2024
ff0fad9
Can't use painringrequested event on webgl
timothymcmackin Nov 13, 2024
af5e38c
Clarify connection methods
timothymcmackin Nov 13, 2024
ed359de
How to verify the signed payload
timothymcmackin Nov 13, 2024
d288cad
WalletConnect dependency
timothymcmackin Nov 14, 2024
b86a8dc
Clarify what you can do
timothymcmackin Nov 15, 2024
a486b6b
Logging comment not needed
timothymcmackin Nov 15, 2024
c86f3b2
Remove outdated methods
timothymcmackin Nov 15, 2024
bdbe1e2
This is just a string
timothymcmackin Nov 15, 2024
fca1e96
GetTokens() method
timothymcmackin Nov 15, 2024
40efb51
Consistency
timothymcmackin Nov 15, 2024
3f6782b
Getting token information
timothymcmackin Nov 18, 2024
f9f4f22
Calling a complex view
timothymcmackin Nov 18, 2024
2770724
Minting tokens
timothymcmackin Nov 19, 2024
3966ba9
Correct use of MichelineArray
timothymcmackin Nov 19, 2024
c039b70
IPFS upload
timothymcmackin Nov 19, 2024
7a8b917
Changed to PinataApiToken
timothymcmackin Nov 19, 2024
db162ad
Update data provider reference
timothymcmackin Nov 21, 2024
5113996
First attempt at EVM transactions
timothymcmackin Nov 21, 2024
ba3e1b0
Checking and distinguishing the wallet connection
timothymcmackin Nov 22, 2024
7bca474
Testing and using social links
timothymcmackin Nov 22, 2024
93c1b3b
Clarify that we support Etherlink
timothymcmackin Nov 25, 2024
6d39b1a
Clarify
timothymcmackin Nov 25, 2024
e18052d
Clarify calling contracts
timothymcmackin Nov 25, 2024
ed6562d
This won't be a social operation
timothymcmackin Nov 25, 2024
4ee3437
Print transaction hash
timothymcmackin Nov 25, 2024
4fe9910
Netezos example of transferring FA tokens
timothymcmackin Nov 25, 2024
44bd8d0
Using Reown SDK to call Etherlink
timothymcmackin Dec 4, 2024
4c02cc9
Etherlink context
timothymcmackin Dec 5, 2024
cf878c4
Better info about Etherlink
timothymcmackin Jan 7, 2025
6ede6a1
Calling views
timothymcmackin Jan 7, 2025
f10debe
Remove unused image
timothymcmackin Jan 7, 2025
626cfa7
Etherlink events do not trigger the OperationResulted event
timothymcmackin Jan 8, 2025
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
32 changes: 24 additions & 8 deletions docs/unity.md
Original file line number Diff line number Diff line change
Expand Up @@ -2,26 +2,38 @@
title: Tezos Unity SDK
authors: Tim McMackin
last_update:
date: 11 January 2024
date: 25 November 2024
---

The Tezos Unity SDK provides tools that let you access user wallets and Tezos in games and other Unity projects.
You can use Tezos via the SDK to:
The Tezos Unity SDK provides tools that let you access user wallets and blockchains in games and other Unity projects.
You can use the SDK to:

- Use a player's Tezos account as their account for a game and their wallet as their way of logging in to the game
- Accept payments from players in tez
- Use Tezos to create game assets, store player inventories, and transfer assets between players
- Verify that users own specific game assets and allow them to sell or share them to other players
- Use Tezos smart contracts as backend logic for games
- Use a player's account as their account for a game and their wallet as their way of logging in to the game
- Accept payments from players in tez (XTZ), the primary cryptocurrency of the Tezos and Etherlink blockchains
- Use blockchains to create game assets, store player inventories, and transfer assets between players
- Verify that users own specific game assets and allow them to transfer them to other players
- Use smart contracts as backend logic for games

The SDK can connect to and use these blockchains:

- [Tezos](https://tezos.com)
- [Etherlink](https://etherlink.com)

## Installation and use

For a walkthrough of installing and using the SDK in an existing Unity project, see [Quickstart](/unity/quickstart).

## Upgrading from version 3

Version 4.0 has breaking changes.
To upgrade, see [Upgrading the Unity SDK](/unity/upgrading).

<!--
## Tutorial scenes

The SDK includes tutorial scenes that demonstrate how to use the SDK.
For information about setting up and using the scenes, see [Tutorial scenes](/unity/scenes).
-->

## Sample game

Expand All @@ -38,9 +50,13 @@ The Tezos SDK uses modified versions of the following libraries for communicatio

- **Airgap Beacon SDK**: Interacts with Tezos wallets through the Beacon standard for iOS, Android, and WebGL platforms.
- **Netezos**: Interacts with Tezos wallets through the Beacon standard for Windows, Linux, and MacOS platforms. Also prepares parameters for smart contract calls and interprets complex data returned by the ReadView method.
- **WalletConnect**: Interacts with EVM wallets with the WalletConnect protocol.
To use WalletConnect wallets, you must install the [Tezos WalletConnect Unity SDK](https://github.com/trilitech/tezos-wallet-connect-unity-sdk).

The SDK also uses the [Newtonsoft JSON Unity Package](https://docs.unity3d.com/Packages/[email protected]/manual/index.html).

## Supported Platforms

The SDK supports Windows, Linux, MacOS, iOS, Android, and WebGL platforms.

For information about the kinds of wallets the SDK supports, see [Connecting accounts](/unity/connecting-accounts).
Loading
Loading