@casual-simulation/aux-custom-portals - npm Package Versions

V2.0.15

Date: 11/1/2021

:rocket: Improvements

• Added the miniMapPortal.
  • This is a mini version of the mapPortal that works kinda like the miniGridPortal.
• Added a introductory page to the documentation that links to the "Pillars of Casual Simulation" video tutorials.
• Added a "Getting Started" page that contains some written documentation on the basics of CasualOS.
  • Thanks to Shane Thornton (@shane-cpu) for contributing this!
• Added a glossary page to the documentation.
  • This page is incomplete but contains basic descriptions for common terms like "bot", "tag", "portal", "inst", etc.
  • There is also a feature where other parts of the documentation can link to the glossary and get Wikipedia-style tooltips for the terms.

:bug: Bug Fixes

• Fixed an issue where the server failed to retrieve permanent records when when .getMoreRecords() was called.

V2.0.14

Date: 10/29/2021

:rocket: Improvements

• Improved the local space to delete the oldest inst when localStorage is full.
• Added the pointerPixelX and pointerPixelY tags to the gridPortalBot to track the mouse pointer position on the screen.
• Improved the records system to be able to store records larger than 300KB in size.
  • Records larger than 300KB will be placed in an S3 bucket.
  • Records stored in S3 will now have a dataURL instead of data that points to where the record can be downloaded from.

:bug: Bug Fixes

• Fixed an issue where the built-in portal bots would cause all scripts to be recompiled.
• Fixed an issue where functions that retrieve data from portal bots (like os.getFocusPoint()) would always return null data.
• Fixed an issue where the .getMoreRecords() function did not work.

V2.0.13

Date: 10/19/2021

:rocket: Improvements

