Nakama Dart Client Guide #

This client library guide will show you how to use the core Nakama features in Dart (Flutter) by showing you how to develop the Nakama specific parts (without full game logic or UI) of an Among Us (external) inspired game called Sagi-shi (Japanese for “Imposter”).

Sagi-shi gameplay screen — Sagi-shi gameplay

Prerequisites #

Before proceeding ensure that you have:

Full API documentation #

For the full API documentation please visit the API docs.

Installation #

The client is available from the GitHub Releases page and pub.dev.

To install the package in your project run:

1
2
3
4
5
# For flutter projects:
flutter pub add nakama

# For dart only projects
dart pub add nakama

Updates #

New versions of the Nakama Dart Client and the corresponding improvements are documented in the Changelog.

Nakama Socket #

The Nakama Socket is used for gameplay and real-time latency-sensitive features such as chat, parties, matches and RPCs.

1
2
3
4
5
final socket = NakamaWebsocketClient(
    host: '127.0.0.1',
    ssl: false,
    token: _session.token,
);

Handling exceptions #

Network programming requires additional safeguarding against connection and payload issues.

API calls in Sagi-shi are surrounded with a try block and a catch clause:

1
2
3
4
5
try {
    await client.authenticateDevice("<DeviceId>");
} catch (e) {
    print('Error authenticating device');
}

Getting started #

Learn how to get started using the Nakama Client and Socket objects to start building Sagi-shi and your own game.

Nakama Client #

The Nakama Client connects to a Nakama Server and is the entry point to access Nakama features. It is recommended to have one client per server per game.

To create a client for Sagi-shi pass in your server connection details:

1
2
3
4
5
6
7
final client = getNakamaClient(
  host: '127.0.0.1',
  ssl: false,
  serverKey: 'defaultkey',
  grpcPort: 7349, // optional
  httpPort: 7350, // optional
);

Nakama Socket #

The Nakama Socket is used for gameplay and real-time latency-sensitive features such as chat, parties, matches and RPCs. You need to initialize this once after authentication. Then you establish a connection until the user closes the app:

1
2
3
4
5
NakamaWebsocketClient.init(
    host: '127.0.0.1',
    ssl: false,
    token: _session.token,
);

Remember to close the connection after disposing of the app widget:

1
NakamaWebsocketClient.instance.close();

Authentication #

Nakama has many authentication methods and supports creating custom authentication on the server.

Sagi-shi will use device and Facebook authentication, linked to the same user account so that players can play from multiple devices.

Sagi-shi login screen — Login screen and Authentication options

Device authentication #

Nakama Device Authentication uses the physical device’s unique identifier to easily authenticate a user and create an account if one does not exist.

When using only device authentication, you don’t need a login UI as the player can automatically authenticate when the game launches.

Authentication is an example of a Nakama feature accessed from a Nakama Client instance.

 1
 2
 3
 4
 5
 6
 7
 8
 9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
Future<void> authenticateWithDevice() async {
    String deviceId;
    DeviceInfoPlugin deviceInfo = DeviceInfoPlugin();

    // Grabbing device id from device_info_plus package for iOS & Android
    if (Platform.isIOS) {
        deviceId = (await deviceInfo.iosInfo).identifierForVendor;
    } else if (Platform.isAndroid) {
        deviceId = (await deviceInfo.androidInfo).androidId;
    } else {
        // On web you could e.g. generate a UUID and store it into local storage
        final uuid = Uuid();
        deviceId = uuid.v4();
    }

    try {
        // Authenticate against Nakama with our device token.
        final session = await client.authenticateDevice(
            deviceId: deviceId,
        );
    } catch(e) {
        print('Authentication failed');
    }
}

Facebook authentication #

Nakama Facebook Authentication is an easy to use authentication method which lets you optionally import the player’s Facebook friends and add them to their Nakama Friends list.

To use Nakama Facebook Authentication, you need a facebook token that you can get for example with the flutter_facebook_login (external) package.

1
2
3
4
5
6
7
8
9
Future<void> authenticateWithFacebook() async {
    try {
        final session = await client.authenticateFacebook(
            token: facebookToken,
        );
    } catch(e) {
        print('Error authenticating with facebook');
    }
}

Custom authentication #

Nakama supports Custom Authentication methods to integrate with additional identity services.

See the Itch.io custom authentication recipe for an example.

The following code shows how you would authenticate from the client side:

1
2
3
4
5
6
7
8
9
Future<void> authenticationWithCustom() async {
    try {
        final session = await client.authenticateCustom(
            id: 'custom-user-id',
        );
    } catch(e) {
        print('Error authenticating with custom token');
    }
}

Linking authentication #

Nakama allows players to Link Authentication methods to their account once they have authenticated.

Linking Device ID authentication

 1
 2
 3
 4
 5
 6
 7
 8
 9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
Future<void> linkDeviceAuthentication() async {
    String deviceId;
    DeviceInfoPlugin deviceInfo = DeviceInfoPlugin();

    // Grabbing device id from device_info_plus package for iOS & Android
    if (Platform.isIOS) {
        deviceId = (await deviceInfo.iosInfo).identifierForVendor;
    } else if (Platform.isAndroid) {
        deviceId = (await deviceInfo.androidInfo).androidId;
    } else {
        // On web you could e.g. generate a UUID and store it into local storage
        final uuid = Uuid();
        deviceId = uuid.v4();
    }

    try {
        // Authenticate against Nakama with our device token.
        final session = await client.linkDevice(
            deviceId: deviceId,
        );
    } catch(e) {
        print('Linking device failed');
    }
}

Linking Facebook authentication

 1
 2
 3
 4
 5
 6
 7
 8
 9
10
11
Future<void> linkFacebookAuthentication({
    required bool importFriends = true,
}) async {
    try {
        final session = await client.linkFacebook(
            token: facebookToken,
        );
    } catch(e) {
        print('Error linking account with facebook');
    }
}

Session variables #

Nakama Session Variables can be stored when authenticating and will be available on the client and server as long as the session is active.

Sagi-shi uses session variables to implement analytics, referral and rewards programs and more. We are using package_info_plus (external) to fetch the application version.

Store session variables by passing them as an argument when authenticating:

 1
 2
 3
 4
 5
 6
 7
 8
 9
10
11
PackageInfo packageInfo = await PackageInfo.fromPlatform();

final vars = {
    'inviterUserId': '<someUserId>',
    'gameVersion': packageInfo.version,
};

