Plugin/CHANGELOG.md

# Changelog

All notable changes to this project will be documented in this file.

The format is based on [Keep a Changelog](https://keepachangelog.com/en/1.0.0/),
and this project adheres to [Semantic Versioning](https://semver.org/spec/v2.0.0.html).

## [Unreleased]

### Fixed

- Fix the wrist tracker miscalculations.
- Minor code improvement and fixes.
- Minor documentation fixes.

## [v1.2.1] - 2023-03-30

### Fixed

- Fix RunUAT build issues with Android.

## [v1.2.0] - 2023-03-28

This release breaks ABI/API compatibility with the previous versions.

### Added

- Android / Oculus on-device glove calibration.
- Introduced the animated Virtual Hand Model (as a set of virtual hand and wrist tracker components and an actor) with in-editor animation availability.
- Introduced SGPawn, SGPlayerController, SGGameModeBase, etc classes.
- Added an internal SenseGloveCoreTypes module in order to share common SenseGloveCore types between various modules.
- Segregated Android binaries for NDK r21e (UE 4.27 and 5.0) and r25b (UE 5.1, 5.2).
- Fully functional and stable Linux development support.
- Fully functional and stable Unreal Engine 5.2 preview support has been added.
- Added a Plugin's settings manager and two new modules SenseGloveSettings and SenseGloveSettingsKismet.

### Changed

- SenseGlove libraries have been updated to the Linux-aware version: v2.5.0-8069342.
- API has changed to use degrees instead of radians.
- SGCoordinates utility class name has been changed to SGAngles and now the plugin API uses degrees in contrast of SenseGlove libraries by default.
- Migrate common nested array types into the SenseGloveTypes module from the SenseGloveCore module.

### Removed

- Removed a few thousands lines of archaic pre-public-release dead code.
- Dropped Android NDK r21b binaries used by the older engine versions.
- Purged the dead code for dropped engine versions by v1.1.1 (4.22, 4.23, 4.24, 4.25, and 4.26) that carried over to the current version.
- Removed redundant SGConnectImpl/SGPlatform.
- Removed redundant SGTypes/SGConnectTypes.

### Known Issues

- Wrist Tracker's offsets are a bit off (e.g. on Quest 2), scheduled to be fixed in the next patch release.

## [1.1.1] - 2023-02-07

### Added

- Initial support for the upcoming Unreal Engine 5.2.
- Add support for Android armeabi-v7a with neon, x86-64, and x86 builds in addition to arm64-v8a.

### Fixed

- Fix various Android build issues.
- Some minor fixes and improvements.

### Changed

- Bump SenseGlove libraries to v2.1.2-95ec6e7.

## [1.1.0] - 2023-02-03

### Added

- Whitelist Android as a target platform.
- Introduce Android support.
- Add third-pary library SGConnect for Android v1.1.0.

### Fixed

- Fix Android build issues caused by the log module.

### Changed

- SGConnect and SGCore libraries have been updated to v2.1.1-0569c74.

### Removed

- Removed the enum utils class due to ANY_PACKAGE deprecation warnings in Unreal Engine 5.1.
- Support for older versions of the Engine (namely, 4.22, 4.23, 4.24, 4.25, and 4.26) has been dropped.

## [1.0.4] - 2022-12-02

This is a minor release focusing mostly on adherence to the Unreal Engine Marketplace Guidelines based on the feedback from Epic Games.

### Added

- Added support for MSVC 2017

### Changed

- Updated SenseGlove libraries (SGCore/SGConnect) to v2.0.4.

## [1.0.3] - 2022-11-29

This is a minor release focusing on adherence to the Unreal Engine Marketplace Guidelines based on the feedback from Epic Games.

### Changed

- Adjust Config/FilterPlugin.ini in order to conform to Epic's Market Place Guidelines.

## [1.0.2] - 2022-11-27

This is a minor release focusing on adherence to the Unreal Engine Marketplace Guidelines based on the feedback from Epic Games.

### Added

- Added the newly acquired Unreal Engine Market Place Offer ID to the .uplugin file.
- List the dot files inside FilterPlugin.ini file as well.
- Add the copyright notice to the source files missing it.
- Add the SenseGlove SDK license to the third-party license file.

### Fixed

- Fix the readme typos and errors.
- Minor fixes in the changelog for previous releases.

## [1.0.1] - 2022-11-25

### Changed

- Exposed SenseGloveTypes as a public dependency in SenseGloveConnect and SenseGloveCore modules, so that the C++ users of the API don't need to explicitly add it as a dependency.
- Cleaned up the redundant headers/modules dependencies from SGCore headers.

### Fixed

- Fix RunUAT build issues prior to Epic Store submission.

## [1.0.0] - 2022-11-24

### Added

- Initial public release of the SenseGlove haptic API for Unreal Engine with support for Microsoft Windows and GNU/Linux.