• Added several features to make testing asynchronous scripts easier.
  • Debuggers now automatically convert asynchronous scripts to synchronous scripts by default.
    • This makes testing easier because your test code no longer needs to be aware of if a script runs asynchronously in order to observe errors or results.
    • You can override this default behavior by setting allowAsynchronousScripts to true in the options object that is passed to os.createDebugger().
  • Some functions are now "maskable".
    • Maskable functions are useful for testing and debugging because they let you modify how a function works simply by using function.mask().returns() instead of function().
      • For example, the web.get() function sends an actual web request based on the options that you give it. When testing we don't want to send a real web request (since that takes time and can fail), so instead we can mask it with the following code:

      web.get.mask('https://example.com').returns({
          status: 200,
          data: 'hello world!',
      });
      

      Then, the next time we call web.get() with https://example.com it will return the value we have set:

      console.log(web.get('https://example.com));
      

    • Maskable functions currently only work when scripts are running inside a debugger with allowAsychronousScripts set to false.
    • Here is a list of maskable functions (more are coming):
      • web.get()
      • web.post()
      • web.hook()
      • webhook()
      • webhook.post()
      • os.showInput()
      • os.getRecords()
      • os.publishRecord()
      • os.destroyRecord()
      • os.requestPermanentAuthToken()
  • Properties added to globalThis are now separated per-debugger.
    • This means that you can set globalThis.myVariable = 123; and it won't affect debuggers.
    • It also means that testing with global variables are easier because you don't have to set and reset them before each test anymore.
  • Debuggers now automatically setup tempLocal bots for built-in portals.
    • This means that the portal bots like gridPortalBot, mapPortalBot, etc. are available in debuggers.
  • Debuggers now automatically setup a configBot.
    • You can override this configBot by using the configBot property in the options object that is passed to os.createDebugger().
• Updated the sidebar on the documentation site to be easier to use.
• Updated the auth site branding.
• Added well-formatted pages for the terms of service, privacy policy, and acceptable use policy to the auth website.

:bug: Bug Fixes

• Fixed an issue where floating labels on billboarded bots did not work.

V2.0.12

Date: 10/8/2021

:rocket: Improvements

• Added the os.createDebugger(options?) function.
  • os.createDebugger() can be used to create a separate sandbox area where bots can be tested without causing external effects.
  • This is useful for automated testing scenarios where you want to validate how a script works (e.g. that a toast is shown) without actually performing the script results (i.e. actually showing the toast).
  • Works by returning an object that contains a separate set of actions (like create() and getBots()) that can be used like normal. For example:

    const debug = os.createDebugger();
    const debugBot = debug.create({ home: true, color: 'red' });
    

    Creates a bot that is contained in the debugger. Therefore, scripts on the debugBot will only affect bots that were created in the debugger.
  • See the documentation for more information.
• Added the assert(condition, message?) and assertEqual(received, expected) functions.
  • These functions check that the given condition is true or that the values are equal to each other and throw an error if they are not.
  • They can be useful for automated testing.
  • See the documentation for examples.

:bug: Bug Fixes

• Fixed an issue where setting meetPortalAnchorPoint to left or right would not shift the gridPortal to the remaining space.

V2.0.11

Date: 10/1/2021

:boom: Breaking Changes

• Renamed server to inst.
  • This means that you should now configBot.tags.inst instead of configBot.tags.server.
  • It also means that you now should go to https://casualos.com?inst=my-aux instead of https://casualos.com?server=my-aux.
  • CasualOS will automatically replace server with inst on the first load so old links will continue to work.
• Renamed pagePortal to gridPortal
  • CasualOS will automatically replace pagePortal with gridPortal on first load (so old links will continue to work) but any scripts that change pagePortal will need to be updated to change gridPortal.
  • pagePortal on the configBot should now be gridPortal.
  • pagePortalBot is now gridPortalBot.
  • Some functions now should reference the bot portal instead of the page portal:
    • os.getCameraPosition('page') -> os.getCameraPosition('grid')
    • os.getCameraRotation('page') -> os.getCameraRotation('grid')
    • os.getFocusPoint('page') -> os.getFocusPoint('grid')
    • os.getPortalDimension('page') -> os.getPortalDimension('grid')
  • @onPortalChanged now uses gridPortal for that.portal.
• Renamed miniPortal to miniGridPortal
  • miniPortal on the configBot should now be miniGridPortal.
  • miniPortalBot should now be miniGridPortalBot.
  • Some functions now should reference the bot portal instead of the page portal:
    • os.getCameraPosition('mini') -> os.getCameraPosition('miniGrid')
    • os.getCameraRotation('mini') -> os.getCameraRotation('miniGrid')
    • os.getFocusPoint('mini') -> os.getFocusPoint('miniGrid')
    • os.getPortalDimension('mini') -> os.getPortalDimension('miniGrid')
  • @onPortalChanged now uses miniGridPortal for that.portal.
• Renamed some functions:
  • os.downloadServer() -> os.downloadInst()
  • os.loadServer() -> os.loadInst()
  • os.unloadServer() -> os.unloadInst()
  • os.getCurrentServer() -> os.getCurrentInst()
  • server.remotes() -> os.remotes()
  • server.serverRemoteCount() -> os.remoteCount()
  • server.servers() -> os.instances()
  • server.serverStatuses() -> os.instStatuses()
  • server.restoreHistoryMarkToServer() -> server.restoreHistoryMarkToInst().
  • Note that some functions have moved to the os namespace from the server namespace. This is because most server functions do not work on CasualOS.com and are only designed to work with a server-based system (which CasualOS.com is not). To clarify this, functions that work all the time are now in the os namespace while the others are in the server namespace.
• Renamed several listen tags:
  • @onServerJoined -> @onInstJoined
  • @onServerLeave -> @onInstLeave
  • @onServerStreaming -> @onInstStreaming
  • @onServerStreamLost -> @onInstStreamLost
  • @onServerAction -> @onAnyAction

:rocket: Improvements

• Updated the Privacy Policy, Terms of Service, and Acceptable Use Policy.
• Changed the meetPortal to use a custom Jitsi deployment.
• Improved os.enablePointOfView(center?) to take an additional argument that determines whether to use the device IMU to control the camera rotation while in POV mode.
  • The new function signature is os.enablePointOfView(center?, imu?).
  • e.g. os.enablePointOfView(undefined, true) will enable using the IMU for controlling the camera rotation.

:bug: Bug Fixes

• Fixed an issue where zooming on menu bots would trigger the browser-provided zoom functionality.
• Fixed an issue where copying an array from one tag to another tag caused CasualOS to break.
• Fixed an issue where editing a script via the sheet portal cells would temporarily break the code editor.

V2.0.10

Date: 9/21/2021

:rocket: Improvements

• Improved the runtime to track changes to arrays without having to make a copy of the array or save it back to the tag.
• Improved os.getRecords(...filters) to use authBot.id if byAuthID() is not specified.
• Added labelOpacity tag.
• Added menuItemLabelStyle tag.
• Added the ability to use the auto value in the scaleY tag for menu bots. This automatically scales the menu bot height based on the amount of text in the label.
• Added the ability to rotate around an object multiple times with os.focusOn() by setting normalized to false in the rotation property.
  • By default, rotations passed to os.focusOn() are normalized to between 0 and 2π.
  • Setting normalized to false will skip this process and allow rotations larger than 2π which in turn means the camera will rotate past 2π.