@casual-simulation/aux-vm-client

AUX VM Client

A set of utilities required to run an AUX as a client.

Installation

npm install @casual-simulation/aux-vm-client

Usage

Create a custom channel implementation

import { RemoteAuxChannel } from '@casual-simulation/aux-vm-client';
import { AuxUser, AuxConfig } from '@casual-simulation/aux-vm';

export class MyCustomChannel extends RemoteAuxChannel {

    constructor(defaultHost: string, user: AuxUser, config: AuxConfig) {
        super(defaultHost, user, config, {});
    }

    // Override the _handleServerEvents function
    // to handle events sent from a remote device.
    protected async _handleServerEvents(events: DeviceAction[]) {
        await super._handleServerEvents(events);
        let filtered = events.filter(
            e => e.device.roles.indexOf(SERVER_ROLE) >= 0
        );
        let mapped = <BotAction[]>filtered.map(e => e.event);
        if (filtered.length > 0) {
            await this.sendEvents(mapped);
        }
    }
}

Changelog

V2.0.36

Date: 2/4/2022

:rocket: Improvements

• Added global search to the systemPortal.
  • Useful for finding a word or phrase in the tags of all the bots in an inst.
  • For example, you can find all the places where a shout occurrs by typing "shout" into the search box.
  • Can be accessed by using Ctrl+Shift+F while the systemPortal is open or by selecting the eyeglass icon on the left side of the screen.
• Added the ability to use a video camera feed as the portal background.
  • You can enable this feature by setting portalBackgroundAddress to casualos://camera-feed.
  • It also supports specifying the rear or front facing cameras with casualos://camera-feed/rear and casualos://camera-feed/front.

:bug: Bug Fixes

• Fixed an issue with custom apps where HTML changes would stop propagating if an element was added to its own parent.
  • This could happen via using the HTML document API like:

    // in @onSetupApp
    const parent = that.document.createElement('div');
    const child = that.document.createElement('span');
    parent.appendChild(child);
    parent.appendChild(child); // This would cause the issue
    

  • Alternatively, it could happen when using os.compileApp().
    • For efficiency, os.compileApp() uses a change detection algorithm to limit the number of HTML elements it needs to create.
    • In some cases, it saw that it could reuse an HTML element by moving it and this happened to trigger the bug in the system that records these changes.