Skip to content

Latest commit

 

History

History
294 lines (248 loc) · 11.7 KB

changelog.md

File metadata and controls

294 lines (248 loc) · 11.7 KB

Changelog Material Plane Foundry Module

v3.2.2 - 27-09-2024

Due to a mistake some files were missing in v3.2.1, preventing the module from working. This is now fixed.

v3.2.1 - 26-09-2024

Additions:

  • During the calibration configuration, a test is performed to see if the display is configured correctly (full screen, browser zoom, display scaling). A warning is given if the test failed.
  • When configuring the calibration, both the GM's and active user's configuration screens are now synchronized

Fixes:

  • Fixed an issue where the calibration markers would not be displayed in the correct location if a second display connected to the computer had a different resolution or scaling than the TV

Other:

  • Some code cleanup

v3.2.0 - 16-08-2024

Additions:

  • (Touch) Added the ability to ping on a double tap

Fixes:

  • Touch now works for Foundry v12
  • Hide UI elements is now only applied to the active user

v3.1.1 - 12-06-2024

The module is now compatible with Foundry v12, removed compatibility with v10.

Fixes:

  • Fixed issue where linked tokens would sometimes not move

v3.1.0 - 16-04-2024

Fixes:

  • Battery icon now properly displays charging state
  • Reduced the amount of situations where a token can 'teleport' through a wall when the wall intersects a gridspace
  • Token targeting with the pen now works on non-owned tokens and it correctly accounts for token size
  • Fixed issue where 'Token Collision Prevention' would not move some UI elements of a token (such as its health bar) to the correct location
  • When a new template was drawn using the pen, the preview would not be properly removed and would stay visible until a refresh

Additions:

  • Added the functionality to draw a ruler when a token is moved (similar to Drag Ruler)
  • Added a 'Pen Setup' tab in the config for all pen related settings
  • Added the ability to run macros using the pen
  • Added a 'Control' tab in the config that handles all settings related to token controls
  • Added a cursor size slider for the pen cursor
  • Added the ability to use on-screen calibration points instead of the corner of the display
  • Added low battery notifications
  • Added 'Base Orientation' selector so offsets are calculated correctly when using base adapters at different orientations
  • Added a targeting icon for drawings when using the pen. This makes it easier to select the correct drawing

Other:

  • Changed the calibration procedure. It now opens a dialog to select how you want to calibrate
  • The pen menu will now have the same size and position on the screen regardless of canvas zoom or pan
  • Changed the label for sensor 'brightness' to 'sensitivity' to better reflect what it does and to better distinguish it from 'minimum brightness'
  • Did some code cleanup & organization

v3.0.2 - 20-10-2023

Fixes:

  • Decreased the size of the battery indicator to it doesn't overflow
  • Data is now correctly formatted before being sent to Material Companion
  • In the base setup, rules with base IDs of the current base display a green ID again

Additions:

  • Added a configurable maximum connection attempts to connect to either the sensor or Material Companion

Other:

  • Added a 'Connection Mode' setting that replaces the 'Connect to the Sensor' and 'Use Material Server' settings
  • When connecting to the sensor through Material Companion, the IP address now has to be configured in Material Companion instead of in the module.

v3.0.1 - 04-10-2023

Fixes:

  • Calibration overlay is now properly displayed
  • Calibration 'Next' and 'Close' buttons are now properly communicated to the sensor

v3.0.0 - 30-09-2023

This release is only meant for the production hardware (requiring firmware v3.0.0+). DIY hardware is currently not supported.
The communication between the sensor and module has been overhauled, which is why it only works with the latest firmware. Besides that, a lot of minor changes and fixes have been made.

Touch functionality is currently broken in Foundry V11.

v2.1.7 - 28-08-2022

Additions:

  • Added scaling for touch, to fix alignment issues

Other:

  • Unusable options removed from config menu for the DIY sensor
  • Made compatible with Foundry v10, removed compatibility with v8

v2.1.6 - 13-06-2022

Fixes:

  • Fixed some settings migration issues

v2.1.5 - 13-06-2022

Fixes:

  • In the previous update, I accidentally pointed the download and manifest URL to the wrong branch. This meant that it wouldn't update to the correct version
  • Touch Frames should now work on secured servers

v2.1.4 - 05-05-2022

Fixes:

  • Invisible non-owned tokens can no longer be moved, even if 'Non-Owned Movement' is enabled
  • If 'Non-Owned Movement' is disabled, non-owned tokens no longer take priority over owned tokens when searching for the nearest token
  • Fixed pen menu not showing up properly
  • Fixed scale x/y slider, it now allows for floats and allows values between 0 and 2
  • The target player can now change settings (the GM needs to be logged in)

