Installation & Setup

Installation

Methods for installing the package differs for each game engine. For games building browser games (using Javascript), you can install the package as follows:

npm install nrn-agents

For studios that use Unity or Unreal engine, please directly message an NRN team member to get access to the package.

Setup

In order to start using the SDK, you will need to set your apiKey and gameId as static attributes on the AgentFactory class (in Javascript) or ModelWrapper class (in C#). Each apiKey only works for a specific gameId.

Javascript

const { AgentFactory } = require('nrn-agents');

AgentFactory.setApiKey("my-api-key");
AgentFactory.setGameId("my-game-id");

C# - Unity

Now that you have your apiKey and gameId set, every HTTP request you make to the NRN Agents server will automatically use it.

Additional Files

In order for the NRN Agents SDK to know how to communicate with a game, we need to add 2 files. These files will define the state space and action space, which we begin to discuss in the basic integration section.

Javascript Structure

It is advised that game studios make an nrn-integration folder inside their helpers folder. Inside this folder, we need to add the files to define the state and action space.

.
└── src/
    └── helpers/
        └── nrn-integration/
            ├── nrn-state-space.js
            └── nrn-action-space.js

Unity Structure

It is advised that game studios make an NrnIntegration folder inside theScript folder. Inside this folder, we need to add the files to define the state and action space.

.
└── Assets/
    └── Scripts/
        └── NrnIntegration/
            ├── NrnStateSpace.cs
            └── NrnActionSpace.cs

Unreal Structure

It is advised that game studios make an NrnIntegration folder inside the folder where they have all their game code. Inside this folder, we need to add the files to define the state and action space.

.
└── Source/
    └── Game/
        └── NrnIntegration/
            ├── NrnStateSpace.cpp
            ├── NrnStateSpace.h
            ├── NrnActionSpace.cpp
            └── NrnActionSpace.h