Installation
atmoky Engage comes as two node.js (opens in a new tab) packages that can be
installed with
npm. The Client SDK is in charge of spatial rendering and handling
WebRTC connections in the background. The Server SDK handles access token creation.Setup npm
The SDKs are provided as part of a private node package registry. The following
snippet shows how to configure
npm so it knows where to look for the packages.# let npm know where to find @atmokyaudio packages
npm config set @atmokyaudio:registry https://gitlab.com/api/v4/projects/44752760/packages/npm/
# add access token
npm config set -- "//gitlab.com/api/v4/projects/44752760/packages/npm/:_authToken" "<your_package_registry_token>"Alternatively, you can directly edit your
npmrc (opens in a new tab) config file
(~/.npmrc or C:\Users\<user>\.npmrc) and add the following lines:@atmokyaudio:registry=https://gitlab.com/api/v4/projects/44752760/packages/npm/
//gitlab.com/api/v4/projects/44752760/packages/npm/:_authToken=<your_package_registry_token>When using
bun as a package manager you can add the following lines to your ~/.bunfig.toml file:[install.scopes]
"@atmokyaudio" = { token = "<your_package_registry_token>", url = "https://gitlab.com/api/v4/projects/44752760/packages/npm/" }💡
In order to obtain an access token for the package registry, please contact
sales (opens in a new tab).
These tokens are for gaining access to the package registry only and should
not be confused with the authentication tokens needed for regular use of
atmoky Engage. The latter have to be created with Engage Server SDK.
Client Setup
Install the Client SDK
npm install @atmokyaudio/engage-clientImport the Client SDK
import { Space } from "@atmokyaudio/engage-client";Server Setup
Install the Server SDK
npm install @atmokyaudio/engage-server-sdkImport the Server SDK
import { AccessToken } from "@atmokyaudio/engage-server-sdk";