Skip to main content

Web SDK

The Inworld Web SDK consists of several Typescript/Node.js based packages that can be used to create web applications that connect your Inworld characters to a web browser.

The source code for the packages along with the example projects can be downloaded from GitHub here.

To get started with the Web SDK we recommend you review our example projects below and also the Quick Start guide, which covers setting up the Generate Token authenication server project required by the other example projects.


Packages:

Package NameDescription
web-coreThe web-core package is the base package all other Web SDK packages extend from. The package is used to create character sessions, capture user's audio stream, send text messages, send triggers and render conversation history.
web-threejsThe web-threejs package can be used to easily add the Inworld Innequin and Ready Player Me avatars to your Three.js based applications.

Example Projects:

Project NameDescription
Generate TokenThe Generate Token project is a Node 16+ sample authentication server for generating session tokens required by web clients to begin a chat. It is required by all our other web based example projects.
ChatThe Chat React based project quickly connects your Inworld character to a web interface for communication via text, Innequin and a Ready Player Me character coversation.
Threejs - InnequinThe Three.js - Innequin React based project demostrates how to use the web-threejs package to easily integrate an Innequin character into your Three.js project.
Threejs - Ready Player MeThe Three.js - Ready Player Me React based project demostrates how to use the web-threejs package to easily integrate a Ready Player Me character into your Three.js project.

Note: All example projects require the Generate Token authentication server to be running.