@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

V3.3.6

Date: 6/14/2024

:rocket: Features

• Casual Simulation is now PRIVO Certified!
  • The certification seal has been added in various locations to notify users that Casual Simulation, ab1.bot, and publicos.link are COPPA Safe Harbor Certified.
• Added the ability to record and display Loom videos from within CasualOS.
  • NOTE: Loom requires access to the MediaRecorder API and third party cookies. In testing, if third party cookies are not allowed, the Loom SDK will silently fail to work.
  • loom.recordVideo(options) - A function that can be used to start the recording process. Resolves with a promise that includes information about the recorded video.
    • options is an object with one of the following properties:
      • publicAppId - The public app ID of the loom app that the video should be associated with.
      • recordName - The name of the record that the video should be associated with. The studio for the record needs to have loom features enabled and also be configured with a loom public app ID and private key.
  • loom.watchVideo(url) - A function that can be used to load and watch the given loom video.
  • loom.getVideoEmbedMetadata(url) - A function that can be used to load additional information about a video that can be used to embed the video.
• Moved pinned tags in systemPortal to appear above the tags list.
• Pressing Enter while a tag is focused in the system portal now triggers the "New Tag" dialog.