Rendley SDK

Appearance

Engine ​

The Engine is the main entry point for our SDK. It is a singleton instance, ensuring that only one instance of the Engine exists at any given time.

It is responsible for initializing the SDK, serializing the project's output, loading new projects, and providing getters for easy access to other parts of the system.

Initialization ​

To initialize the Engine, you need to provide a license and a display configuration. You can obtain a license by visiting our website.

typescript
import { Engine } from "@rendley/sdk";

const engine = Engine.getInstance().init({
  license: {
    licenseName: "YOUR_LICENSE_NAME",
    licenseKey: "YOUR_LICENSE_KEY",
  },
  display: {
    width: 1920,
    height: 1080,
    backgroundColor: "#000000",
  }
});

WARNING

Initializing the Engine is a mandatory step before using the SDK. However, initializing it multiple times without destroying the previous instance will result in an error.

Destroying ​

Because the Engine is a singleton, there will always be a single instance available in memory. For use cases where you want to reset the state of the SDK, you can use the destroy method.

typescript
Engine.getInstance().destroy();

If you want to destroy all underlying modules, reset the WebGL context, unload fonts, and destroy storage providers, you can do it like this:

typescript
Engine.getInstance().destroy(true);

License Validation ​

The SDK performs license validation directly on the device, eliminating concerns about server downtime or latency during the validation process.

Local Validation ​

The easiest way to utilize the license is to specify the licenseName and licenseKey during license initialization. The primary disadvantage is that you must update the license with every payment cycle.

typescript
const engine = Engine.getInstance().init({
  license: {
    licenseName: "YOUR_LICENSE_NAME",
    licenseKey: "YOUR_LICENSE_KEY",
  },
  ...
});

Remote Validation ​

Remote validation is designed for companies that prefer not to manually update the license key with every payment cycle. In these scenarios, you can enable enableRemoteValidation during license initialization, which will use our server to retrieve the current license key. If the endpoint fails to return data, the system will fall back to the license key specified during initialization.

typescript
const engine = Engine.getInstance().init({
  license: {
    enableRemoteValidation: true,
    licenseName: "YOUR_LICENSE_NAME",
    licenseKey: "YOUR_LICENSE_KEY", // Optional
  },
  ...
});

Sublicense Validation ​

Sublicense validation is intended for companies using the SDK across multiple subdomains. In such cases, you can enable isSublicense during license initialization, allowing the system to retrieve the corresponding license.

typescript
const engine = Engine.getInstance().init({
  license: {
    enableRemoteValidation: true,
    isSublicense: true,
    licenseName: "YOUR_LICENSE_NAME",
  },
  ...
});

INFO

If you need to support multiple subdomains, please contact us at support@rendley.com for assistance in setting it up.