var session = await client.authenticateDevice(
    deviceId: '<someDeviceId'>,
    vars: vars,
);

To access session variables on the Client use the vars property on the Session object:

1
final inviterUserId = session.vars['inviterUserId'];

Session lifecycle #

Nakama Sessions expire after a time set in your server configuration. Expiring inactive sessions is a good security practice.

Nakama provides ways to restore sessions, for example when Sagi-shi players re-launch the game, or refresh tokens to keep the session active while the game is being played.

Use the auth and refresh tokens on the session object to restore or refresh sessions.

To restore a session without having to re-authenticate just pass the session which is about to expire to sessionRefresh method and you’ll receive a new one:

1
2
3
4
5
6
7
try {
    final session = await client.sessionRefresh(
        session: expiringSession,
    );
} catch(e) {
    print('Error refreshing the session');
}

Check if a session has expired or is close to expiring and refresh it to keep it alive:

 1
 2
 3
 4
 5
 6
 7
 8
 9
10
11
12
final inOneHour = DateTime.now().add(Duration(hours: 1));

// Check whether a session has expired or is close to expiry.
if (session.isExpired || session.hasExpired(inOneHour)) {
    try {
        // Attempt to refresh the existing session.
        session = await client.sessionRefresh(session);
    } catch (e) {
        // Couldn't refresh the session so reauthenticate.
        session = await client.authenticateDevice(deviceId: deviceId);
    }
}

Ending sessions #

Logout and end the current session:

1
await client.sessionLogout(session: session);

User accounts #

Nakama User Accounts store user information defined by Nakama and custom developer metadata.

Sagi-shi allows players to edit their accounts and stores metadata for things like game progression and in-game items.

Player profile

Get the user account #

Many of Nakama’s features are accessible with an authenticated session, like fetching a user account.

Get a Sagi-shi player’s full user account with their basic user information and user id:

1
2
3
4
final account = await client.getAccount(session);
final username = account.user.username;
final avatarUrl = account.user.avatarUrl;
final userId = account.user.id;

Update the user account #

Nakama provides easy methods to update server stored resources like user accounts.

Sagi-shi players need to be able to update their public profiles:

 1
 2
 3
 4
 5
 6
 7
 8
 9
10
11
12
13
14
15
final newUsername = "NotTheImp0ster";
final newDisplayName = "Innocent Dave";
final newAvatarUrl = "https://example.com/imposter.png";
final newLangTag = "en";
final newLocation = "Edinburgh";
final newTimezone = "BST";
await client.updateAccount(
    session: session,
    username: newUsername,
    displayName: newDisplayName,
    avatarUrl: newAvatarUrl,
    langTag: newLangTag,
    location: newLocation,
    timezone: newTimezone,
);

Getting users #

In addition to getting the current authenticated player’s user account, Nakama has a convenient way to get a list of other players’ public profiles from their ids or usernames.

Sagi-shi uses this method to display player profiles when engaging with other Nakama features:

1
2
3
4
final users = await client.getUsers(
    session: session,
    ids: ['<anotherId>'],
);

Storing metadata #

Nakama User Metadata allows developers to extend user accounts with public user fields.

User metadata can only be updated on the server. See the updating user metadata recipe for an example.

Sagi-shi will use metadata to store what in-game items players have equipped:

Reading metadata #

Define a class that describes the metadata and parse the JSON metadata:

 1
 2
 3
 4
 5
 6
 7
 8
 9
10
// Get the updated account object.
final account = await client.getAccount(session);

// Parse the account user metadata into Map<String, dynamic>
// Metadata is just stored as string, so you can store whatever you want
final metadata = jsonDecode(account.metadata);

print('Title: ${metadata['title']}');
print('Hat: ${metadata['hat']}');
print('Skin: ${metadata['skin']}');

Wallets #

Nakama User Wallets can store multiple digital currencies as key/value pairs of strings/integers.

Players in Sagi-shi can unlock or purchase titles, skins and hats with a virtual in-game currency.

Accessing wallets #

Parse the JSON wallet data from the user account:

1
2
3
4
5
6
7
final account = await client.getAccount(session);
final wallet = jsonDecode(account.wallet);

foreach (var currency in wallet.entries) {
    // Print out e.g. EUR: 2.50
    print('${currency.key}: ${currency.value}');
}

Updating wallets #

Wallets can only be updated on the server. See the user account virtual wallet documentation for an example.

Validating in-app purchases #

Sagi-shi players can purchase the virtual in-game currency through in-app purchases that are authorized and validated to be legitimate on the server.

See the In-app Purchase Validation documentation for examples.

Storage Engine #

The Nakama Storage Engine is a distributed and scalable document-based storage solution for your game.

The Storage Engine gives you more control over how data can be accessed and structured in collections.

Collections are named, and store JSON data under a unique key and the user id.

By default, the player has full permission to create, read, update and delete their own storage objects.

Sagi-shi players can unlock or purchase many items, which are stored in the Storage Engine.

Sagi-shi player items screen — Player items

Reading storage objects #

Define a class that describes the storage object and create a new storage object id with the collection name, key and user id. Finally, read the storage objects and parse the JSON data:

 1
 2
 3
 4
 5
 6
 7
 8
 9
10
11
12
final result = await client.readStorageObject(
    session: session,
    collection: 'Unlocks',
    key: 'Hats',
    userId: session.UserId
);

if (result != null) {
    final hats = jsonDecode(result.value);

    print('Unlocked hats: ${hats}');
}

To read other players’ public storage objects use their userId instead. Remember that players can only read storage objects they own or that are public (PermissionRead value of 2).

Writing storage objects #

Nakama allows developers to write to the Storage Engine from the client and server.

Consider what adverse effects a malicious user can have on your game and economy when deciding where to put your write logic, for example data that should only be written authoritatively (i.e. game unlocks or progress).

Sagi-shi allows players to favorite items for easier access in the UI and it is safe to write this data from the client.

Create a write storage object with the collection name, key and JSON encoded data. Finally, write the storage objects to the Storage Engine:

1
2
3
4
5
6
7
8
await client.writeStorageObject(
    session: session,
    collection: 'favorites',
    key: 'hats',
    value: jsonEncode(['cowboy', 'alien']),
    readPermission: StorageReadPermission.ownerRead,
    writePermission: StorageWritePermission.ownerWrite,
);

Conditional writes #

Storage Engine Conditional Writes ensure that write operations only happen if the object hasn’t changed since you accessed it.

