@casual-simulation/aux-vm

AUX VM

A set of abstractions and common utilities required to run an AUX on any platform.

Installation

npm install @casual-simulation/aux-vm

Usage

Create a custom simulation class

import { BaseSimulation, AuxVM } from '@casual-simulation/aux-vm';

// Simulations are wrappers for an
// AuxVM + AuxChannel combo.
// They make all the capabilities of an AUX easy to access
// and understand.
export class MySimulation extends BaseSimulation {
    constructor(
        id: string, // The ID of the
        config: { isBuilder: boolean; isPlayer: boolean }
    ) {
        super(id, config, config => new MyAuxVM(config));
    }
}

// An AUX VM is in charge of separating
// the consumer from the AUX Environment.
// Basically its a security barrier between an AUX and the consumer code.
// On Web Browsers, this is usually implemented via web workers and sandboxed iframes.
// On Node.js, this is implemented via a custom script sandbox.
// Below, you can implement your own VM.
export class MyAuxVM implements AuxVM {
    // TODO: Implement
}

Changelog

V0.11.25

Date: 1/31/2020

Changes:

:boom: Breaking Changes

• Replaced the @onPlayerEnterDimension listener with @onPlayerPortalChanged.
  • @onPlayerPortalChanged is called whenever any portal changes whereas @onPlayerEnterDimension was only called for auxPagePortal.
  • Additionally, this fixes some of the issues that @onPlayerEnterDimension ran into.
• Changed the Webhook URLs to the new URL scheme.
  • Instead of https://auxplayer.com/{dimension}/{universe} you should use https://auxplayer.com/webhook?auxUniverse={universe}

:rocket: Features

• Added the ability to click a Bot ID in the sheet to copy it.

:bug: Bug Fixes

• Fixed an issue that prevented the portals from reverting to default values if the config bot for the portal was cleared.