@casual-simulation/aux-vm - npm Package Versions

V1.1.6

Date: 6/11/2020

Changes:

• :boom: Breaking Changes

  • Renamed all the history tags to not have the aux prefix.

• :rocket: Improvements

  • Added the server.storyPlayerCount() function.
    • Returns a promise that resolves with the number of players currently connected to the current story.
    • Optionally accepts a parameter which indicates the story to check.
  • Added the server.totalPlayerCount() function.
    • Returns a promise that resolves with the total number of players connected to the server.
  • Added the server.stories() function.
    • Returns a promise that resolves with the list of stories that are on the server.

• :bug: Bug Fixes

  • Removed the globals bot tags from the documentation since they no longer exist.

V1.1.5

Date: 6/9/2020

Changes:

• :boom: Breaking Changes

  • The following tags have been renamed:
    • Renamed all the tags so that they no longer have the aux prefix. However, any tag not listed below should continue to work with the aux prefix without any changes.
    • Renamed auxUniverse to story.
    • Renamed auxCreator to creator.
      • Note that the creator variable in scripts remains the same.
    • Renamed auxConfigBot to configBot.
      • Note that the config variable in scripts remains the same.
    • Renamed auxGLTFVersion to gltfVersion.
    • Renamed auxPagePortal to pagePortal.
    • Renamed auxSheetPortal to sheetPortal.
    • Renamed auxInventoryPortal to inventoryPortal.
    • Renamed auxMenuPortal to menuPortal.
    • Renamed auxLeftWristPortal to leftWristPortal.
    • Renamed auxRightWristPortal to rightWristPortal.
    • Renamed auxPagePortalConfigBot to pagePortalConfigBot.
    • Renamed auxSheetPortalConfigBot to sheetPortalConfigBot.
    • Renamed auxInventoryPortalConfigBot to inventoryPortalConfigBot.
    • Renamed auxMenuPortalConfigBot to menuPortalConfigBot.
    • Renamed auxLeftWristPortalConfigBot to leftWristPortalConfigBot.
    • Renamed auxRightWristPortalConfigBot to rightWristPortalConfigBot.
    • Renamed _auxEditingBot to _editingBot.
  • Renamed "universe" to "story". The following tags and functions have been affected:
    • auxUniverse -> story
    • onUniverseAction -> onStoryAction
    • onUniverseStreaming -> onStoryStreaming
      • The universe property has been renamed to story
    • onUniverseStreamLost -> onStoryStreamLost
      • The universe property has been renamed to story
    • onUniverseSubscribed -> onStorySubscribed
      • The universe property has been renamed to story
    • onUniverseUnsubscribed -> onStoryUnsubscribed
      • The universe property has been renamed to story
    • player.downloadUniverse() -> player.downloadStory()
    • player.loadUniverse() -> player.loadStory()
      • The action type has been renamed from load_universe to load_story.
    • player.unloadUniverse() -> player.unloadStory()
      • The action type has been renamed from unload_universe to unload_story.
    • player.getCurrentUniverse() -> player.getCurrentStory()
    • player.checkout()
      • The processingUniverse property has been renamed to processingStory.
    • player.showJoinCode()
      • The universe property on the show_join_code action has been renamed to story
    • server.restoreHistoryMark()
      • The universe property on the restore_history_mark action has been renamed to story.
    • server.restoryHistoryMarkToUniverse() -> server.restoreHistoryMarkToStory()
    • server.setupUniverse() -> server.setupStory()
      • The action type has been renamed from setup_universe to setup_story.

• :rocket: Improvements

  • Improved MongoDB to store all atoms for a commit inside the same document. This should improve loading performance since MongoDB will only need to make 1 lookup per universe instead of 1 lookup per atom per universe.
  • Added admin space.
    • Admin space is a space that is shared between all universes on the same auxPlayer.
    • It is locked by default, which means that bots that are in it cannot be created, updated, or destroyed.
    • You can unlock admin space by using the adminSpace.unlock(password) function.
      • It returns a Promise that resolves once the space is unlocked. If the space was unable to be unlocked, then the promise will reject with an error.
      • password is the password that should be used to unlock the admin space. If incorrect, admin space will remain locked.
  • Removed the CasualOS tagline from the loading popup.
  • Improved the webhook() and webhook.post() functions to return promises.
    • The promise can be awaited and resolves with the an an object with the following properties:
      • data - The data returned from the webhook. If the returned data was JSON, then this will be an object. Otherwise, it will be a string.
      • status - The numerical HTTP status code that was returned.
      • statusText - The name of the HTTP status code that was returned.
      • headers - The HTTP headers that were included in the response.
  • Improved the neighboring() function to allow omitting the direction parameter.
    • When omitted, all supported directions will be included.
    • Currently, the supported directions are front, right, back, and left.
    • If an unsupported direction is given, then no bots will be included.
  • Updated the Documentation website to the latest version of Docusaurus.
  • Added the renameTag(bot, originalTag, newTag) function which makes it easy to rename a tag on a bot or list of bots.
    • bot is the bot or list of bots that should have the tag renamed.
    • originalTag is the name of the tag that should be renamed.
    • newTag is the new name that the tag should have.