This gives you protection from overwriting data, for example the Sagi-shi server could have updated an object since the player last accessed it.

To perform a conditional write, add a version to the write storage object with the most recent object version:

 1
 2
 3
 4
 5
 6
 7
 8
 9
10
11
12
13
14
// Assuming we already have a storage object (storageObject)
try {
    await client.writeStorageObject(
        session: session,
        collection: 'favorites',
        key: 'hats',
        value: jsonEncode(['cowboy', 'alien']),
        readPermission: StorageReadPermission.ownerRead,
        writePermission: StorageWritePermission.ownerWrite,
        version: storageObject.version,
    );
} catch(e) {
    print(e);
}

Listing storage objects #

Instead of doing multiple read requests with separate keys you can list all the storage objects the player has access to in a collection.

Sagi-shi lists all the player’s unlocked or purchased titles, hats and skins:

 1
 2
 3
 4
 5
 6
 7
 8
 9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
const limit = 3;
final unlocksObjectList = await client.listStorageObjects(
    session: session, 
    collection: 'unlocks',
    userId: session.userId,
    limit: limit,
);

for (var unlockStorageObject in unlocksObjectList.objects) {
    switch(unlockStorageObject.key) {
        case "titles":
            var unlockedTitles = jsonDecode(unlockStorageObject.value);
            // Display the unlocked titles
            break;
        case "hats":
            var unlockedHats = jsonDecode(unlockStorageObject.value);
            // Display the unlocked hats
            break;
        case "skins":
            var unlockedSkins = jsonDecode(unlockStorageObject.value);
            // Display the unlocked skins
            break;
    }
}

Paginating results #

Nakama methods that list results return a cursor which can be passed to subsequent calls to Nakama to indicate where to start retrieving objects from in the collection.

For example:

If the cursor has a value of 5, you will get results from the fifth object.
If the cursor is null, you will get results from the first object.

1
2
3
4
5
6
final objectList = await client.listStorageObjects(
    session: session,
    collection: "<CollectionName>",
    limit: limit,
    cursor: objectList.Cursor,
);

Protecting storage operations on the server #

Nakama Storage Engine operations can be protected on the server to protect data the player shouldn’t be able to modify (i.e. game unlocks or progress). See the writing to the Storage Engine authoritatively recipe.

Remote Procedure Calls #

The Nakama Server allows developers to write custom logic and expose it to the client as RPCs.

Sagi-shi contains various logic that needs to be protected on the server, like checking if the player owns equipment before equipping it.

Creating server logic #

See the handling player equipment authoritatively recipe for an example of creating a remote procedure to check if the player owns equipment before equipping it.

Client RPCs #

Nakama Remote Procedures can be called from the client and take optional JSON payloads.

The Sagi-shi client makes an RPC to securely equip a hat:

 1
 2
 3
 4
 5
 6
 7
 8
 9
10
11
try {
    final payload = { 'item': 'cowboy' };
    final response = await client.rpc(
        session: session,
        id: 'EquipHat',
        payload: jsonEncode(payload),
    );
    print('New hat equipped successfully: $response');
} catch (e) {
    print(e);
}

Socket RPCs #

Nakama Remote Procedures can also be called from the socket when you need to interface with Nakama’s real-time functionality.

1
2
3
4
final response = await socket.rpc(
    id: '<RpcId>',
    payload: '<PayloadString>',
);

Friends #

Nakama Friends offers a complete social graph system to manage friendships amongst players.

Sagi-shi allows players to add friends, manage their relationships and play together.

Sagi-shi Friends screen — Friends screen

Adding friends #

Adding a friend in Nakama does not immediately add a mutual friend relationship. An outgoing friend request is created to each user, which they will need to accept.

Sagi-shi allows players to add friends by their usernames or user ids:

 1
 2
 3
 4
 5
 6
 7
 8
 9
10
11
// Add friends by Username.
await client.addFriends(
    session: session,
    usernames: [ 'AlwaysTheImposter21', 'SneakyBoi' ],
);

// Add friends by User ID.
await client.addFriends(
    session: session,
    ids: [ '<SomeUserId>', '<AnotherUserId>' ],
);

Friendship states #

Nakama friendships are categorized with the following states:

Value	State
0	Mutual friends
1	An outgoing friend request pending acceptance
2	An incoming friend request pending acceptance
3	Blocked by the user

Listing friends #

Nakama allows developers to list the player’s friends based on their friendship state.

Sagi-shi lists the 20 most recent mutual friends:

 1
 2
 3
 4
 5
 6
 7
 8
 9
10
11
final limit = 20; // Limit is capped at 1000
final frienshipState = FriendshipState.mutual;
final result = await client.listFriends(
    session: session,
    friendshipState: frienshipState,
    limit: limit,
);

for (var friend in result.friends) {
    print('ID: ${friend.user.id}');
}

Accepting friend requests #

When accepting a friend request in Nakama the player adds a bi-directional friend relationship.

Nakama takes care of changing the state from pending to mutual for both.

In a complete game you would allow players to accept individual requests.

Sagi-shi just fetches and accepts all the incoming friend requests:

 1
 2
 3
 4
 5
 6
 7
 8
 9
10
11
12
13
final limit = 1000;
final result = await client.listFriends(
    session: session,
    friendshipState: FriendshipState.incomingRequest,
    limit: limit,
);

for (var friend in result.friends) {
    await client.addFriends(
        session: session,
        ids: friend.user.id,
    );
}

Deleting friends #

Sagi-shi players can remove friends by their username or user id:

 1
 2
 3
 4
 5
 6
 7
 8
 9
10
11
// Delete friends by User ID.
await client.deleteFriends(
    session: session,
    ids: [ '<SomeUserId>', '<AnotherUserId>' ],
);

// Delete friends by Username.
await client.deleteFriends(
    session: session,
    usernames: [ '<SomeUsername>', '<AnotherUsername>' ],
);

Blocking users #

Sagi-shi players can block others by their username or user id:

 1
 2
 3
 4
 5
 6
 7
 8
 9
10
11
// Block friends by User ID.0
await client.blockFriends(
    session: session,
    ids: [ '<SomeUserId>', '<AnotherUserId>' ],
);

// Block friends by Username.
await client.blockFriends(
    session: session,
    usernames: [ '<SomeUsername>', '<AnotherUsername>' ],
);

Status & Presence #

Nakama Status is a real-time status and presence service that allows users to set their online presence, update their status message and follow other user’s updates.

Players don’t have to be friends with others they want to follow.

