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

Date: 2/11/2020

Changes:

:robot: Builder Improvements

• Making a clone of a bot now puts builder into palette mode.
• Dragging a bot into builder no longer changes builder's color to white.
• Added the .help command to show a list of available commands.
• Added the .sleep command to the helper builder menu.
• Added the "Go to Builder Dimension` menu action.
• Added a "Show Join Code" menu item to show a QR Code to quickly join.
• Waking builder will automatically summon it to the current dimension.
• Clicking in an empty space when builder is awake will summon him to the clicked space.
• Made the main builder flat.
• Builder is now enabled by default in new universes.
• Added the "Restore Mark" menu item to restore history to the selected history mark.
• Simplified a bunch of examples.

:rocket: Other Features

• Added the player.showJoinCode() function to quickly show a QR Code to join a universe.
• Made the chat bar auto-focus when it is first shown.

:bug: Bug Fixes

• Fixed an issue that would cause the URL portal tag sync to break, this in turn also caused @onPlayerPortalChanged events to not be sent.
  • This is also the issue that caused the inventory portal colors to not update.
• Fixed an issue that would cause the tag autocomplete list to stop showing tags when an invalid tag was entered.