Vircadia Web SDK

The Vircadia Web SDK (codename Ananke) is a JavaScript SDK for developing web-based clients for virtual worlds powered by Vircadia. Vircadia domain servers provide the worlds (a.k.a. "domains") to visit, and the Vircadia metaverse server provides global services that connect the users and domains. See the user docs to Understand the Architecture.

This SDK provides interfaces to:

• Connect to domains.
• Use metaverse services.

The SDK is written in TypeScript.

• Project Configuration
• Coding Standard

To learn more about using Vircadia and exploring the metaverse, see the User Documentation.

For scripting API documentation, see the Vircadia API Reference.

Prerequisites

Node.js version ≥ 10.13 ; LTS version ≥ 14.16 recommended
npm version ≥ 6.4.1 ; LTS version ≥ 6.14 recommended

https://nodejs.org/en/download/

Jest is used for unit testing. It is included as an NPM dev dependency, however, you may also install it globally if you want to. https://jestjs.io/.

Project setup

npm install

Compile and minify for production

npm run build

Hot-recompile for development

npm run watch

Clean the build directory

npm run clean

Lint files

All files:

npm run lint

A specific directory or file:

npm run lint-path <path>

Run tests

Unit tests can be run without any external dependencies but integration tests require a domain server to be running on localhost or other location specified in test.config.json.

All tests:

npm run test

Hot retest of all tests:

npm run test-watch

Specific tests (e.g., Packet.unit.test.js, all unit tests, all integration tests):

npm run test <partial-path>

npm run test /packet.unit
npm run test .unit.
npm run test .integration.

Run tests and report open handles:

npm run test-debug [<partial-path>]

Generate docs

SDK API documentation:

npm run sdkdoc

Developer documentation (includes SDK API documentation):

npm run devdoc