Sagi-shi uses status messages and online presences to notify players when their friends are online and share matches.

Sagi-shi status update screen — Updating player status

Follow users #

The Nakama real-time APIs allow developers to subscribe to events on the socket, like a status presence change, and receive them in real-time.

The method to follow users also returns the current online users, known as presences, and their status.

Sagi-shi follows a player’s friends and notifies them when they are online:

 1
 2
 3
 4
 5
 6
 7
 8
 9
10
11
12
13
14
15
16
17
18
19
20
21
a.onStatusPresence.listen((event) {
    for (final presence in event.joins) {
        print('${presence.username} is online with status ${presence.status}');
    }

    for (final presence in event.leaves) {
        print('${presence.username} went offline');
    }
});

// Follow mutual friends and get the initial Status of any that are currently online.
final friendsResult = await client.listFriends(
    session: session,
    friendshipState: FriendshipState.mutual,
);
final friendIds = friends.friends.map((f) => f.user.id).toList();
final result = await socket.followUsers(friendIds);

for (var presence in result.presences) {
    print('${presence.username} is online with status: ${presence.status}');
}

Unfollow users #

Sagi-shi players can unfollow others:

1
await socket.unfollowUsers(['<userId>']);

Updating player status #

Sagi-shi players can change and publish their status to their followers:

1
await socket.updateStatus('Viewing the Main Menu');

Groups #

Nakama Groups is a group or clan system with public/private visibility, user memberships and permissions, metadata and group chat.

Sagi-shi allows players to form and join groups to socialize and compete.

Sagi-shi groups screen — Groups list screen

Creating groups #

Groups have a public or private “open” visibility. Anyone can join public groups, but they must request to join and be accepted by a superadmin/admin of a private group.

Sagi-shi players can create groups around common interests:

1
2
3
4
5
6
7
final group = await client.createGroup(
    session: session,
    name: 'Imposters R Us',
    description: 'A group for people who love playing the imposter.',
    open: true, // public group
    maxCount: 100,
);

Update group visibility #

Nakama allows group superadmin or admin members to update some properties from the client, like the open visibility:

1
2
3
4
5
6
await client.updateGroup(
    session: session,
    id: '<GroupId>',
    name: '<NewGroupName>',
    open: true,
);

Update group size #

Other properties, like the group’s maximum member size, can only be changed on the server.

See the updating group size recipe for an example, and the Groups server function reference to learn more about updating groups on the server.

Sagi-shi group edit screen — Sagi-shi group edit

Listing and filtering groups #

Groups can be listed like other Nakama resources and also filtered with a wildcard group name.

Sagi-shi players use group listing and filtering to search for existing groups to join:

 1
 2
 3
 4
 5
 6
 7
 8
 9
10
11
12
13
14
15
16
17
18
const limit = 20;
final result = await client.listGroups(
    session: session,
    name: "imposter%",
    limit: limit,
);

for (var group in result.groups) {
    print('${group.name} [${group.open ? 'Public' : 'Private'}]');
}

// Get the next page of results.
final nextResults = await client.listGroups(
    session: session,
    name: "imposter%",
    limit: limit,
    cursor: result.cursor,
);

Deleting groups #

Nakama allows group superadmins to delete groups.

Developers can disable this feature entirely, see the Guarding APIs guide for an example on how to protect various Nakama APIs.

Sagi-shi players can delete groups which they are superadmins for:

1
2
3
4
await client.deleteGroup(
    session: session,
    groupId: "<GroupId>"
);

Group metadata #

Like Users Accounts, Groups can have public metadata.

Sagi-shi uses group metadata to store the group’s interests, active player times and languages spoken.

Group metadata can only be updated on the server. See the updating group metadata recipe for an example.

The Sagi-shi client makes an RPC with the group metadata payload:

 1
 2
 3
 4
 5
 6
 7
 8
 9
10
11
12
13
14
15
16
17
final payload = {
    groupId: '<GroupId>',
    interests: ['Deception', 'Sabotage', 'Cute Furry Bunnies'],
    activeTimes: ['9am-2pm Weekdays', '9am-10pm Weekends'],
    languages: ['English', 'German'],
};

try {
    final result = await client.rpc(
        session: session,
        'UpdateGroupMetadata',
        jsonEncode(payload),
    );
    print('Successfully updated group metadata');
} catch (e) {
    print(e);
}

Group membership states #

Nakama group memberships are categorized with the following states:

Code	Purpose
0	Superadmin	There must at least be 1 superadmin in any group. The superadmin has all the privileges of the admin and can additionally delete the group and promote admin members.
1	Admin	There can be one of more admins. Admins can update groups as well as accept, kick, promote, demote, ban or add members.
2	Member	Regular group member. They cannot accept join requests from new users.
3	Join request	A new join request from a new user. This does not count towards the maximum group member count.

Joining a group #

If a player joins a public group they immediately become a member, but if they try and join a private group they must be accepted by a group admin.

Sagi-shi players can join a group:

1
2
3
4
await client.joinGroup(
    session: session,
    groupId: '<GroupId>',
);

Listing the user’s groups #

Sagi-shi players can list groups they are a member of:

1
2
3
4
5
final results = await client.listUserGroups(session: session);

for (var userGroup in results.userGroups) {
    print('${userGroup.group.name}: ${userGroup.state}' );
}

Listing members #

Sagi-shi players can list a group’s members:

1
2
3
4
5
6
7
8
final result = await client.listGroupUsers(
    session: session,
    groupId: '<GroupId>',
);

for (var groupUser in result.groupUsers) {
    print('${groupUser.user.id}: ${groupUser.state}');
}

Accepting join requests #

Private group admins or superadmins can accept join requests by re-adding the user to the group.

Sagi-shi first lists all the users with a join request state and then loops over and adds them to the group:

 1
 2
 3
 4
 5
 6
 7
 8
 9
10
11
12
13
final result = await client.listGroupUsers(
    session: session,
    groupId: '<GroupId>',
    state: GroupMembershipState.joinRequest,
);

for (var groupUser in result.groupUsers) {
    await client.addGroupUsers(
        session: session,
        groupId: '<GroupId>',
        userIds: [groupUser.user.id],
    );
}

Promoting members #

Nakama group members can be promoted to admin or superadmin roles to help manage a growing group or take over if members leave.

Admins can promote other members to admins, and superadmins can promote other members up to superadmins.

The members will be promoted up one level. For example:

Promoting a member will make them an admin
Promoting an admin will make them a superadmin

