@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

V1.0.14

Date: 3/6/2020

Changes:

• :rocket: Features

  • Added wrist portals for WebXR
    • #auxLeftWristPortal is attached to the left controller and #auxRightWristPortal is attached to the right controller.
    • You can configure these portals using the #auxLeftWristPortalConfigBot and #auxRightWristPortalConfigBot tags.
    • The portals are hidden until you look at them. They are placed underneath your wrist like a wristwatch.
    • The following tags are available for configuration:
      • #auxPortalGridScale - Changes the size of the grid for the portal. (Defaults to 0.025 for wrist portals)
      • #auxWristPortalHeight - The height of the portal in grid elements. (Defaults to 6)
      • #auxWristPortalWidth - The width of the portal in grid elements. (Defaults to 6)
    • There are a couple of known issues with wrist portals:
      • 3D Text is sometimes improperly aligned.
      • Lines/Arrows/Walls also have alignment issues.

• :bug: Bug Fixes

  • Fixed an issue that caused the inventory to not appear if it was changed multiple times during the same frame.
  • Fixed an issue that caused the #auxPortalGridScale tag to function improperly.