com.careboo.unity-algorand-sdk v5.0.0

Unity Algorand SDK

!Caution This package has not been audited and isn't suitable for production use.

Algorand is a Pure Proof-of-Stake blockchain overseen by the Algorand Foundation. This Unity software package allows you to create and sign transactions, use Algorand's REST APIs, and connect to any Algorand wallet supporting WalletConnect.

Supported Targets

Installation

This SDK is provided as a UPM package in the following locations:

• Open UPM
• NPM Registry

Open UPM

The easiest way to install is to use Open UPM as it manages your scopes automatically. You can install Open UPM here. Then use the Open UPM CLI at the root of your Unity project to install.

> cd <your unity project>
> openupm add com.careboo.unity-algorand-sdk

Manually Adding UPM Scopes

If you don't want to use Open UPM, it's straightforward to manually add the UPM registry scopes required for this package.

1. In the Unity Editor, click on Edit -> Project Settings -> Package Manager.
2. Under the Scoped Registries tab, click the + button to add a new Scoped Registry.
3. Set the following values for the Scoped Registry:

Name: Open UPM
URL: https://package.openupm.com
Scopes:
  - com.cysharp.unitask
  - com.careboo.unity-algorand-sdk

4. Click on Window -> Package Manager, and the Algorand SDK package should appear in the Packages: My Registries tab.
5. Install the latest version of the Algorand SDK.

For more details, see Unity's official documentation on Scoped Registries.

Unity Asset Store

This SDK will soon be available in the Unity Asset Store.

Getting Started

Documentation

The Quickstart Guide is the best place to start. You can view the documentation website for a specific version or branch at

https://careboo.github.io/unity-algorand-sdk/{version}/

e.g. https://careboo.github.io/unity-algorand-sdk/main/.

Demo

There's a Demo game you can try out in the demo branch.