@@ -72,11 +72,11 @@ The Beacon SDK detects that it is running in a web application and opens a popup
Social wallets exist as accounts managed by web apps such as [Kukai](https://kukai.app/).
-To connect to a social wallet, the Unity WebGL application calls [`Wallet.Connect()`](./reference/Wallet#connect) with the `walletProvider` parameter set to `WalletProviderType.kukai`.
+To connect to a social wallet, the Unity WebGL application calls [`Wallet.Connect()`](/unity/reference/Wallet#connect) with the `walletProvider` parameter set to `WalletProviderType.kukai`.
## Disconnecting
It's important to provide a disconnect button so the user can disconnect when they are finished with the application or if they want to connect with a different account.
-To disconnect the active wallet, call the [`Wallet.Disconnect()`](./reference/Wallet#disconnect) method.
+To disconnect the active wallet, call the [`Wallet.Disconnect()`](/unity/reference/Wallet#disconnect) method.
diff --git a/docs/unity/managing-contracts.md b/docs/unity/managing-contracts.md
index 0c9904512..81e7d912a 100644
--- a/docs/unity/managing-contracts.md
+++ b/docs/unity/managing-contracts.md
@@ -11,7 +11,7 @@ Smart contracts can do many tasks, but for gaming they have two main purposes:
- They handle tokens, which are digital assets stored on the blockchain
- They provide backend logic that users can trust because it cannot change
-For more information about contracts, see [Smart contracts](../smart-contracts).
+For more information about contracts, see [Smart contracts](/smart-contracts).
You can create your own smart contracts or use the built-in contract that the SDK provides for managing tokens in Unity projects.
@@ -22,15 +22,15 @@ The Contract tutorial scene shows how to deploy a copy of the built-in contract
The SDK includes a built-in contract that you can use to manage tokens for your Unity projects.
The contract has entrypoints that allow you to create and transfer tokens.
-See [Managing tokens](./managing-tokens).
+See [Managing tokens](/unity/managing-tokens).
The Michelson source code of the built-in contract is in the `Resources/Contracts` folder of the SDK, but it isn't very human-readable.
-For a list of the entrypoints in the contract, see [TokenContract object](./reference/TokenContract).
+For a list of the entrypoints in the contract, see [TokenContract object](/unity/reference/TokenContract).
For an example of a deployed contract, see https://ghostnet.tzkt.io/KT1Nhr9Bmhy7kcUmezRxbbDybh5buNnrVLTY/entrypoints.
## Deploying the built-in contract
-To deploy the built-in contract, call the [`TokenContract.Deploy()`](./reference/TokenContract#deploy) method and pass a callback function:
+To deploy the built-in contract, call the [`TokenContract.Deploy()`](/unity/reference/TokenContract#deploy) method and pass a callback function:
```csharp
public void DeployContract()
@@ -54,28 +54,28 @@ It can take a few minutes for the contract to deploy and be confirmed in multipl
The address that deployed the contract becomes the administrator of the contract and is the only account that can create tokens.
-The SDK provides information about the contract such as its address in the [`TokenContract`](./reference/TokenContract) object.
+The SDK provides information about the contract such as its address in the [`TokenContract`](/unity/reference/TokenContract) object.
You can use block explorers such as [Better Call Dev](https://better-call.dev/) to see information about the deployed contract.
-For information about using the built-in contract, see [Managing tokens](./managing-tokens).
+For information about using the built-in contract, see [Managing tokens](/unity/managing-tokens).
## Getting the contract address
-When you deploy a contract with the [`TokenContract.Deploy()`](./reference/TokenContract#deploy) method, the SDK saves the contract address by running this code:
+When you deploy a contract with the [`TokenContract.Deploy()`](/unity/reference/TokenContract#deploy) method, the SDK saves the contract address by running this code:
```csharp
PlayerPrefs.SetString("CurrentContract:" + Tezos.Wallet.GetActiveAddress(), contractAddress);
```
-Then during SDK initialization, the SDK saves the address to the [`TokenContract.Address`](./reference/TokenContract) property.
+Then during SDK initialization, the SDK saves the address to the [`TokenContract.Address`](/unity/reference/TokenContract) property.
-To retrieve the address of contracts that you haven't deployed through the project, you can use the [`API.GetOriginatedContractsForOwner()`](./reference/API#getoriginatedcontractsforowner) method.
+To retrieve the address of contracts that you haven't deployed through the project, you can use the [`API.GetOriginatedContractsForOwner()`](/unity/reference/API#getoriginatedcontractsforowner) method.
## Calling contracts
-The built-in contract has convenience methods for minting and transferring tokens; see [Managing tokens](./managing-tokens).
+The built-in contract has convenience methods for minting and transferring tokens; see [Managing tokens](/unity/managing-tokens).
-To call the contract's other entrypoints, use the [`Wallet.CallContract()`](./reference/Wallet#callcontract) method.
+To call the contract's other entrypoints, use the [`Wallet.CallContract()`](/unity/reference/Wallet#callcontract) method.
For example, to call the contract's `set_administrator` entrypoint to set a new administrator account, use this code:
```csharp
@@ -86,7 +86,7 @@ TezosManager.Instance.Tezos.Wallet.CallContract(
);
```
-For information about the entrypoints in the built-in contract, see [Unity SDK TokenContract object](./reference/TokenContract#entrypoints).
+For information about the entrypoints in the built-in contract, see [Unity SDK TokenContract object](/unity/reference/TokenContract#entrypoints).
You can call any other contract by using its address, entrypoint name, and parameter value, as in this example:
@@ -185,7 +185,7 @@ This is the Michelson parameter type for the endpoint:
```
In this case, you set the "add_operator" value by passing a `PrimType.Left` Michelson primitive or the "remove_operator" value by passing a `PrimType.Right` primitive.
-The values in the primitive are a series of nested pairs called a [right comb](../smart-contracts/data-types/complex-data-types#right-combs), as in this example:
+The values in the primitive are a series of nested pairs called a [right comb](/smart-contracts/data-types/complex-data-types#right-combs), as in this example:
```json
{
@@ -285,7 +285,7 @@ Then, ensure that the code of the code and initial storage value of the contract
}
```
-To deploy the contract from the Unity project, use the [`Wallet.OriginateContract()`](./reference/Wallet#originatecontract) method, as in this example:
+To deploy the contract from the Unity project, use the [`Wallet.OriginateContract()`](/unity/reference/Wallet#originatecontract) method, as in this example:
```csharp
var contractJSON = Resources.Load
Then, drag this instance of the TezosConfigSO scriptable object to the Config field of the TezosManager prefab.
-For more examples of how to work with the SDK, see [Tutorial scenes](./scenes).
+For more examples of how to work with the SDK, see [Tutorial scenes](/unity/scenes).
diff --git a/docs/unity/reference.md b/docs/unity/reference.md
index 04d78be37..f2a0cf744 100644
--- a/docs/unity/reference.md
+++ b/docs/unity/reference.md
@@ -9,12 +9,12 @@ last_update:
The Tezos Unity SDK provides several objects that your Unity project can use to work with Tezos.
These pages provide reference for the most important of these objects:
-- [API object](./reference/API): Provides information about the Tezos blockchain, such as what tokens accounts or contracts control
-- [DAppMetadata object](./reference/DAppMetadata): Provides read-only properties that describe the project
-- [DataProviderConfigSO scriptable object](./reference/DataProviderConfigSO): Sets the indexer to get information about Tezos from
-- [EventManager object](./reference/EventManager): Provides events that you can add listeners to, such as when users connect their wallets
-- [TezosConfigSO scriptable object](./reference/TezosConfigSO): Stores information about connecting to Tezos, including the RPC node and Pinata API key to use
-- [TokenContract object](./reference/TokenContract): Provides a built-in FA2-compatible smart contract and convenience methods to work with it
-- [Wallet object](./reference/Wallet): Provides methods to connect to wallets and send transactions from the connected account
+- [API object](/unity/reference/API): Provides information about the Tezos blockchain, such as what tokens accounts or contracts control
+- [DAppMetadata object](/unity/reference/DAppMetadata): Provides read-only properties that describe the project
+- [DataProviderConfigSO scriptable object](/unity/reference/DataProviderConfigSO): Sets the indexer to get information about Tezos from
+- [EventManager object](/unity/reference/EventManager): Provides events that you can add listeners to, such as when users connect their wallets
+- [TezosConfigSO scriptable object](/unity/reference/TezosConfigSO): Stores information about connecting to Tezos, including the RPC node and Pinata API key to use
+- [TokenContract object](/unity/reference/TokenContract): Provides a built-in FA2-compatible smart contract and convenience methods to work with it
+- [Wallet object](/unity/reference/Wallet): Provides methods to connect to wallets and send transactions from the connected account
-The SDK also provides Unity prefabs that are prerequisites for the SDK; see [Prefabs](./prefabs).
+The SDK also provides Unity prefabs that are prerequisites for the SDK; see [Prefabs](/unity/prefabs).
diff --git a/docs/unity/reference/API.md b/docs/unity/reference/API.md
index 4279c61e3..0b6c325a9 100644
--- a/docs/unity/reference/API.md
+++ b/docs/unity/reference/API.md
@@ -51,7 +51,7 @@ IEnumerator ReadView(
Action
@@ -20,4 +20,4 @@ To use this object, create an instance of it, put your information in its fields
- `Request Timeout Seconds`: The time in seconds to wait for a response from the indexer
- `Documentation Url`: A link to the API reference for the indexer
-For more information about indexers, see [Indexers](../../developing/information/indexers).
+For more information about indexers, see [Indexers](/developing/information/indexers).
diff --git a/docs/unity/reference/TezosConfigSO.md b/docs/unity/reference/TezosConfigSO.md
index e60d3db91..f011e7264 100644
--- a/docs/unity/reference/TezosConfigSO.md
+++ b/docs/unity/reference/TezosConfigSO.md
@@ -18,6 +18,6 @@ To use this object, create an instance of it, put your information in its fields
- `RPC Url Format`: The URL of the RPC node to use; this value replaces the variable `{network}` with the value of the `Network` field
- `Request Timeout Seconds`: The time in seconds to wait for a response from the indexer
- `Pinata Api Key`: The Pinata JWT (not the API key or secret key) to use to upload files and data to IPFS
-- `Data Provider Config`: The instance of the [DataProviderConfig](./DataProviderConfigSO) scriptable object to use
+- `Data Provider Config`: The instance of the [DataProviderConfig](/unity/reference/DataProviderConfigSO) scriptable object to use
-For more information about RPC nodes, see [The RPC interface](../../architecture/rpc).
+For more information about RPC nodes, see [The RPC interface](/architecture/rpc).
diff --git a/docs/unity/reference/TokenContract.md b/docs/unity/reference/TokenContract.md
index 669a0eb47..3a3a84046 100644
--- a/docs/unity/reference/TokenContract.md
+++ b/docs/unity/reference/TokenContract.md
@@ -8,7 +8,7 @@ last_update:
The Unity SDK class `TezosSDK.Tezos.API.Models.TokenContract`, which is available at runtime as the `TezosManager.Instance.Tezos.TokenContract` object, provides a built-in FA2-compatible smart contract and convenience methods to work with it.
-For information about FA2 contracts and tokens, see [FA2 tokens](../../architecture/tokens/FA2).
+For information about FA2 contracts and tokens, see [FA2 tokens](/architecture/tokens/FA2).
The Michelson source code of the built-in contract is in the `Resources/Contracts` folder of the SDK.
@@ -35,11 +35,11 @@ For a simpler way to create tokens, see the [`Mint()`](#mint) method.
- `balance_of`: Sends information about an owner's token balance to another contract.
Its parameters are a callback contract that accepts a list of token IDs and the amount that the specified account owns.
-For a simpler way to get information about token ownership, see the [`API.GetTokensForOwner()`](./API#gettokensforowner) method.
+For a simpler way to get information about token ownership, see the [`API.GetTokensForOwner()`](/unity/reference/API#gettokensforowner) method.
- `update_operators`: Adds or removes operators for the specified token owners and token IDs.
Its parameters are a list of commands to add or remove operators for token owners and IDs.
-For information about operators, see [Operators](../../architecture/tokens/FA2#operators).
+For information about operators, see [Operators](/architecture/tokens/FA2#operators).
- `set_administrator`: Changes the account that can mint tokens.
Its parameter is the address of the new administrator account.
@@ -47,14 +47,14 @@ This entrypoint can be called only by the current administrator account.
- `set_metadata`: Creates or changes a metadata field in the specified contract's storage.
Its parameters are a key-value pair for the new or updated metadata value.
-This metadata is a value in the contract's storage, which is different from the metadata returned by the [`API.GetContractMetadata()`](./API#getcontractmetadata) method.
+This metadata is a value in the contract's storage, which is different from the metadata returned by the [`API.GetContractMetadata()`](/unity/reference/API#getcontractmetadata) method.
This entrypoint can be called only by the current administrator account.
- `set_pause`: Sets the value of the `paused` storage field.
When this field is set to true, tokens can be minted but not transferred between accounts.
This entrypoint can be called only by the current administrator account.
-For examples of calling these entrypoints, see [Calling the built-in contract](../managing-contracts#calling-contracts).
+For examples of calling these entrypoints, see [Calling the built-in contract](/unity/managing-contracts#calling-contracts).
### Constructors
diff --git a/docs/unity/reference/Wallet.md b/docs/unity/reference/Wallet.md
index 7a9c8c8d1..59b62c70b 100644
--- a/docs/unity/reference/Wallet.md
+++ b/docs/unity/reference/Wallet.md
@@ -138,7 +138,7 @@ To use this method, you must compile a contract to Michelson in a JSON file.
For an example, see the code of the built-in contract in `Resources/Contracts`.
The optional `delegateAddress` parameter is the address of the account to delegate the contract's tez to.
-For more information, see [Delegation](../../smart-contracts/delegation).
+For more information, see [Delegation](/smart-contracts/delegation).
This method triggers the `ContractCallInjected` event if the call is successfully sent to Tezos.
Then it triggers `ContractCallCompleted` or `ContractCallFailed` events, depending on whether the origination operation succeeded or failed.
diff --git a/docs/unity/sample-game.md b/docs/unity/sample-game.md
index 376f08af7..64ff6efe6 100644
--- a/docs/unity/sample-game.md
+++ b/docs/unity/sample-game.md
@@ -28,7 +28,7 @@ The sample game uses these main components:
- **User wallets** as a source of user identity and authentication.
The user doesn't make any direct transactions from the wallet and pays no tez to the application or in fees.
-For more information about Tezos wallets, see [Installing and funding a wallet](../developing/wallet-setup).
+For more information about Tezos wallets, see [Installing and funding a wallet](/developing/wallet-setup).
- The **Unity WebGL application** is the front end of the application.
It connects to the user wallet, sends the sign request, runs the game interface, and sends requests to the backend.
@@ -51,7 +51,7 @@ The Unity application calls it from the `Assets/Scripts/Api/GameApi.cs` file for
- The **smart contract** is a program that runs on the Tezos blockchain to manage tokens that represent in-game items.
It maintains a ledger of tokens and owners and allows the backend's administrator account to transfer them to players.
-The sample game uses a custom contract, but you can use the SDK's built-in FA2-compliant contract; see [Managing contracts](./managing-contracts).
+The sample game uses a custom contract, but you can use the SDK's built-in FA2-compliant contract; see [Managing contracts](/unity/managing-contracts).
You can view and interact with the contract on a block explorer, such as tzkt.io: https://tzkt.io/KT1TSZfPJ5uZW1GjcnXmvt1npAQ2nh5S1FAj/operations.
- The **Interplanetary File System (IPFS)** stores metadata for the tokens, including pictures and descriptions.
@@ -65,7 +65,7 @@ This diagram shows the basic interaction between these components:
The game uses the user's Tezos account as a source of authentication.
It prompts the user to connect their Tezos wallet so it can retrieve the user's account address.
-For more information about connecting to user wallets, see [Connecting accounts](./connecting-accounts).
+For more information about connecting to user wallets, see [Connecting accounts](/unity/connecting-accounts).
When the wallet is connected, the game prompts the user to sign a payload to prove that they have the key for the account.
The process follows these general steps:
@@ -83,12 +83,12 @@ Here is a diagram of the process:
-For more information about signing messages, see [Signing messages](./quickstart#signing-messages) in the Unity SDK quickstart.
+For more information about signing messages, see [Signing messages](/unity/quickstart#signing-messages) in the Unity SDK quickstart.
## Tokens
The game uses Tezos tokens to represent in-game items, such as weapons, armor, and power-ups.
-Because these tokens are compliant with the [FA2](../architecture/tokens/FA2) standard, players can see their tokens in their wallets and in applications such as block explorers.
+Because these tokens are compliant with the [FA2](/architecture/tokens/FA2) standard, players can see their tokens in their wallets and in applications such as block explorers.
They could also set up a third-party platform to show and trade their tokens.
The smart contract that manages the tokens has one [token type](https://better-call.dev/mainnet/KT1TSZfPJ5uZW1GjcnXmvt1npAQ2nh5S1FAj/tokens) for each in-game item.
@@ -128,7 +128,7 @@ The [`UserDataManager.cs`](https://github.com/baking-bad/tezos-unity-game/blob/m
Some of this information (such as the tokens that the player owns) comes from Tezos and other information (such as the player's statistics) comes from the backend.
Information about the current game session and pending rewards are non-persistent data that are stored by the Unity application.
-The `UserDataManager` class responds to [events](./reference/EventManager) such as when the user connects their wallet and then loads information from the backend and from Tezos directly.
+The `UserDataManager` class responds to [events](/unity/reference/EventManager) such as when the user connects their wallet and then loads information from the backend and from Tezos directly.
## Opening the sample game
diff --git a/docs/unity/scenes.md b/docs/unity/scenes.md
index 92baeed59..8fead719f 100644
--- a/docs/unity/scenes.md
+++ b/docs/unity/scenes.md
@@ -9,11 +9,11 @@ last_update:
The SDK includes tutorial scenes that demonstrate how to use the SDK.
Before using any of the scenes, install a Tezos-compatible wallet on a mobile device and get some test tez tokens that you can use to pay transaction fees.
-For instructions, see [Installing and funding a wallet](../developing/wallet-setup).
+For instructions, see [Installing and funding a wallet](/developing/wallet-setup).
## Setup instructions
-After you have installed the SDK according to the instructions in the [Quickstart](./quickstart), you can import the tutorial scenes from the Package Manager panel:
+After you have installed the SDK according to the instructions in the [Quickstart](/unity/quickstart), you can import the tutorial scenes from the Package Manager panel:
1. In the Package Manager panel, click the Tezos Unity SDK package.
@@ -97,7 +97,7 @@ This picture of the Wallet Connection scene in WebGL mode shows the deep link an
-These UI elements call the [`Wallet.Connect()`](./reference/Wallet#connect) method with the `walletProvider` parameter set to `WalletProviderType.beacon` for the direct links or QR code connections and the `walletProvider` parameter set to `WalletProviderType.kukai` for the social wallet connections.
+These UI elements call the [`Wallet.Connect()`](/unity/reference/Wallet#connect) method with the `walletProvider` parameter set to `WalletProviderType.beacon` for the direct links or QR code connections and the `walletProvider` parameter set to `WalletProviderType.kukai` for the social wallet connections.
After the user approves the connection in the wallet, the scene shows the address of the connected account and its balance, as in the following picture.
At the bottom of the scene there is a logout button that closes the connection.
@@ -115,7 +115,7 @@ In this case, the smart contract keeps track of tokens, their metadata, and who
The SDK comes with a sample smart contract that allows a Unity project to create tokens.
You can customize these tokens, give them to users, and treat them like the players' in-game inventories.
The Michelson source code of the built-in contract is in the `Resources/Contracts` folder of the SDK, but it isn't very human-readable.
-For a list of the entrypoints in the contract, see [TokenContract object](./reference/TokenContract).
+For a list of the entrypoints in the contract, see [TokenContract object](/unity/reference/TokenContract).
For an example of a deployed contract, see https://ghostnet.tzkt.io/KT1Nhr9Bmhy7kcUmezRxbbDybh5buNnrVLTY/entrypoints.
Like the Wallet Connection scene, you must first connect to a wallet.
@@ -125,7 +125,7 @@ When you click "Deploy Contract," your connected wallet prompts you to confirm t
Because you are connected to the test network, these are worthless testnet tokens and not real currency.
This process can take some time.
-The scene calls the [`TokenContract.Deploy()`](./reference/TokenContract#deploy) method to deploy the contract to Tezos.
+The scene calls the [`TokenContract.Deploy()`](/unity/reference/TokenContract#deploy) method to deploy the contract to Tezos.
When you confirm the transaction in the wallet app, you must wait for the contract to be deployed on Tezos.
The log in the Console panel shows a message that looks like `Received operation with hash oopFjLYGTbZTEFsTh4p1YPnHR1Up1SNnvE5xk2SRaGH6PZ4ry56`, which is the address of the Tezos transaction that deployed the contract.
@@ -159,7 +159,7 @@ Because the contract follows the FA2 standard for tokens, the block explorer als
The tokens that this scene creates have randomly generated metadata.
To change the metadata, open the `TezosSDK/Examples/Contract/Scripts/MintToken.cs` file.
-The file's `HandleMint` function creates the token by generating random numbers, creating a metadata object for the token, and using the [`TokenContract.Mint()`](./reference/TokenContract#mint) method to send the mint transaction to the contract:
+The file's `HandleMint` function creates the token by generating random numbers, creating a metadata object for the token, and using the [`TokenContract.Mint()`](/unity/reference/TokenContract#mint) method to send the mint transaction to the contract:
```csharp
public void HandleMint()
@@ -173,7 +173,7 @@ public void HandleMint()
```
In your projects, you can set the metadata to store information about what the token represents.
-For more information about working with Tokens, see [Managing tokens](./managing-tokens) and the tutorials [Create an NFT](../tutorials/create-an-nft) and [Build an NFT marketplace](../../tutorials/build-an-nft-marketplace).
+For more information about working with Tokens, see [Managing tokens](/unity/managing-tokens) and the tutorials [Create an NFT](/tutorials/create-an-nft) and [Build an NFT marketplace](/tutorials/build-an-nft-marketplace).
## Transfer scene
@@ -196,7 +196,7 @@ For example, this entry shows that the account that ends in `2zD` owns 9 of the
-The transfer tutorial scene uses the [`TokenContract.Transfer()`](./reference/TokenContract#transfer) method to transfer the token:
+The transfer tutorial scene uses the [`TokenContract.Transfer()`](/unity/reference/TokenContract#transfer) method to transfer the token:
```csharp
public void HandleTransfer()