@casual-simulation/aux-vm

AUX VM

A set of abstractions and common utilities required to run an AUX on any platform.

Installation

npm install @casual-simulation/aux-vm

Usage

Create a custom simulation class

import { BaseSimulation, AuxVM } from '@casual-simulation/aux-vm';

// Simulations are wrappers for an
// AuxVM + AuxChannel combo.
// They make all the capabilities of an AUX easy to access
// and understand.
export class MySimulation extends BaseSimulation {
    constructor(
        id: string, // The ID of the
        config: { isBuilder: boolean; isPlayer: boolean }
    ) {
        super(id, config, config => new MyAuxVM(config));
    }
}

// An AUX VM is in charge of separating
// the consumer from the AUX Environment.
// Basically its a security barrier between an AUX and the consumer code.
// On Web Browsers, this is usually implemented via web workers and sandboxed iframes.
// On Node.js, this is implemented via a custom script sandbox.
// Below, you can implement your own VM.
export class MyAuxVM implements AuxVM {
    // TODO: Implement
}

Changelog

V3.3.13

Date: 11/8/2024

:rocket: Features

• Added ai.chat.allowedModels feature to enforce model usage limits, restricting access to specific models based on configuration.

• Added shared documents.

  • Shared documents utilize insts to be able to share data without using bots and tags.

  • Additionally, shared documents can be loaded and unloaded at will.

  • The following functions have been added:

    • os.getSharedDocument(name) - Gets a document that is stored in the current inst.
    • os.getSharedDocument(recordName, inst, name) - Gets a document that is stored in the specified inst.
    • os.getLocalDocument(name) - Gets a document that is stored on this device.
    • os.getMemoryDocument() - Gets a document that is stored in memory and cleared upon refresh.

  • Usage:

    // Get a document stored in this inst named "test"
    const doc = await os.getSharedDocument('test');
    
    // maps work like the Map type (see https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/Map)
    const inventory = doc.getMap<number>('inventory');
    
    inventory.set('spoons', 2);
    inventory.set('forks', 3);
    os.log('Number of spoons: ' + inventory.get('spoons'));
    
    // arrays work like regular JavaScript arrays:
    const shoppingList = doc.getArray<string>('shoppingList');
    shoppingList.push('cereal', 'milk', 'eggs');
    
    os.log('Shopping list:', inventory.toArray());
    
    // Text is a special type that makes it easy to work with long strings
    const blogPost = doc.getText('blogPost');
    
    blogPost.insert(0, 'Hello, world!');
    
    os.log('Blog Post:\n', blogPost.toString());
    

:bug: Bug Fixes

• Fixed an issue where CasualOS would prompt for login when trying to join a room using os.joinRoom().