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

[wip] Docs for Unity SDK V4.0.0 #464

Draft
wants to merge 42 commits into
base: main
Choose a base branch
from
Draft
Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
42 commits
Select commit Hold shift + click to select a range
56befbf
WebGL support set up automatically
timothymcmackin Nov 4, 2024
f5f72a5
wip
timothymcmackin Nov 4, 2024
fe5e344
WIP with working quickstart
timothymcmackin Nov 8, 2024
e7400b2
Some API reference work
timothymcmackin Nov 11, 2024
e92a754
Reorganize
timothymcmackin Nov 11, 2024
7158064
Conencting with WalletConnect
timothymcmackin Nov 11, 2024
9fec854
Complete disconnecting
timothymcmackin Nov 11, 2024
1e5500b
Why you want to sign messages
timothymcmackin Nov 11, 2024
ead0c6a
Calling contracts
timothymcmackin Nov 11, 2024
2f3f6e1
Constructing parameters
timothymcmackin Nov 12, 2024
b15ff07
WIP managing tokens
timothymcmackin Nov 12, 2024
9549367
API updates
timothymcmackin Nov 12, 2024
5b30af0
API method work
timothymcmackin Nov 13, 2024
6c34694
WalletProvider methods
timothymcmackin Nov 13, 2024
a332c50
Can't use painringrequested event on webgl
timothymcmackin Nov 13, 2024
b719fbb
Clarify connection methods
timothymcmackin Nov 13, 2024
c289e87
How to verify the signed payload
timothymcmackin Nov 13, 2024
7d77042
WalletConnect dependency
timothymcmackin Nov 14, 2024
586b478
Clarify what you can do
timothymcmackin Nov 15, 2024
064fd9e
Logging comment not needed
timothymcmackin Nov 15, 2024
1d615c9
Remove outdated methods
timothymcmackin Nov 15, 2024
5e33ecb
This is just a string
timothymcmackin Nov 15, 2024
f3cbf6f
GetTokens() method
timothymcmackin Nov 15, 2024
058ea09
Consistency
timothymcmackin Nov 15, 2024
38c5a50
Getting token information
timothymcmackin Nov 18, 2024
91aefdc
Calling a complex view
timothymcmackin Nov 18, 2024
eca7d52
Minting tokens
timothymcmackin Nov 19, 2024
dfa4ae3
Correct use of MichelineArray
timothymcmackin Nov 19, 2024
f8b9ec5
IPFS upload
timothymcmackin Nov 19, 2024
876f750
Changed to PinataApiToken
timothymcmackin Nov 19, 2024
c89f9ec
Update data provider reference
timothymcmackin Nov 21, 2024
e5b1f11
First attempt at EVM transactions
timothymcmackin Nov 21, 2024
ad124ed
Checking and distinguishing the wallet connection
timothymcmackin Nov 22, 2024
3d4decd
Testing and using social links
timothymcmackin Nov 22, 2024
b1c2672
Clarify that we support Etherlink
timothymcmackin Nov 25, 2024
1701773
Clarify
timothymcmackin Nov 25, 2024
cce7cee
Clarify calling contracts
timothymcmackin Nov 25, 2024
34f6030
This won't be a social operation
timothymcmackin Nov 25, 2024
b64f50b
Print transaction hash
timothymcmackin Nov 25, 2024
6bdac48
Netezos example of transferring FA tokens
timothymcmackin Nov 25, 2024
8b8ca4e
Using Reown SDK to call Etherlink
timothymcmackin Dec 4, 2024
10e5057
Etherlink context
timothymcmackin Dec 5, 2024
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