Additions:

  • Added support for touch screens
  • Added an experimental token collision detection to prevent a moving token from ending up on a space already occupied by another token. Can be enabled in the module settings.
  • Added a 'Restart Sensor' button to the sensor configuration
  • Displayed points in the sensor configuration are now colored and numbered

Other:

  • Revamped the configuration of everything. All configuration, including module settings, base configuration, etc, is done through a single configuration menu.

v2.1.3 - 26-01-2022

Fixes:

  • Fixed X and Y Offset in 'Sensor Configuration'

Additions:

Other:

  • Moved the 'Base Setup' button to the 'Game Settings' tab, so all MP buttons are located at the same place
  • The 'Target' account now also has access to 'Base Setup'

v2.1.2 - 30-12-2021

  • Fixed Foundry v9 compatibility
  • In the module settings, changed setting name 'Enable module' to 'Connect to the Sensor' since that makes more sense

v2.1.1 - 17-11-2021

Fixes:

  • Foundry will now connnect to Material Server if the Foundry server is secured (for example, when using the Forge)
  • Moving a token around but dropping it on the gridspace it came from, no longer results in wrong token positioning

Additions:

  • left-clicking the pen when in token control mode now deselects the token
  • left-clicking or right-clicking the pen when in token control mode now deselects all tokens when cursor is not above a token
  • center-clicking/rotating the pen when in token control mode now moves and rotates tokens
  • Pen menu now autohides when the pen is deactivated
  • Added a 'Download Utility' to the module settings from where you can check your current versions and download the latest versions of the hardware firmware and Material Server

Other:

  • Changed 'Calibration Menu' to 'Sensor Configuration'
  • Made 'Enable module' setting functional. It prevents that client from trying to connect to the sensor
  • Reduced the rate at which the module will attempt to connect to the sensor, reducing the amount of notifications in case of connection problems

Compatible with:

  • Sensor firmware: v2.1.2
  • Material Server: v1.0.3 (not yet released)

v2.1.0 - 12-10-2021

Updating the sensor firmware to v2.1.0 is required Additions:

  • You can now configure the websocket port to use. For current users: This means that you need to add this to the 'Sensor Module IP Address' module setting
  • Material Plane can connect through Material Server, using it as a proxy server to allow MP to function on SSL Foundry servers (requires MS v1.0.3)
  • Through Material Server, MP can connect to the server using the USB Serial Port (requires MS v1.0.3)
  • Added offset compensation for when, after calibration, there is an offset between the base location and in-game location
  • Made elements in the calibration screen collapsible to prevent excessive scrolling
  • Added 'Auto exposure' button to the calibration screen (only works for Beta HW)

Fixes:

  • All pen functions now work properly
  • If a token was dropped on the same spot it as picked up from, the token location would not return to the center of the grid. This has been fixed

Other:

  • Cursor of the pen now hides after 1 second of inactivity
  • Reduced the max average count to 20
  • Minor changes to the communication protocol between sensor and module
  • Battery percentage calculation has been moved to the sensor

Compatible with:

  • Sensor firmware: v2.1.0
  • Material Server: v1.0.3

v2.0.1 - 16-07-2021

Additions:

  • 'Average Count' is now also editable for DIY sensors (using calibration screen), which allows you to improve positional accuracy at the cost of responsiveness.
  • Improved on-screen calibration instructions

Fixes:

  • Fixed issue where sensor would stay in calibration mode if calibration was not successfully completed.
  • Removed console error that appeared for the GM when calibration was done.
  • WebSocket client no longer creates duplicate connections, which resulted in errors

Other:

  • Removed 'Hardware Variant' module setting, since it's now autodetected

v2.0.0 - 15-07-2021

This is basically a complete rewrite of the module, made with support for the new hardware in mind.
The old hardware is compatible, but requires an update.
Please not that the configuration for the new hardware is completely different, please read the documentation: https://github.com/CDeenen/MaterialPlane/wiki/Arduino-Instructions
Foundry 0.7 is no longer supported.

v1.0.2 - 26-10-2020

Additions:

  • Localization support
  • Added a warning that the module does not work over SSL
  • 0.7.5 support, including the new token drag vision setting
Foundry v0.6.6 is no longer supported (it might still work, though)

v1.0.1 - 27-09-2020

Fixes:

  • Simplified and improved sensitivity settings
  • Fixed issue where the calibration menu would not update properly
  • Bigger tokens now center properly
  • Multipoint calibration fixed, multipoint offset added
Additions:
  • Added X and Y compensation to fine-tune the measured coordinate
  • Added calibration and offset checkboxes to calibration menu
  • Added low battery notification

v1.0.0 - 22-09-2020

Initial Release