• :bug: Bug Fixes

  • Fixed an issue where destroying an already destroyed bot would incorrectly destroy an unrelated bot.
  • Fixed an issue where using player.run() to execute an invalid script would cause other actions to fail.
  • Added some extra spacing to labels to help prevent Z-fighting.
  • Fixed toasting bots by converting them to copiable values. This will also allow toasting unconventional arguments like function and error objects.
  • Fixed an issue where the menu would stop repositioning after the inventory portal had been hidden.
  • Fixed an issue where tapping on the screen while in AR would crash the session.
  • Fixed an issue where labels would be positioned incorrectly if #anchorPoint was set to something other than bottom.

V1.1.4

Date: 5/18/2020

Changes:

• :bug: Bug Fixes
  • Fixed an issue where Builder could not be created/updated due to being unable to load .aux files with a version field.

V1.1.2

Date: 5/18/2020

Changes:

• :rocket: Improvements

  • Added the #auxLabelFontAddress tag to allow specifying a custom font for a label.
    • Supports any URL and also the following values:
      • roboto - Specifies that the Roboto font should be used. (default)
      • noto-sans-kr - Specifies that the Noto Sans KR font should be used. This is a Korean-specific font.
    • Supports WOFF and OTF files.
  • Sheet Changes
    • Removed the tag filters.
    • Moved the "Close Sheet" button to be a floating button that is at the lower right corner of the sheet.
    • Changed the "Close Sheet" button icon and changed the tooltip text to "Page Portal".
    • Made the #id tag not clickable.
  • Builder Changes
    • Renamed the "Sheet" and "Sheet New Tab" menu items to "Sheet Portal" and "Sheet Portal New Tab".
    • Made the chat bar not automatically show when opening a menu.

• :bug: Bug Fixes

  • Fixed an issue where updating a bot would not update its raw tags.

V1.1.18

Date: 7/10/2020

Changes:

• :rocket: Improvements

  • Improved the player.run() function to return a promise that can be awaited to get the result of the script (or wait until the script has been executed).
  • Improved the server.loadErrors() function to return a promise that can be awaited to get the list of bots that were loaded.
  • Improved the server.destroyErrors() function to return a promise that resolves once the error bots are destroyed.
  • Improved the server.loadFile() function to return a promise that resolves once the file is loaded.
  • Improved the server.saveFile() function to return a promise that resolves once the file is saved.
  • Improved the server.setupStory() function to return a promise that resolves once the story is setup.
  • Improved the server.browseHistory() function to return a promise that resolves once the history is loaded.
  • Improved the server.markHistory() function to return a promise that resolves once the history is saved.
  • Improved the server.restoreHistoryMark() function to return a promise that resolves once the history is restored.
  • Improved the server.restoreHistoryMarkToStory() function to return a promise that resolves once the history is restored.
  • Added the @onBotAdded and @onAnyBotsAdded listen tags.
    • These are triggered whenever a bot is added to the local story.
    • Note that this is different from @onCreate because you will be notified whenever a bot is added to the state even if it has already been created.
    • An example of this are bots in the otherPlayers space. You cannot create bots in this space but you will be notified via @onBotAdded and @onAnyBotsAdded.
    • @onBotAdded is triggered on the bot that was added. There is no that.
    • @onAnyBotsAdded is triggered on every bot whenever one or more bots are added.
      • that is an object with the following properties:
        • bots - The array of bots that were added.
  • Added the @onAnyBotsRemoved listen tags.
    • These are triggered whenever a a bot is removed from the local story.
    • Note that this is different from @onDestroy because you will be notified whenever a bot is removed from the state even if it has not been explicitly destroyed.
    • An example of this are bots in the otherPlayers space. When another player disconnects no @onDestroy is fired but you will get a @onAnyBotsRemoved.
    • @onAnyBotsRemoved is triggered on every bot whenever one or more bots are removed.
      • that is an object with the following properties:
        • botIDs - The array of bot IDs that were removed.
  • Added the @onBotChanged and @onAnyBotsChanged listen tags.
    • These are triggered whenever a bot is changed in the local story.
    • Note that you will be notified whenever a bot is changed in the state even if it was changed by another player.
    • An example of this are bots in the otherPlayers space. You cannot update bots in this space but you will be notified via @onBotChanged and @onAnyBotsChanged.
    • @onBotChanged is triggered on the bot that was changed.
      • that is an object with the following properties:
        • tags - The list of tags that were changed on the bot.
    • @onAnyBotsAdded is triggered on every bot whenever one or more bots are added.
      • that is an array containing objects with the following properties:
        • bot - The bot that was updated.
        • tags - The tags that were changed on the bot.
  • Added several tags to the player bot:
    • These tags are updated by CasualOS and can be used to query the current state of the input system.
    • Camera Tags
      • These tags contain the position and rotation of the player's camera.
      • You can use this to communicate where the player is to other players.
      • pageCameraPositionX
      • pageCameraPositionY
      • pageCameraPositionZ
      • inventoryCameraPositionX
      • inventoryCameraPositionY
      • inventoryCameraPositionZ
      • pageCameraRotationX
      • pageCameraRotationY
      • pageCameraRotationZ
      • inventoryCameraRotationX
      • inventoryCameraRotationY
      • inventoryCameraRotationZ
    • Pointer Tags
      • These tags contain the position and rotation of the player's pointers.
      • You can use this to tell where the VR controllers are or where the mouse is pointing.
      • mousePointerPositionX
      • mousePointerPositionY
      • mousePointerPositionZ
      • mousePointerRotationX
      • mousePointerRotationY
      • mousePointerRotationZ
      • mousePointerPortal
      • rightPointerPositionX
      • rightPointerPositionY
      • rightPointerPositionZ
      • rightPointerRotationX
      • rightPointerRotationY
      • rightPointerRotationZ
      • rightPointerPortal
      • leftPointerPositionX
      • leftPointerPositionY
      • leftPointerPositionZ
      • leftPointerRotationX
      • leftPointerRotationY
      • leftPointerRotationZ
      • leftPointerPortal
    • Button Tags
      • These tags contain the state of the different buttons.
      • Possible values are:
        • null - Button is not pressed.
        • down - Button was just pressed.
        • held - Button is being held down.
      • mousePointer_left
      • mousePointer_right
      • mousePointer_middle
      • leftPointer_primary
      • leftPointer_squeeze
      • rightPointer_primary
      • rightPointer_squeeze
      • keyboard_[key]
        • Replace [key] with the key that you want the state of.
        • For example use keyboard_a to get the state of the a key.
  • Added the player.getCameraPosition(portal?) function.
    • portal is optional and is the portal (page or inventory) that the camera position should be retrieved for.
    • Returns an object with the following properties:
      • x
      • y
      • z
  • Added the player.getCameraRotation(portal?) function.
    • portal is optional and is the portal (page or inventory) that the camera rotation should be retrieved for.
    • Returns an object with the following properties:
      • x
      • y
      • z
  • Added the player.getPointerPosition(pointer?) function.
    • pointer is optional and is the pointer (mouse, left or right) that the position should be retrieved for.
    • Returns an object with the following properties:
      • x
      • y
      • z
  • Added the player.getPointerRotation(pointer?) function.
    • pointer is optional and is the pointer (mouse, left or right) that the rotation should be retrieved for.
    • Returns an object with the following properties:
      • x
      • y
      • z
  • Added the player.getInputState(controller, button) function.
    • controller is the controller (mousePointer, leftPointer, rightPointer, keyboard or touch) that the button state should be retrieved from.
    • button is the name of the button that should be retrieved.
    • Returns a string containing the state of the button or null if the button is not pressed.
      • "down" means that the button just started to be pressed.
      • "held" means that the button is being held down.
      • null means that the button is not pressed.
  • Added the player.getInputList() function.
    • Returns a list of available inputs that can be used by the player.getInputState() function.

• :bug: Bug Fixes

  • Fixed an issue where toasting recursive objects could break CasualOS.
    • Fixed by storing a map of previously converted objects to avoid reconverting them infinitely.
    • Also improved to gracefully handle objects that are nested too deeply.
  • Fixed an issue with the show input modal where it incorrectly errored sometimes.

V1.1.0

Date: 4/27/2020

Changes:

• :rocket: Improvements

  • Added the autoSelect property to the options in player.showInput() and player.showInputForTags().
    • When set to true, the text in the input box will be automatically selected when the box is displayed.
  • Made the VR pointer line draw all the way to the bot or grid that it is pointing at.
  • Changed the layout of sizing of the history bots so that they are easy to distinguish from each other and the labels fit on the bot.
  • Added the #auxScaleMode tag to control how a custom mesh is scaled to fit inside a bot. It supports the following options:
    • fit - The mesh is scaled to fit inside the bot's unit cube. (default)
    • absolute - The mesh uses whatever scale it originally had.