1
2
3
4
5
await client.promoteGroupUsers(
    session: session,
    groupId: '<GroupId>', 
    userIds: ['<UserId'>],
);

Demoting members #

Sagi-shi group admins and superadmins can demote members:

1
2
3
4
5
await client.demoteGroupUsers(
    session: session,
    groupId: '<GroupId>', 
    userIds: ['<UserId>'],
);

Kicking members #

Sagi-shi group admins and superadmins can remove group members:

1
2
3
4
5
await client.kickGroupUsers(
    session: session,
    groupId: '<GroupId>', 
    userIds: ['<UserId'>],
);

Banning members #

Sagi-shi group admins and superadmins can ban a user when demoting or kicking is not severe enough:

1
2
3
4
5
await client.banGroupUsers(
    session: session,
    groupId: '<GroupId>',
    userIds: ['<UserId>'],
);

Leaving groups #

Sagi-shi players can leave a group:

1
2
3
4
await client.leaveGroup(
    session: session,
    groupId: '<GroupId>',
);

Chat #

Nakama Chat is a real-time chat system for groups, private/direct messages and dynamic chat rooms.

Sagi-shi uses dynamic chat during matches, for players to mislead each other and discuss who the imposters are, group chat and private/direct messages.

Joining dynamic rooms #

Sagi-shi matches have a non-persistent chat room for players to communicate in:

1
2
3
4
5
6
7
8
final channel = await socket.joinChannel(
    target: '<MatchId>',
    type: ChannelType.room,
    persistence: true,
    hidden: false,
);

print('Connected to dynamic room channel: ${channel.id}');

Joining group chat #

Sagi-shi group members can have conversations that span play sessions in a persistent group chat channel:

1
2
3
4
5
6
7
8
final channel = await socket.joinChannel(
    target: '<GroupId>',
    type: ChannelType.group,
    persistence: true,
    hidden: false,
);

print('Connected to group channel: ${channel.id}');

Joining direct chat #

Sagi-shi players can also chat privately one-to-one during or after matches and view past messages:

1
2
3
4
5
6
7
8
final channel = await socket.joinChannel(
    target: '<UserId>',
    type: ChannelType.directMessage,
    persistence: true,
    hidden: false,
);

print('Connected to direct message channel: ${channel.id}');

Sending messages #

Sending messages is the same for every type of chat channel. Messages contain chat text and emotes and are sent as JSON serialized data:

 1
 2
 3
 4
 5
 6
 7
 8
 9
10
11
12
13
final messageSendAck = await socket.sendMessage(
    channelId: '<ChannelId>',
    content: {'message': 'I think Red is the imposter!'},
);

final emoteContent = {
    'emote': 'point',
    'emoteTarget': '<RedPlayerUserId>',
};
final emoteSendAck = await socket.sendMessage(
    channelId: '<ChannelId>',
    content: emoteContent,
);

Listing message history #

Message listing takes a parameter which indicates if messages are received from oldest to newest (forward) or newest to oldest.

Sagi-shi players can list a group’s message history:

 1
 2
 3
 4
 5
 6
 7
 8
 9
10
11
final result = await client.listChannelMessages(
    session: session,
    groupId: '<GroupId>',
    limit: 100,
    forward: true,
    cursor: null,
);

for (var message in result.messages) {
    print('${message.username}: ${message.content}');
}

Updating messages #

Nakama also supports updating messages. It is up to you whether you want to use this feature, but in a game of deception like Sagi-shi it can add an extra element of deception.

For example a player sends the following message:

1
2
3
4
5
6
const channelId = '<ChannelId>'
final messageContent = {'message': 'I think Red is the imposter!'};
final messageSendAck = await socket.sendMessage(
    channelId: channelId,
    messageContent,
);

They then quickly edit their message to confuse others:

1
2
3
4
5
6
final newMessageContent = {'message': 'I think BLUE is the imposter!'};
final messageUpdateAck = await socket.updateMessage(
    channelId: channelId,
    messageSendAck.messageId,
    content: newMessageContent,
);

Matches #

Nakama supports Server Authoritative and Server Relayed multiplayer matches.

In server authoritative matches the server controls the gameplay loop and must keep all clients up to date with the current state of the game.

In server relayed matches the client is in control, with the server only relaying information to the other connected clients.

In a competitive game such as Sagi-shi, server authoritative matches would likely be used to prevent clients from interacting with your game in unauthorized ways.

For the simplicity of this guide, the server relayed model is used.

Creating matches #

Sagi-shi players can create their own matches and invite their online friends to join:

 1
 2
 3
 4
 5
 6
 7
 8
 9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
final match = await socket.createMatch();
final friendsList = await client.listFriends(
    session: session,
    friendshipState: FriendshipState.mutual,
    limit: 100,
);
final onlineFriends = friendsList.friends.where((friend) => friend.user.online).toList();

for (var friend in onlineFriends) {
    final content = {
        message: 'Hey ${friend.username}, join me for a match!',
        matchId: match.id,
    };

    final channel = await socket.joinChannel(
        target: friend.id,
        type: ChannelType.directMessage,
    );
    final messageAck = await socket.sendMessage(
        channelId: channel.id,
        content: content,
    );
}

Creating a match by match name

Sagi-shi players can also create matches with a specific match name, this allows them to invite their friends by telling them the name of the match. It should be noted that when creating a match by name (which is an arbitrary name and not something tied to authoritative match handlers), the match will always be a relayed match rather than an authoritative match.

1
2
const matchName = 'NoImpostersAllowed';
final match = await socket.createMatch(matchName);

Joining matches #

Sagi-shi players can try to join existing matches if they know the id:

1
2
const matchId = "<MatchId>";
final match = await socket.joinMatch(matchId);

Or set up a real-time matchmaker listener and add themselves to the matchmaker:

 1
 2
 3
 4
 5
 6
 7
 8
 9
10
11
12
socket.onMatchmakerMatched.listen((matchmakerMatched) {
    final match = await socket.joinMatch(matchmakerMatched.matchId);
});

const minPlayers = 2;
const maxPlayers = 10;

final matchmakingTicket = await socket.addMatchmaker(
    query: '',
    minCount: minPlayers,
    maxCount: maxPlayers,
);

Joining matches by match name

Sagi-shi players can join a match by match name if their friends have shared one with them.

Joining matches from player status

Sagi-shi players can update their status when they join a new match:

1
2
3
4
5
6
final status = {
    'Status': 'Playing a match',
    'MatchId': '<MatchId>',
};

