Last Updated: 6/15/2022, 1:51:10 AM

# .NET (C#) SDK Getting Started Guide

# Overview

You can use the AccelByte .NET (C#) SDK to implement our backend services within your game. The SDK acts as a bridge between your game and our services. Follow the tutorial below to learn how to set up our .NET (C#) SDK.

# Prerequisites

Create a Game Namespace if you don’t have one yet. Be sure to keep the namespace’s Namespace ID as you will need it later.
Create an OAuth Client with a Confidential client type. Keep the Client ID and the Client Secret somewhere safe as you will be using them in this tutorial.
Download the AccelByte .NET (C#) SDK (opens new window).

# Tutorials

There are two ways of integrating the SDK into your project. You can either:

clone the repository and then build the solution using dotnet build and AccelByte.Sdk.dll in the bin directory, or
after cloning the repository, you can copy the AccelByte.Sdk directory into your project, add AccelByte.Sdk.csproj into your own solution, and add it as a project reference from your project.

To use the SDK, you will need to set the following environment variables in your system or debug profile (if you are using Visual Studio):

AB_BASE_URL*	AccelByte server base URL
AB_CLIENT_ID*	OAuth client ID
AB_CLIENT_SECRET*	OAuth client secret
AB_APP_NAME*	Your app/game name. Keep it unique and short
AB_NAMESPACE*	Your namespace ID
AB_TRACEID_VERSION	Version of Amazon trace ID (default is 1)
AB_ENABLE_TRACEID	Enable sending of Amazon trace ID on every request (default is 1). Set to 0 to disable.
AB_ENABLE_USERAGENT	Enable sending user agent string for the default http client (default is 1). Set to 0 to disable.
AB_USERNAME	Set the username for accessing AccelByte services
AB_PASSWORD	Set the AB_USERNAME password

# Using the SDK

Create an AccelByteSDK object.

using AccelByte.Sdk.Core;

AccelByteSDK sdk = AccelByteSDK.Builder
                .UseDefaultHttpClient()
                .UseDefaultConfigRepository()
                .UseDefaultTokenRepository()
                .Build();

The default configuration repository will load the required and optional variables from your environment. If you prefer to create your own repository, you can create a class that implements IConfigRepository and use it with the .SetConfigRepository method while creating the SDK object. You also can enable logging by calling the .EnableLog() method while creating the SDK object.

sdk.LoginUser("<username>","<password>");

If you set .UseDefaultCredentialRepository or .SetCredentialRepository while creating the SDK object, you can omit the parameters for the LoginUser method.

# Import AccelByte Services

Once completed, you can use the SDK to access all available AccelByte services.

# SDK Examples

See our .NET (C#) SDK example repo (opens new window) for a selection of test cases you can use to customize your game.

IAM

Access

Analytics

Distribution

Engagement

Social

Monetization

Storage

Play