open-index/open-npm huggingface dataset:
npm package: @heroiclabs/nakama-js-protobuf
Description: Websocket adapter adding protocol buffer support to the Nakama Javascript client.
Author: Chris Molozian
Latest version: 1.4.0

Nakama JavaScript Protobuf adapter
========================

> Websocket adapter adding protocol buffer support to the [nakama-js](https://www.npmjs.com/package/@heroiclabs/nakama-js) client.

[Nakama](https://github.com/heroiclabs/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](https://heroiclabs.com).


## Getting Started

1. Import the adapter into your project:

    ```shell
    yarn add "@heroiclabs/nakama-js-protobuf"
    ```

2. Pass the Protobuf adapter to build the socket object.

    ```js
    import {Client} from "@heroiclabs/nakama-js";
    import {WebSocketAdapterPb} from "@heroiclabs/nakama-js-protobuf"

    const useSSL = false; // Enable if server is run with an SSL certificate.
    const client = new Client("defaultkey", "127.0.0.1", 7350, useSSL);

    const trace = false;
    const socket = client.createSocket(useSSL, trace, new WebSocketAdapterPb());
    ```

3. Use the WebSocket:

    ```js
    socket.ondisconnect = (evt) => {
        console.info("Disconnected", evt);
    };

    const session = await socket.connect(session);
    // Socket is open.
    ```

### License

This project is licensed under the [Apache-2 License](https://github.com/heroiclabs/nakama-js/blob/master/LICENSE).