await socket.updateStatus(jsonEncode(status));

When their followers receive the real-time status event they can try and join the match:

 1
 2
 3
 4
 5
 6
 7
 8
 9
10
11
12
13
14
15
16
socket.onStatusPresence.listen((statusPresence) {
    // Join the first match found in a friend's status
    final presence = event.joins.firstWhere((element) {
        if (element.status == null) return false;

        final status = jsonDecode(element.status!);

        return status.containsKey('MatchId');
    });
    
    // No presence with a match found
    if (presence == null) return;

    final status = jsonDecode(presence.status!);
    socket.joinMatch(status['MatchId']);
});

Listing matches #

Match Listing takes a number of criteria to filter matches by including player count, a match label and an option to provide a more complex search query.

Sagi-shi matches start in a lobby state. The match exists on the server but the actual gameplay doesn’t start until enough players have joined.

Sagi-shi can then list matches that are waiting for more players:

 1
 2
 3
 4
 5
 6
 7
 8
 9
10
11
12
13
14
15
16
17
18
19
20
const minPlayers = 2;
const maxPlayers = 10;
const limit = 10;
const authoritative = true;
const label = "";
const query = "";

final result = await client.listMatches(
    session: session,
    minSize: minPlayers,
    maxSize: maxPlayers,
    limit: limit,
    authoritative: authoritative,
    label: label,
    query: query,
);

for (var match in result.matches) {
    print('{match.matchId}: ${match.size}/10 players');
}

To find a match that has a label of "AnExactMatchLabel":

1
const label = "AnExactMatchLabel";

Advanced:

In order to use a more complex structured query, the match label must be in JSON format.

To find a match where it expects player skill level to be >100 and optionally has a game mode of "sabotage":

1
const query = "+label.skill:>100 label.mode:sabotage"

Spawning players #

The match object has a list of current online users, known as presences.

Sagi-shi uses the match presences to spawn players on the client:

Sagi-shi keeps the spawned players up-to-date as they leave and join the match using the match presence received event:

 1
 2
 3
 4
 5
 6
 7
 8
 9
10
11
12
13
14
15
16
socket.onMatchPresence.listen((matchPresenceEvent) {
    // For each player that has joined in this event...
    for (var presence in matchPresenceEvent.joins) {
        // Spawn a player for this presence and store it in a dictionary by session id.
        players[presence.sessionId] = presence;
    }

    // For each player that has left in this event...
    for (var presence in matchPresenceEvent.leaves) {
        // Remove the player from the game if they've been spawned
        if (players.containsKey(presence.sessionId)) {
            players.removeWhere((key, value) => key == presence.sessionId);
        }

    }
});

Sending match state #

Nakama has real-time networking to send and receive match state as players move and interact with the game world.

During the match, each Sagi-shi client sends match state to the server to be relayed to the other clients.

Match state contains an op code that lets the receiver know what data is being received so they can deserialize it and update their view of the game.

Example op codes used in Sagi-shi:

1: player position
2: player calling vote

Sending player position

Define a list to represent Sagi-shi player position states in the format [X, Y, Z]:

1
2
3
4
5
final playersPosition = [
    transform.position.x,
    transform.position.y,
    transform.position.z,
];

Set the op code and send the JSON encoded state:

1
2
3
const opCode = 1;

await socket.sendMatchData(match.id, opCode, jsonEncode(playersPosition));

Op Codes as a static class

Sagi-shi has many networked game actions. Using a static class of constants for op codes will keep your code easier to follow and maintain:

 1
 2
 3
 4
 5
 6
 7
 8
 9
10
class OpCodes {
  static const position = 1;
  static const vote = 2;
}

await socket.sendMatchData(
    match.id,
    OpCodes.position,
    jsonEncode(state).codeUnits,
);

Receiving match sate #

Sagi-shi players can receive match data from the other connected clients by subscribing to the match state received event:

 1
 2
 3
 4
 5
 6
 7
 8
 9
10
11
12
13
14
15
16
17
18
socket.onMatchData.listen((matchData) {
    switch (matchData.opCode) {
        case OpCodes.position:
            // Get the updated position data
            final stateJson = String.fromCharCodes(matchData.data);
            final positionState = jsonDecode(stateJson);

            // Update the GameObject associated with that player
            if (players.containsKey(matchData.presence.sessionId)) {
                // Here we would normally do something like smoothly interpolate to the new position, but for this example let's just set the position directly.
                players[matchData.presence.sessionId].transform.position = positionState;
            }
            break;
        default:
            print("Unsupported op code");
            break;
    }
});

Matchmaker #

Developers can find matches for players using Match Listing or the Nakama Matchmaker, which enables players join the real-time matchmaking pool and be notified when they are matched with other players that match their specified criteria.

Matchmaking helps players find each other, it does not create a match. This decoupling is by design, allowing you to use matchmaking for more than finding a game match. For example, if you were building a social experience you could use matchmaking to find others to chat with.

Add matchmaker #

Matchmaking criteria can be simple, find 2 players, or more complex, find 2-10 players with a minimum skill level interested in a specific game mode.

Sagi-shi allows players to join the matchmaking pool and have the server match them with other players:

 1
 2
 3
 4
 5
 6
 7
 8
 9
10
const minPlayers = 2;
const maxPlayers = 10;

final matchmakerTicket = await socket.addMatchmaker(
    query: '+skill:>100 mode:sabotage',
    minCount: minPlayers,
    maxCount: maxPlayers,
    stringProperties: {'mode': 'sabotage'},
    numericProperties: {'skill': 125 },
);

Parties #

Nakama Parties is a real-time system that allows players to form short lived parties that don’t persist after all players have disconnected.

Sagi-shi allows friends to form a party and matchmake together.

Creating parties #

The player who creates the party is the party’s leader. Parties have maximum number of players and can be open to automatically accept players or closed so that the party leader can accept incoming join requests.

Sagi-shi uses closed parties with a maximum of 4 players:

1
2
3
4
var party = await socket.createParty(
    open: false,
    maxSize: maxPlayers,
);

Sagi-shi shares party ids with friends via private/direct messages:

 1
 2
 3
 4
 5
 6
 7
 8
 9
10
11
12
13
14
15
16
17
18
19
20
21
22
final friendsList = await client.listFriends(
    session: session,
    friendshipState: FriendshipState.mutual,
    limit: 100,
);
final onlineFriends = friendsList.friends.where((friend) => friend.user.online).toList();

