-
Notifications
You must be signed in to change notification settings - Fork 7
Commit
This commit does not belong to any branch on this repository, and may belong to a fork outside of the repository.
- Loading branch information
1 parent
0da034a
commit 01d0786
Showing
18 changed files
with
170 additions
and
253 deletions.
There are no files selected for viewing
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,35 @@ | ||
--- | ||
title: Introduction to Beam Companion | ||
--- | ||
|
||
import { Callout, Cards, Card } from "nextra/components"; | ||
|
||
# Introduction to Beam Companion | ||
|
||
The Beam Companion app allows users to manage and access their on-chain NFTs earned through playing your game. | ||
|
||
You'll be able to find the latest version of the Beam Companion through the following links | ||
|
||
<Cards> | ||
<Card | ||
icon="🍎 " | ||
title="iOS" | ||
href="https://apps.apple.com/us/app/beam-companion/id6467641736" | ||
/> | ||
<Card | ||
icon="🤖 " | ||
title="Android" | ||
href="https://play.google.com/store/apps/details?id=com.onbeam.companion_app" | ||
/> | ||
</Cards> | ||
|
||
<Callout emoji="🛠️"> | ||
Make sure you connect to **Beam testnet** in order to implement the application | ||
during your development process. You can switch to testnet by switching on the | ||
log-in screen of the app. | ||
</Callout> | ||
|
||
### Connecting users to the Beam Companion app | ||
|
||
The Beam Companion app works based on the same authentication solution as is being used in the self-custody features of Beam, meaning that any user you onboard through that solution will automatically be linked to your game and is able to use the Beam Companion app. | ||
|
This file was deleted.
Oops, something went wrong.
This file was deleted.
Oops, something went wrong.
This file was deleted.
Oops, something went wrong.
This file was deleted.
Oops, something went wrong.
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,47 @@ | ||
--- | ||
title: Implementation | ||
--- | ||
|
||
import { Cards, Card } from "nextra-theme-docs"; | ||
|
||
# Implementing Beam | ||
|
||
The implementation of our new self-custodial service consists of two components | ||
|
||
- The Beam platform client. We currently solely provide a **C# sdk** meant to be implemented in the **Unity**. In the future, we will be releasing more implementations for various platforms. | ||
- The self-custody client. We currently provide a **C# and Typescript** client. | ||
|
||
In the near future, we expect to expand the platfom clients with all the self-custody client methods, giving you more flexibility on how you want to implement Beam in your game. | ||
|
||
|
||
### Initialize the platform client | ||
|
||
In order to interact with these clients, you will need a new type of API key - the `Publishable` API key. You will be able to find this API key by regenerating your API keys through the existing API. You can do so programmatically, or by interacting with the method in the [OpenAPI / Swagger UI](https://api.testnet.onbeam.com/api/game#/Game/regenerateApiKeys) interface. | ||
|
||
|
||
```csharp | ||
|
||
var beamClient = gameObject.AddComponent<BeamClient>() | ||
.SetBeamApiGame("your-game-id", "your-publishable-api-key") | ||
.SetEnvironment(BeamEnvironment.Testnet); | ||
``` | ||
|
||
|
||
### The self-custody client | ||
|
||
The self-custody client is a new client which can be used to generate [Operations](/service/operations/introduction). Both the self-custody clients we offer for the new self-custodial services, are structured in similar fashion to the existing SDKs that offer custodial [Profiles](/service/profiles/introduction). | ||
|
||
Keep in mind that we expect you to also use the `Publishable` API key in these clients. | ||
|
||
<Cards> | ||
<Card | ||
icon="✅ " | ||
title="Typescript" | ||
href="https://www.npmjs.com/package/@onbeam/self-custody" | ||
/> | ||
<Card | ||
icon="✅ " | ||
title="C# (RestSharp)" | ||
href="https://www.nuget.org/packages/BeamSelfCustody" | ||
/> | ||
</Cards> |
File renamed without changes.
This file was deleted.
Oops, something went wrong.
Oops, something went wrong.