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

Date: 10/28/2019

Changes:

• Improvements
  • Improved the vendor JavaScript bundle size by removing unused code.
    • Refactored three-vrcontroller-module to use the three package instead of three-full so we don't duplicate Three.js.
    • Removed unused shims (PEP.js, webrtc-adapter).
    • Refactored lodash imports to directly import the modules that are used.
      • This helps with dead code eliminiation.
  • Added the ability to save and load files.
    • New functions:
      • server.saveFile(filename, data, options)
        • filename is a string and should start with /drives/.
        • data is a string of the data to store.
        • options is an object with the following properties:
          • callbackShout A shout that should happen on the server when the file is done saving.
          • overwriteExistingFile A boolean that indicates if existing files should be overwritten. (defaults to false)
      • server.loadFile(filename, options)
        • filename is a string and should start with /drives/.
        • options is an object with the following properties:
          • callbackShout A shout that should happen on the server when the file is done loading.
    • Note that the save file and load file tasks must be enabled via the onAnyAction() listener.
      • You can enable it via using this code:

      if (that.action.type === 'device') {
          if (
              ['save_file', 'load_file'].indexOf(
                  that.action.event.type
              ) >= 0
          ) {
              action.perform(that.action.event);
          }
      }
      

    • All files from USB drives are stored under the /drives directory and the USB drives themselves are numbered starting with 0.
      • To load a file from USB drive #1, use server.loadFile("/drives/0/myFile").
      • To save a file to USB drive #2, use server.saveFile("/drives/1/myFile", data).
  • Removed several options from the side menu:
    • Removed the channel name from the top of the menu.
    • Removed the login status from the top of the menu.
    • Removed the login/logout options from the menu.
      • The "Logout" option will still be available if you are logged in as a non-guest.
      • Once you are logged out, then the option will dissapear.
    • Removed the "Add Channel" option from the menu in AUXPlayer.
• Bug Fixes
  • Fixed an issue that prevented the removeTags() function from working when given an array of bots.