for (var friend in onlineFriends) {
    final content = {
        message: 'Hey ${friend.username}, wanna join the party?!',
        partyId: party.id,
    };

    final channel = await socket.joinChannel(
        target: friend.id,
        type: ChannelType.directMessage,
    );
    final messageAck = await socket.sendMessage(
        channelId: channel.id,
        content: content,
    );
}

Joining parties #

Safi-shi players can join parties from chat messages by checking for the party id in the message:

1
2
3
4
5
6
7
socket.onChannelMessage.listen((channelMessage) {
    final content = jsonDecode(channelMessage.content);

    if (content.containsKey('partyId')) {
        socket.joinParty(content['partyId']);
    }
});

Leaving parties #

Sagi-shi players can leave parties:

1
await socket.leaveParty(party.id);

Matchmaking with parties #

One of the main benefits of joining a party is that all the players can join the matchmaking pool together.

Sagi-shi players can listen to the the matchmaker matched event and join the match when one is found:

1
2
3
socket.onMatchmakerMatched.listen((event) {
    socket.joinMatch(event.matchId!);
});

The party leader will start the matchmaking for their party:

1
2
3
4
5
6
7
8
9
const minPlayers = 2;
const maxPlayers = 10;

final matchmakerTicket = await socket.addMatchmakerParty(
    partyId: '<PartyId>',
    query: '',
    minCount: minPlayers,
    maxCount: maxPlayers,
);

Sending party data #

Sagi-shi players can send data to other members of their party to indicate they wish to start a vote.

 1
 2
 3
 4
 5
 6
 7
 8
 9
10
final state = {
    'username': '<Username>',
    'reason': 'Emergency',
};

await socket.sendPartyData(
    partyId: party.id,
    opCode: OpCodes.partyCallVote,
    data: jsonEncode(state).codeUnits,
);

Receiving party data #

Sagi-shi players can receive party data from other party members by subscribing to the party data event.

 1
 2
 3
 4
 5
 6
 7
 8
 9
10
11
12
13
14
socket.onPartyData.listen((event) {
    switch (event.opCode) {
        case OpCodes.partyCallVote:
            // Get the vote data
            final stateJson = String.fromCharCodes(event.data);
            final voteState = jsonDecode(stateJson);

            // Show a UI dialogue - "<username> has proposed to call a vote for <reason>. Do you agree? Yes/No"
            break;
        default:
            print('Unsupported opcode');
            break;
    }
});

Leaderboards #

Nakama Leaderboards introduce a competitive aspect to your game and increase player engagement and retention.

Sagi-shi has a leaderboard of weekly imposter wins, where player scores increase each time they win, and similarly a leaderboard for weekly crew member wins.

Sagi-shi leaderboard screen — Sagi-shi Leaderboard

Creating leaderboards #

Leaderboards have to be created on the server, see the leaderboard documentation for details on creating leaderboards.

Submitting scores #

When players submit scores, Nakama will increment the player’s existing score by the submitted score value.

Along with the score value, Nakama also has a subscore, which can be used for ordering when the scores are the same.

Sagi-shi players can submit scores to the leaderboard with contextual metadata, like the map the score was achieved on:

 1
 2
 3
 4
 5
 6
 7
 8
 9
10
11
const score = 1;
const subscore = 0;
final metadata = {'map': 'space_station'};

await client.writeLeaderboardRecord(
    session: session,
    leaderboardName: 'weekly_imposter_wins',
    score: score,
    subscore: subscore,
    jsonEncode(metaData),
);

Listing the top records #

Sagi-shi players can list the top records of the leaderboard:

 1
 2
 3
 4
 5
 6
 7
 8
 9
10
11
12
13
14
15
const limit = 20;
final leaderboardName = 'weekly_imposter_wins';

final result = await client.listLeaderboardRecords(
    session: session,
    leaderboardName: leaderboardName,
    ownerIds: null,
    expiry: null,
    limit: limit,
    cursor: null,
);

for (var record in result.records) {
    print('${record.ownerId}: ${record.score}');
}

Listing records around the user

Nakama allows developers to list leaderboard records around a player.

Sagi-shi gives players a snapshot of how they are doing against players around them:

 1
 2
 3
 4
 5
 6
 7
 8
 9
10
11
12
13
const limit = 20;
const leaderboardName = 'weekly_imposter_wins';
final result = await client.listLeaderboardRecordsAroundOwner(
    session: session,
    leaderboardName: leaderboardName,
    ownerId: session.userId,
    expiry: null,
    limit: limit,
);

for (var record in result.Records) {
    print('${record.ownerId}: ${record.score}');
}

Listing records for a list of users

Sagi-shi players can get their friends’ scores by supplying their user ids to the owner id parameter:

 1
 2
 3
 4
 5
 6
 7
 8
 9
10
11
12
13
14
15
16
17
18
final friendsList = await client.listFriends(
    session: session,
    friendshipState: FriendshipState.mutual,
    limit: 100,
);
final userIds = friendsList.friends.map((e) => e.user.id).toList();
final recordList = await client.listLeaderboardRecords(
    session: session,
    leaderboardName: 'weekly_imposter_wins',
    ownerIds: userIds,
    expiry: null,
    limit: 100,
    cursor: null,
);

for (var record in recordList.records) {
    print('${record.username} scored ${record.score}');
}

The same approach can be used to get group member’s scores by supplying their user ids to the owner id parameter:

 1
 2
 3
 4
 5
 6
 7
 8
 9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
final groupUserList = await client.listGroupUsers(
    session: session,
    groupId: '<GroupId>',
    state: null,
    limit: 100,
    cursor: null,
);

final userIds = groupUserList.groupUsers
    .where((x) => x.state.index < 3)
    .map((g) => g.user.id)
    .toList();

final recordList = await client.listLeaderboardRecords(
    session: session,
    leaderboardName: 'weekly_imposter_wins',
    ownerIds: userIds,
    expiry: null,
    limit: 100,
    cursor: null,
);

for (var record in recordList.records) {
    print('${record.username} scored ${record.score}');
}

Deleting records #

Sagi-shi players can delete their own leaderboard records:

1
2
3
4
await client.deleteLeaderboardRecord(
    session: session,
    leaderboardId: '<LeaderboardId>',
);

Tournaments #

Nakama Tournaments are short lived competitions where players compete for a prize.

Sagi-shi players can view, filter and join running tournaments.

Sagi-shi tournaments screen — Sagi-shi Tournaments

Creating tournaments #