• :bug: Bug Fixes

  • Fixed LODs in VR.
    • There were two issues:
      • The first was that we were using the incorrect camera for LOD calculations.
      • The second was that Three.js's Sphere implementation incorrectly calculated the sphere size for perspective cameras.
  • Fixed some issues with the destroy() function where it improperly handled non-bot objects.
  • Fixed an issue with builder where extra tags would be added to new blank bots.
  • Fixed an issue with menu bots where they would not send @onAnyBotClicked shouts.

V1.0.27

Date: 4/22/2020

Changes:

• :rocket: Improvements

  • Added the player.share(options) function.
    • This will trigger the device's social share capabilities to share the given URL or text.
    • Note that this only works on Android and iOS phones and only works in response to some user action like a click.
    • options is an object with at least one of the following properties:
      • url - The URL to share. (optional)
      • text - The text to share. (optional)
      • title - The title of the document that is being shared. (optional)
  • Added the auxLabelAlignment tag.
    • Note that this value affects menu bots as well.
    • Possible values are:
      • center - Aligns the text in the center of the label. (default)
      • left - Aligns the text to the left of the label.
      • right - Aligns the text to the right of the label.
  • Improved the auxPointable tag to affect whether iframes are interactable.

• :bug: Bug Fixes

  • Fixed an issue with the iframe form where non square scales would not resize the clickable area of the iframe.

V1.0.26

Date: 4/21/2020

Changes:

• :boom: Breaking Changes

  • Changed how universes from other auxPlayers are specified.
    • This affects the player.loadUniverse() function and the BotManager API.
    • Previously, you could load a universe from a different auxPlayer by using a universe ID like:
      • otherAuxPlayer.com/*/universeToLoad
    • Now, you can load a universe by simply using its full URL. Like this:
      • https://otherAuxPlayer.com?auxUniverse=universeToLoad
    • Note that this does not affect loading universes from the same auxPlayer. If you pass a universe ID that is not a URL then it will load that particular universe from same auxPlayer.
      • e.g. player.loadUniverse("myUniverse")

• :rocket: Improvements

  • Improved the player.showInputForTag() modal.
    • Removed the "Save" and "Cancel" buttons. The tag will be saved automatically.
    • Hid the modal title when none is provided in the options.
    • Made the text box in the modal auto-focus.
    • Made the show/hide animations happen quicker.
  • Added the player.showInput(value, options) function.
    • Shows an input modal but without requiring a bot and a tag.
    • Returns a Promise that resolves with the final value when the input modal is closed.
    • The function accepts two arguments:
      • value is a string containing the value that should
      • options is an object that takes the same properties that the options for player.showInputForTag() takes.
  • Added the ability to use the await keyword in scripts.
    • await tells the system to wait for a promise to finish before continuing.
    • This makes it easier to write scripts which deal with tasks that take a while to complete.
  • Improved Builder to support opening a single bot in a new tab and changed its hover label from "menu" to "|||".

• :bug: Bug Fixes

  • Fixed an issue where it was impossible to load an AUX over HTTPS from a UI that was loaded over HTTP.

V1.0.25

Date: 4/15/2020

Changes:

• :boom: Breaking Changes

  • Renamed the billboardZ auxOrientationMode option to billboardTop.

• :rocket: Improvements

  • Added the server.loadErrors(bot, tag) function to make loading error bots from the error space easy.
    • bot is the bot or bot ID that the errors should be loaded for.
    • tag is the tag that the errors should be loaded for.
  • Added the server.destroyErrors() function to clear all the errors in the universe.
  • Added the billboardFront auxOrientationMode option to billboard the front of a bot instead of its top.
  • Added the ability to set auxFormAnimation to an array.
    • When set, the list of animations will play in sequence.
    • The last animation will loop forever until changed.
  • Added the experiment.localFormAnimation(bot, animation) function to play an animation locally.
    • It will interrupt and restore whichever animation is already playing on the bot.

• :bug: Bug Fixes

  • Fixed an issue where tags that were added via the sheet would not be recognized by the getMod() function.

V1.0.24

Date: 4/14/2020

Changes:

• :rocket: Improvements

  • Added a button on the sheet code editor to show errors that the script has run into.
    • It is very basic at the moment. There are no line/column numbers, no timestamps, and no way to clear the errors.
    • Errors are automatically pulled from error space and queried based on the following tags:
      • auxError must be true
      • auxErrorBot must be the ID of the bot whose script is in the editor.
      • auxErrorTag must be the name of the tag that is being edited.
    • The following tags are displayed for each error:
      • auxErrorName is the name of the error that occurred.
      • auxErrorMessage is the message that the error contained.

• :bug: Bug Fixes

  • Fixed the color encoding of sprites to use sRGB instead of linear.
  • Fixed an issue where atoms would be sorted improperly because their causes were improperly treated as different.