Kanda SDK 0.1.1
Loading...
Searching...
No Matches
Installation

Kanda SDK is delivered using a private NPM registry. Users must be authenticated to access this registry, so it requires a few extra steps get it set up.

To use the Kanda SDK, you must have a supported version of Unity installed.

The Kanda Package Registry can be accessed in your browser at https://npm.kanda.dk.

1. Install Node Package Manager

Unity Package Manager uses Node Package Manager, npm, under the hood. Make sure you have Node Package Manager available on your system before proceeding.

2. Add your user to the registry

To add your user to the registry, use the command line:

npm adduser --registry https://npm.kanda.dk

If user registration has been locked down, you may need an authorized Kanda staff to create your user.

3. Log in to the registry

Next, you need to log in to the Kanda Package Registry so we can retrieve an authorization token.

npm login --registry https://npm.kanda.dk

4. Set up registry authentication for Unity

In order for Unity Package Manager to communicate with the registry, you need to copy your credentials from the npm login process to the .upmconfig.toml file.

For detailed instructions, follow Unity's guide for scoped registry authentication.

On MacOS, this process might look something like:

# Read the npmrc file after login
$ cat ~/.npmrc
# Outputs: //npm.kanda.dk/:_authToken="my-secret-token"
# Create the UPM config file if it doesn't exist
$ touch ~/.upmconfig.toml
# Edit the UPM config file (any text editor will do)
$ nano ~/.upmconfig.toml
# In the text editor, set up auth with email and token like so:
[npmAuth."https://npm.kanda.dk"]
email = "my@email.com"
token = "my-secret-token"
alwaysAuth = true

5. Add the registry to your Unity project

Before Kanda packages can be discovered, you must open the Package Manager Settings (Project Settings > Package Manager) and set up the Kanda Package Registry as a scoped registry:

Name: Kanda Package Registry
URL: https://npm.kanda.dk
Scope(s): com.kanda

6. Install the package

To install the package, open the Package Manager window (Window > Package Manager) and do one of the following:

  • Add the Kanda SDK package from My Registries.
  • Add the Kanda SDK package by name (com.kanda.sdk).