Skip to content

Commit

Permalink
chore(docs): update README with more installation information
Browse files Browse the repository at this point in the history
  • Loading branch information
jasonboukheir committed Oct 13, 2023
1 parent e28e906 commit b23cbb4
Show file tree
Hide file tree
Showing 5 changed files with 648 additions and 604 deletions.
Original file line number Diff line number Diff line change
Expand Up @@ -185,9 +185,10 @@ <h2 id="table-of-contents">Table of Contents</h2>
</ul>
</li>
<li><a href="#installation">Installation</a><ul>
<li><a href="#unity-asset-store">Unity Asset Store</a></li>
<li><a href="#asset-package">Asset Package</a></li>
<li><a href="#open-upm">Open UPM</a></li>
<li><a href="#manually-adding-upm-scopes">Manually Adding UPM Scopes</a></li>
<li><a href="#unity-asset-store">Unity Asset Store</a></li>
</ul>
</li>
<li><a href="#getting-started">Getting Started</a><ul>
Expand Down Expand Up @@ -255,18 +256,37 @@ <h3 id="make-a-payment-transaction">Make a payment transaction:</h3>
</code></pre><h4 id="send-the-signed-transaction">Send the signed transaction:</h4>
<pre><code class="lang-csharp">await algod.SendTransaction(signedTxn);
</code></pre><h2 id="installation">Installation</h2>
<h3 id="unity-asset-store">Unity Asset Store</h3>
<p><a href="https://u3d.as/31Er">Algorand SDK for Unity</a> is now available!</p>
<h3 id="asset-package">Asset Package</h3>
<p>Each release contains a <code>.unitypackage</code> package file that can be installed into a project.</p>
<ol>
<li><a href="https://github.com/CareBoo/unity-algorand-sdk/releases/latest">Download the latest release.</a></li>
<li><a href="https://docs.unity3d.com/Manual/AssetPackagesImport.html">Import the <code>.unitypackage</code> file into your project.</a></li>
</ol>
<h3 id="open-upm">Open UPM</h3>
<p>The easiest way to install is to use Open UPM as it manages your scopes automatically.
<p>The easiest way to install as a package is to use Open UPM as it manages your scopes automatically.
You can <a href="https://openupm.com/docs/getting-started.html">install Open UPM here</a>.
Then use the Open UPM CLI at the root of your Unity project to install.</p>
<pre><code class="lang-sh">&gt; cd &lt;your unity project&gt;
&gt; openupm add com.careboo.unity-algorand-sdk
</code></pre><h3 id="manually-adding-upm-scopes">Manually Adding UPM Scopes</h3>
<p>If you don&#39;t want to use Open UPM, it&#39;s straightforward to manually add the UPM registry scopes
required for this package. See <a href="https://docs.unity3d.com/Manual/upm-scoped.html">Unity&#39;s official documentation on Scoped Registries</a>.</p>
<h3 id="unity-asset-store">Unity Asset Store</h3>
<p><a href="https://u3d.as/31Er">Algorand SDK for Unity</a> is now available!</p>
<h2 id="getting-started">Getting Started</h2>
required for this package. See <a href="https://docs.unity3d.com/Manual/upm-scoped.html">Unity&#39;s official documentation on Scoped Registries</a>.
Modify your scopes to include the following:</p>
<pre><code class="lang-json">{
&quot;scopedRegistries&quot;: [
{
&quot;name&quot;: &quot;package.openupm.com&quot;,
&quot;url&quot;: &quot;https://package.openupm.com&quot;,
&quot;scopes&quot;: [
&quot;com.careboo.unity-algorand-sdk&quot;,
&quot;com.cysharp.unitask&quot;
]
}
]
}
</code></pre><h2 id="getting-started">Getting Started</h2>
<p>Read <a href="manual/getting_started.html">Getting Started</a> to learn the basic workflows for developing on Algorand.</p>
<h3 id="documentation-site">Documentation Site</h3>
<p>Docs for this version were generated at <a href="https://careboo.github.io/unity-algorand-sdk/5.0">https://careboo.github.io/unity-algorand-sdk/5.0</a>.</p>
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -2912,7 +2912,7 @@
"index.html": {
"href": "index.html",
"title": "Algorand SDK for Unity | Algorand SDK for Unity",
"keywords": "Algorand SDK for Unity Integrate your game with Algorand , a Pure Proof-of-Stake blockchain overseen by the Algorand Foundation. Create Algorand transactions, Algorand accounts, and use Algorand's REST APIs . Table of Contents Table of Contents Requirements Common Usages Make a payment transaction Sign the transaction with an account Sign the transaction with kmd Send the signed transaction Installation Open UPM Manually Adding UPM Scopes Unity Asset Store Getting Started Documentation Site Samples Requirements This package supports the following build targets and Unity versions: Unity Version Windows Mac OS Linux Android iOS WebGL 2021.3 ✅ ✅ ✅ ✅ ✅ ✅ 2022.3 ✅ ✅ ✅ ✅ ✅ ✅ ✅ All APIs are supported. ❌ Not supported. Use at your own risk. Common Usages Make a payment transaction: using Algorand.Unity; var sender = \"<your sender address>\"; var receiver = \"<your receiver address>\"; var algod = new AlgodClient(\"https://testnet-api.algonode.cloud\"); var suggestedTxnParams = await algod.GetSuggestedParams(); var microAlgosToSend = 1_000_000L; var paymentTxn = Transaction.Payment(sender, suggestedTxnParams, receiver, microAlgosToSend); Sign the transaction with an account: var account = Account.GenerateAccount(); var signedTxn = account.SignTxn(paymentTxn); Sign the transaction with kmd : var kmd = new KmdClient(\"<host of kmd>\"); var walletToken = await kmd.InitWalletHandleToken(\"<your wallet id>\", \"<your wallet password>\"); var signedTxn = await kmd.SignTransaction(paymentTxn.Sender, paymentTxn.ToSignatureMessage(), walletToken, \"<your kmd wallet password>\"); Send the signed transaction: await algod.SendTransaction(signedTxn); Installation 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. See Unity's official documentation on Scoped Registries . Unity Asset Store Algorand SDK for Unity is now available! Getting Started Read Getting Started to learn the basic workflows for developing on Algorand. Documentation Site Docs for this version were generated at https://careboo.github.io/unity-algorand-sdk/5.0 . Samples Some of the samples are built on WebGL and hosted on GitHub Pages. Your First Transaction Local Wallet"
"keywords": "Algorand SDK for Unity Integrate your game with Algorand , a Pure Proof-of-Stake blockchain overseen by the Algorand Foundation. Create Algorand transactions, Algorand accounts, and use Algorand's REST APIs . Table of Contents Table of Contents Requirements Common Usages Make a payment transaction Sign the transaction with an account Sign the transaction with kmd Send the signed transaction Installation Unity Asset Store Asset Package Open UPM Manually Adding UPM Scopes Getting Started Documentation Site Samples Requirements This package supports the following build targets and Unity versions: Unity Version Windows Mac OS Linux Android iOS WebGL 2021.3 ✅ ✅ ✅ ✅ ✅ ✅ 2022.3 ✅ ✅ ✅ ✅ ✅ ✅ ✅ All APIs are supported. ❌ Not supported. Use at your own risk. Common Usages Make a payment transaction: using Algorand.Unity; var sender = \"<your sender address>\"; var receiver = \"<your receiver address>\"; var algod = new AlgodClient(\"https://testnet-api.algonode.cloud\"); var suggestedTxnParams = await algod.GetSuggestedParams(); var microAlgosToSend = 1_000_000L; var paymentTxn = Transaction.Payment(sender, suggestedTxnParams, receiver, microAlgosToSend); Sign the transaction with an account: var account = Account.GenerateAccount(); var signedTxn = account.SignTxn(paymentTxn); Sign the transaction with kmd : var kmd = new KmdClient(\"<host of kmd>\"); var walletToken = await kmd.InitWalletHandleToken(\"<your wallet id>\", \"<your wallet password>\"); var signedTxn = await kmd.SignTransaction(paymentTxn.Sender, paymentTxn.ToSignatureMessage(), walletToken, \"<your kmd wallet password>\"); Send the signed transaction: await algod.SendTransaction(signedTxn); Installation Unity Asset Store Algorand SDK for Unity is now available! Asset Package Each release contains a .unitypackage package file that can be installed into a project. Download the latest release. Import the .unitypackage file into your project. Open UPM The easiest way to install as a package 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. See Unity's official documentation on Scoped Registries . Modify your scopes to include the following: { \"scopedRegistries\": [ { \"name\": \"package.openupm.com\", \"url\": \"https://package.openupm.com\", \"scopes\": [ \"com.careboo.unity-algorand-sdk\", \"com.cysharp.unitask\" ] } ] } Getting Started Read Getting Started to learn the basic workflows for developing on Algorand. Documentation Site Docs for this version were generated at https://careboo.github.io/unity-algorand-sdk/5.0 . Samples Some of the samples are built on WebGL and hosted on GitHub Pages. Your First Transaction Local Wallet"
},
"license/LICENSE.html": {
"href": "license/LICENSE.html",
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -7154,7 +7154,7 @@
"output": {
".html": {
"relative_path": "index.html",
"hash": "qfLM9i5AF0pYbqkMdXN0gM9o+f6Fag02R3oHQEGJ8po="
"hash": "uv9VhMzgVkobqSOCPEoSPJPQJBXSaXEohJ+b5lpDCmI="
}
},
"is_incremental": false,
Expand Down
Loading

0 comments on commit b23cbb4

Please sign in to comment.