@casual-simulation/aux-common

AUX Common

A library that contains common operations needed to modify and understand AUX files.

Installation

$ npm install @casual-simulation/aux-common

Usage

Calculate a formula for some bots

import {
    createBot,
    createCalculationContext,
    calculateFormulaValue,
} from '@casual-simulation/aux-common';

const file1 = createBot('test1', {
    quantity: 10,
});
const file2 = createBot('test2', {
    quantity: 5,
});
const file3 = createBot('test3', {
    quantity: 5,
});

const context = createCalculationContext([file1, file2, file3]);

const formula = '=math.sum(getBotTagValues("#quantity"))';
const result = calculateFormulaValue(context, formula);

console.log(result);

// Outputs:
// 20

Calculate events for an action script

import {
    createBot,
    createCalculationContext,
    calculateFormulaEvents,
} from '@casual-simulation/aux-common';

const state = {
    test1: createBot('test1', {
        quantity: 10,
    }),
    test2: createBot('test2', {
        quantity: 5,
    }),
    test3: createBot('test3', {
        quantity: 5,
    }),
};

const formula = `
    let total = math.sum(getBotTagValues("#quantity"));
    player.toast("The total is " + total);
`;
const events = calculateFormulaEvents(state, formula);

for (let event of events) {
    if (event.type === 'local') {
        if (event.name === 'show_toast') {
            console.log('[Toast]', event.message);
        }
    }
}

// Outputs:
// [Toast] The total is 5

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().