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

Date: 3/16/2020

Changes:

• :boom: Breaking Changes

  • Both sprites and iframes now face upwards by default.
  • #auxAnchorPoint has been changed to move the bot form inside of its virtual spacing box.
    • Previously, both the virtual box and the bot form was moved to try and preserve the absolute positioning of the bot form when changing anchor points.
    • Now, only the bot form is moved to ensure the correctness of the resulting scale and rotation calculations.
  • #auxOrientationMode
    • Renamed the billboardX option to billboardZ.
  • Changed iframes forms to not support strokes.

• :rocket: Improvements

  • Added the following options for #auxAnchorPoint
    • centerFront - Positions the bot form such that the center of the form's front face is at the center of the virtual bot.
    • centerBack - Positions the bot form such that the center of the form's back face is at the center of the virtual bot.
    • bottomFront - Positions the bot form such that the bottom of the form's front face is at the center of the virtual bot.
    • bottomBack - Positions the bot form such that the bottom of the form's back face is at the center of the virtual bot.
    • top - Positions the bot form such that the top of the form is at the center of the virtual bot.
    • topFront - Positions the bot form such that the top of the form's front face is at the center of the virtual bot.
    • topBack - Positions the bot form such that the top of the form's back face is at the center of the virtual bot.

• :bug: Bug Fixes

  • Fixed issues with scale and rotation when #auxAnchorPoint is set to center.
  • Fixed sprite billboarding issues when looking straight down at them.
  • Fixed an issue where the wrong Z position tag of a bot was used for calculating how bots stack.
  • Fixed an issue where the bot stroke was being considered for collision detection. This caused bots with strokes to have a much larger hit box than they should have had.