Unity client for Nakama server.
Clone or download
Fetching latest commit…
Cannot retrieve the latest commit at this time.
Permalink
Failed to load latest commit information.
Assets/Nakama
ProjectSettings
.gitignore
.gitmodules
CHANGELOG.md
LICENSE
README.md

README.md

Nakama Unity

Unity client for Nakama server.

Nakama is an open-source server designed to power modern games and apps. Features include user accounts, chat, social, matchmaker, realtime multiplayer, and much more.

This client is built on the .NET client with extensions for Unity Engine. It requires the .NET4.6 scripting runtime version to be set in the editor. Navigate to Edit -> Project Settings -> Player -> Configuration (subheading) to apply it.

Full documentation is online - https://heroiclabs.com/docs/unity-client-guide

Getting Started

You'll need to setup the server and database before you can connect with the client. The simplest way is to use Docker but have a look at the server documentation for other options.

  1. Install and run the servers. Follow these instructions.

  2. Download the client from the releases page and import it into your project. You can also download prebuilt binaries from the Asset Store.

  3. Use the connection credentials to build a client object.

    // using Nakama;
    var client = new Client("defaultkey", "127.0.0.1", 7350, false)
    {
        Timeout = 10000, // set timeout on requests (default is 5000).
        Retries = 5      // set retries on requests (default is 3).
    };

Usage

The client object has many methods to execute various features in the server or open realtime socket connections with the server.

Authenticate

There's a variety of ways to authenticate with the server. Authentication can create a user if they don't already exist with those credentials. It's also easy to authenticate with a social profile from Google Play Games, Facebook, Game Center, etc.

var deviceId = SystemInfo.deviceUniqueIdentifier;
var session = await client.AuthenticateDeviceAsync(deviceId);
Debug.Log(session);

Sessions

When authenticated the server responds with an auth token (JWT) which contains useful properties and gets deserialized into a Session object.

Debug.Log(session.AuthToken); // raw JWT token
Debug.LogFormat("User id '{0}'", session.UserId);
Debug.LogFormat("User username '{0}'", session.Username);
Debug.LogFormat("Session has expired: {0}", session.IsExpired);
Debug.LogFormat("Session expires at: {0}", session.ExpireTime); // in seconds.

It is recommended to store the auth token from the session and check at startup if it has expired. If the token has expired you must reauthenticate. The expiry time of the token can be changed as a setting in the server.

var prefKeyName = "nakama.session";
var authtoken = PlayerPrefs.GetString(prefKeyName);
if (string.IsNullOrEmpty(authtoken) || Session.Restore(authtoken).IsExpired)
{
	Debug.Log("Session has expired. Must reauthenticate!");
}
else
{
	var session = Session.Restore(authtoken);
	Debug.Log(session);
}

Requests

The client includes lots of builtin APIs for various features of the game server. These can be accessed with the async methods. It can also call custom logic as RPC functions on the server. These can also be executed with a socket object.

All requests are sent with a session object which authorizes the client.

var account = await client.GetAccountAsync(session);
Debug.LogFormat("User id '{0}'", account.User.Id);
Debug.LogFormat("User username '{0}'", account.User.Username);
Debug.LogFormat("Account virtual wallet '{0}'", account.Wallet);

Socket

The client can create one or more sockets with the server. Each socket can have it's own event listeners registered for responses received from the server.

var socket = client.CreateWebSocket();
socket.OnConnect += (sender, args) =>
{
    Debug.Log("Socket connected.");
};
socket.OnDisconnect += (sender, args) =>
{
	Debug.Log("Socket disconnected.");
}
await socket.ConnectAsync(session);

Contribute

The development roadmap is managed as GitHub issues and pull requests are welcome. If you're interested to enhance the code please open an issue to discuss the changes or drop in and discuss it in the community chat.

This project can be opened in Unity to create a ".unitypackage".

License

This project is licensed under the Apache-2 License.