@casual-simulation/aux-custom-portals

AUX Custom Portals

A set of utilities that can be used to help custom portals interface with CasualOS.

Installation

1. Install the NPM package

npm install @casual-simulation/aux-custom-portals

Changelog

V1.5.6

Date: 4/1/2021

:rocket: Improvements

• Added the "bots" snap target for os.addDropSnap() and os.addBotDropSnap().
  • This will cause the dragged bot to snap to other bots.
• Added the experiment.speakText(text, options?) and experiment.getVoices() functions.
  • See the documentation for more information.
• Added the os.getGeolocation() function.
  • Returns a promise that resolves with the geolocation of the device.
• Added the imuPortal to be able to stream IMU data into CasualOS.
  • When defined on the config bot, the imuPortalBot will be updated with IMU data from the device.
  • The following tags are used:
    • imuSupported - Whether reading from the IMU is supported. This will be shortly after the imuPortal is defined.
    • deviceRotationX, deviceRotationY, deviceRotationZ - The X, Y, and Z values that represent the orientation of the device.
• Added the portalCameraType tag to allow switching between perspective and orthographic projections.
  • Camera projections act similarly to real world camera lenses except that they avoid certain limitations like focal lengths.
  • orthographic - This projection preserves parallel lines from the 3D scene in the output 2D image. As a result, same-sized objects appear the same size on the screen, regardless of how far away they are from the camera.
  • perspective - This projection makes same-sized objects appear larger or smaller based on how far away they are from the camera. Closer objects appear larger and vice versa.
• Added the os.enablePointOfView(center?) and os.disablePointOfView() functions.
  • These are similar to os.enableVR() or os.enableAR() and can be used to give the player a "ground level" perspective in the page portal.
  • os.enablePointOfView(center?) - Enables POV mode by moving the camera to the given position, setting the camera type to perspective, and changing the controls so that it is only possible to rotate the camera.
  • os.disablePointOfView() - Disables POV mode by resetting the camera, camera type, and controls.

:bug: Bug Fixes

• Fixed an issue where tag edits would appear duplicated when running CasualOS in the non-collaborative mode.