@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.10.4

Date: 10/08/2019

Changes:

• Improvements
  • Added onAnyAction() action tag to intercept and change actions before they are executed.
    • onAnyAction() runs for every action, including when a bot is created, changed, or deleted.
    • Every action is an object with a type property.
      • The type property is a string that indicates what the action does.
      • Here is a partial list of types:
        • add_bot: A bot should be added (i.e. created).
        • remove_bot: A bot should be removed (i.e. deleted).
        • update_bot: A bot should be updated.
        • apply_state: The given bot state should be applied. (i.e. a set of bots should be created/updated)
        • shout: A shout should be executed.
        • show_toast: A toast message should be shown on the device.
        • show_barcode: A barcode should be shown.
        • tween_to: The camera should be tweened to show a bot.
    • that is an object with the following properties:
      • action: The action that is going to be executed.
    • Forking a channel clears the onAnyAction() on the config bot.
      • This is so that you can recover from broken states and also gives the person who forked the AUX full control over the fork.
  • Added two new script functions:
    • action.reject(action): Prevents the given action from being performed. Returns the rejection action.
    • action.perform(action): Adds the given action to the performance queue so it will be performed. This can be used to re-enable an action after it has been rejected (you can also reject the rejection action). Returns the action that will be performed.
  • Added a local bot which is stored in the browser's local storage.
    • The local bot is a bot that is unique to the device and channel.
    • You can access the bot by querying for it: getBot("#id", "local").
  • Renamed onShout() to onAnyListen().
  • Added onListen() which is an alternative to onAnyListen() that is only called on the targeted bots.
  • Added ability to set duration of toast, plater.toast("message", durationNum).
  • Made the background for the menu label gray.