Tournaments have to be created on the server, see the tournament documentation for details on how to create a tournament.

Sagi-shi has a weekly tournament which challenges players to get the most correct imposter votes. At the end of the week the top players receive a prize of in-game currency.

Joining tournaments #

By default in Nakama players don’t have to join tournaments before they can submit a score, but Sagi-shi makes this mandatory:

1
2
3
4
await client.joinTournament(
    session: session,
    tournamentId: '<TournamentId>',
);

Listing tournaments #

Sagi-shi players can list and filter tournaments with various criteria:

 1
 2
 3
 4
 5
 6
 7
 8
 9
10
11
12
13
14
15
16
const categoryStart = 1;
const categoryEnd = 2;
const limit = 100;
final result = await client.listTournaments(
    session: session,
    categoryStart: categoryStart,
    categoryEnd: categoryEnd,
    startTime: null,
    endTime: null,
    limit: limit,
    cursor: null,
);

for (var tournament in result.tournaments) {
    print('${tournament.id}:${tournament.title}');
}

For performance reasons categories are filtered using a range, not individual numbers. Structure your categories to take advantage of this (e.g. all PVE tournaments in the 1XX range, all PVP tournaments in the 2XX range, etc.).

Listing records #

Sagi-shi players can list tournament records:

 1
 2
 3
 4
 5
 6
 7
 8
 9
10
11
12
13
14
const limit = 20;
const tournamentName = "weekly_top_detective";
final result = await client.listTournamentRecords(
    session: session,
    tournamentId: tournamentName,
    ownerIds: null,
    expiry: null,
    limit: limit,
    cursor: null,
);

for (var record in result.records) {
    print('${record.ownerId}:${record.score}');
}

Listing records around a user

Similarly to leaderboards, Sagi-shi players can get other player scores around them:

 1
 2
 3
 4
 5
 6
 7
 8
 9
10
11
12
13
14
const limit = 20;
const tournamentName = 'weekly_top_detective';

final result = await client.listTournamentRecordsAroundOwner(
    session: session,
    tournamentId: tournamentName,
    ownerId: session.userId,
    expiry: null,
    limit: limit,
);

for (var record in result.records) {
    print('${record.ownerId}:${record.score}');
}

Submitting scores #

Sagi-shi players can submit scores, subscores and metadata to the tournament:

 1
 2
 3
 4
 5
 6
 7
 8
 9
10
11
const score = 1;
const subscore = 0;
final metadata = {'map': 'space_station'};

await client.writeTournamentRecord(
    session: session,
    tournamentId: 'weekly_top_detective',
    score: score,
    subscore: subscore,
    metadata: jsonEncode(metadata),
);

Notifications #

Nakama Notifications can be used for the game server to broadcast real-time messages to players.

Notifications can be either persistent (remaining until a player has viewed it) or transient (received only if the player is currently online).

Sagi-shi uses Notifications to notify tournament winners about their winnings.

Sagi-shi notification screen — Sagi-shi notifications

Receiving notifications #

Notifications have to be sent from the server.

Nakama uses a code to differentiate notifications. Codes of 0 and below are system reserved for Nakama internals.

Sagi-shi players can subscribe to the notification received event. Sagi-shi uses a code of 100 for tournament winnings:

 1
 2
 3
 4
 5
 6
 7
 8
 9
10
11
12
13
socket.onNotifications.listen((notification) {
    const int rewardCode = 100;

    switch (notification.code) {
        case rewardCode:
            print(
                'Congratulations, you won the tournament!\n${notification.subject}\n${notification.content}');
            break;
        default:
            print('Other notification: ${notification.code}:${notification.subject}\n${notification.content}');
            break;
    }
});

Listing notifications #

Sagi-shi players can list the notifications they received while offline:

 1
 2
 3
 4
 5
 6
 7
 8
 9
10
const limit = 100;
final result = await client.listNotifications(
    session: session,
    limit: limit,
    cursor: null,
);

for (var notification in result.notifications) {
    print('Notification: ${notification.code}:${notification.subject}\n${notification.content}');
}

Pagination and cacheable cursors

Like other listing methods, notification results can be paginated using a cursor or cacheable cursor from the result.

1
prefs.setString('nakama.notificationsCacheableCursor', result.cursor);

The next time the player logs in the cacheable cursor can be used to list unread notifications.

1
2
3
4
5
6
final cacheableCursor = prefs.getString('nakama.notificationsCacheableCursor');
final nextResults = await client.listNotifications(
    session: session,
    limit: limit,
    cursor: cacheableCursor,
);

Deleting notifications #

Sagi-shi players can delete notifications once they’ve read them:

1
2
3
4
await client.celeteNotifications(
    session: session,
    notificationIds: ['<NotificationId>'],
);

Deploy Nakama and Satori

Company

Powering Gray Zone Warfare to Early Success: MADFINGER Games and Heroic Labs

Halfbrick Studios: Rebuilding and Relaunching Magic Brick Wars

Heroic Labs and Zynga launch Star Wars: Hunters

Download and Install Nakama OSS

Learn how to use Nakama

Nakama Dart Client Guide #

Prerequisites #

Full API documentation #

Installation #

Updates #

Nakama Socket #

Handling exceptions #

Getting started #

Nakama Client #

Nakama Socket #

Authentication #

Device authentication #

Facebook authentication #

Custom authentication #

Linking authentication #

Session variables #

Session lifecycle #

Ending sessions #

User accounts #

Get the user account #

Update the user account #

Getting users #

Storing metadata #

Reading metadata #

Wallets #

Accessing wallets #

Updating wallets #

Validating in-app purchases #

Storage Engine #

Reading storage objects #

Writing storage objects #

Conditional writes #

Listing storage objects #

Paginating results #

Protecting storage operations on the server #

Remote Procedure Calls #

Creating server logic #

Client RPCs #

Socket RPCs #

Friends #

Adding friends #

Friendship states #

Listing friends #

Accepting friend requests #

Deleting friends #

Blocking users #

Status & Presence #

Follow users #

Unfollow users #

Updating player status #

Groups #

Creating groups #

Update group visibility #

Update group size #

Listing and filtering groups #

Deleting groups #

Group metadata #

Group membership states #

Joining a group #

Listing the user’s groups #

Listing members #

Accepting join requests #

Promoting members #

Demoting members #

Kicking members #

Banning members #

Leaving groups #

Chat #

Joining dynamic rooms #

Joining group chat #

Joining direct chat #

Sending messages #

Listing message history #