bump the plugin version to v1.9.2

- Introduced new SGPawn events: OnActorGrabbed, OnActorReleased, OnActorBeginTouch, and OnActorEndTouch.
- Exposed OnGrabStateUpdated, OnTouchStateUpdated, OnActorGrabbed, OnActorReleased, OnActorBeginTouch, and OnActorEndTouch events to Blueprint as BlueprintImplementableEvent.

- Fix a bug where the OnTouchStateUpdated event is mistakenly triggered instead of the OnGrabStateUpdated when the right thumb fingertip grab collider overlaps with a grabbable actor.

.gitattributes

@@ -38,13 +38,3 @@ Resources/**/* filter=lfs diff=lfs merge=lfs -text
 
 # LFS: everything under Source/ThirdParty/
 Source/ThirdParty/**/* filter=lfs diff=lfs merge=lfs -text
-
-# LFS: everything under Handbook/dist/
-Handbook/dist/**/* filter=lfs diff=lfs merge=lfs -text
-# Except
-.gitignore      filter= diff= merge= text
-.gitattributes  filter= diff= merge= text
-
-# LFS: sgum-packager Linux and Windows binaries
-Packager/sgum-packager filter=lfs diff=lfs merge=lfs -text
-Packager/sgum-packager.exe filter=lfs diff=lfs merge=lfs -text

.gitignore

@@ -125,11 +125,3 @@ DerivedDataCache/*
 
 # Do not ignore anything inside the ThirdParty directory at all
 !Source/ThirdParty/**/*
-
-# The Handbook
-Documentation/
-Handbook/book/
-
-# sgum-packager
-# Do not ignore the sgum-packager Windows binary
-!Packager/sgum-packager.exe

CHANGELOG.md

@@ -0,0 +1,363 @@
+# 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).
+
+## [1.9.2] - 2023-11-03
+
+# Added
+
+- Added a list of planned features and their completion status to the main README file.
+
+### Fixed
+
+- A bug where released actor is going to be NULL whenever the OnActorReleased event fires.
+
+## [1.9.1] - 2023-10-11
+
+### Fixed
+
+- Add the missing Unreal Engine C++ header to files that rely on the ENGINE\_\*\_VERSION macros in order to fix the Epic Store build failures on UE 5.3.
+
+## [1.9.0] - 2023-10-10
+
+### Changed
+
+- The BlueprintImplementableEvent UFUNCTION specifier for the OnGrabStateUpdated, OnTouchStateUpdated, OnActorGrabbed, OnActorReleased, OnActorBeginTouch, and OnActorEndTouch events have been changed to BlueprintNativeEvent in order to allow them to be implemented from the child C++ classes as well. This won't break any existing Blueprint code that relies on the previous BlueprintImplementableEvent signature.
+
+### Fixed
+
+- Add a missing release note entry for the v1.8.0 release to the changelog file.
+
+## [1.8.0] - 2023-10-10
+
+### Added
+
+- Introduced new SGPawn events: OnActorGrabbed, OnActorReleased, OnActorBeginTouch, and OnActorEndTouch.
+- Exposed OnGrabStateUpdated, OnTouchStateUpdated, OnActorGrabbed, OnActorReleased, OnActorBeginTouch, and OnActorEndTouch events to Blueprint as BlueprintImplementableEvent.
+
+### Fixed
+
+- Fix a bug where the OnTouchStateUpdated event is mistakenly triggered instead of the OnGrabStateUpdated when the right thumb fingertip grab collider overlaps with a grabbable actor.
+- Fix the DECLARE_EVENT macro signature for OnGrabStateUpdated and OnTouchStateUpdated events.
+
+## [1.7.0] - 2023-09-14
+
+### Added
+
+- Introduce SGGameInstance, a customized SenseGlove game instance for future use.
+- Added the new SenseGloveBackend and SenseGloveBackendKismet modules.
+- Added SG_CPP20 C++ macro for C++20 detection, which is now default from UE 5.3 onwards.
+- Added SG_CAPTURE_THIS C++ macro as a workaround for error C4855: implicit capture of 'this' via '[=]' is deprecated in /std:c++20 in order to build the same lambda captures without extra #ifdefs on all supported engine versions.
+
+### Changed
+
+- SenseGlove libraries have been updated to v2.12.0-19c9854.
+- SGCoreImpl/SGPlatform has been moved to SGBuildHacks/SGPlatform.
+
+### Fixed
+
+- Proper initialization of the SenseGlove backend in order to fix a bug in certain situations where SGConnect::Init() gets called every frame.
+- Some other minor fixes and improvements.
+
+## [1.6.1] - 2023-08-14
+
+### Fixed
+
+- Fix Unreal Engine 5.0 build issues.
+- Minor documentation fixes.
+
+## [1.6.0] - 2023-08-14
+
+### Added
+
+- Added support for the upcoming Unreal Engine 5.3.
+- Now, the hand's velocity is applied to grabbed actors after being released from the hand.
+- Introduce the real hands to the SenseGlove module (SGPawn) API.
+- Added separation of the virtual and real hand rendering.
+
+### Fixed
+
+- Fix the wrong default debug virtual hand gizmo colors when initialized using the default constructor.
+- Some minor performance fixes and improvements.
+
+### Changed
+
+- SenseGlove libraries have been updated to v2.11.0-b775a05.
+
+## [1.5.3] - 2023-07-19
+
+This is a hotfix release mostly addressing Android Bluetooth performance issues.
+
+### Fixed
+
+- Minor changelog fixes.
+
+### Changed
+
+- SenseGlove libraries have been updated to v2.10.1-3b0e7c9.
+
+## [1.5.2] - 2023-07-19
+
+This is a hotfix release mostly addressing Android-related issues.
+
+### Fixed
+
+- Fix a build issue with Android shipping builds due to sgconnect.jar not getting copied automatically in the AFSProject which is compiled for shipping builds when AndroidFileServer (AFS) is enabled.
+- Minor changelog fixes and some source code formatting fixes.
+
+## [1.5.1] - 2023-07-13
+
+This is a hotfix release addressing a few critical issues introduced by the recent changes.
+
+### Fixed
+
+- Fix a wrist tracker bug where left and right hands' wrist trackers are mistakenly tracking the opposite hand's motion source.
+- Fix a bug where the right hand is not able to do grab or release.
+
+## [1.5.0] - 2023-06-16
+
+This release breaks ABI/API compatibility with the previous versions in some areas as documented below.
+
+### Added
+
+- Added HTC VIVE Focus 3 positional tracking hardware enum.
+- Added support for the Meta Quest Pro, HTC VIVE, and HTC VIVE Focus 3 positional tracking hardware.
+- Added two options to the wrist tracker settings (to the global plugin settings and the overrides in the wrist tracker component) in order to be able to specify a custom motion source for the left and right hands, so that it allows SteamVR-based trackers such as HTC VIVE or HTC VIVE Focus 3 to operate with the SGPawn.
+
+### Fixed
+
+- Fix a bug where SteamVR trackers such as HTC VIVE and HTC VIVE Focus 3's wrist orientation and location were not being tracked.
+
+### Changed
+
+- Fully refactored the top-level configurations in the settings system into USTRUCTs.
+- SenseGlove libraries have been updated to v2.10.0-12133ac.
+
+### Removed
+
+- Dropped support for the Epic Native Toolchain v19, MSVC v141 (Visual Studio 2017), and thus Unreal Engine 4.27 as it has been marked as deprecated since v1.4.x.
+- Removed any kind of support for Oculus Touch (Oculus Rift S and Oculus Quest 1) positional tracking hardware, thus the enum as well.
+- Removed any kind of support for Pico Neo 2 positional tracking hardware, thus the enum as well.
+- Removed any kind of support for Pico Neo 3 positional tracking hardware, thus the enum as well.
+
+## [1.4.3] - 2023-06-01
+
+This is a hotfix release addressing a critical Android crash.
+
+### Fixed
+
+- Fix a critical Android crash that happens where the default development hand meshes are not found, which means almost always since we don't ship any default virtual hand mesh at the moment.
+- Minor changelog release formatting fix in order to stay consistent.
+
+## [1.4.2] - 2023-06-01
+
+This is a hotfix release addressing a few critical issues.
+
+### Fixed
+
+- Fix build issues with certain compilers when the Unreal Engine version is older than 5.2.
+- Reintroduced the Virtual Hand and the Wrist Tracker debug gizmos which have temporarily been disabled due to a bug in the settings system.
+- Some minor changelog fixes.
+
+## [1.4.1] - 2023-05-29
+
+This is a bugfix release with a focus on Android build issues.
+
+### Fixed
+
+- Fix an Android Gradle build issue that happens when the game's package name won't start with com.senseglove.*.
+- Suppress a grade warning for non-arm64 architectures when the build target is Android.
+
+### Removed
+
+- Remove dead Gradle code from the Android module.
+
+## [1.4.0] - 2023-05-19
+
+This release breaks ABI/API compatibility with the previous versions.
+
+### Added
+
+- Added support for the stable release of Unreal Engine 5.2 (the preview release has been supported since v1.2.0).
+- Added Linux AArch64 platform support.
+- Added a new Grab component that can turn any actor into a grabbable object.
+- Added a new Touch component that enables haptic feedback such as Buzz and Force-Feedback commands.
+- Added an optional feature in order to automatically stop all haptics on the EndPlay event, wherever the virtual hand component is used. By default, it's enabled.
+
+### Fixed
+
+- Fix Blueprint signatures for USGVirtualHandComponentKismetLibrary and make all the Blueprint exposed functions static.
+
+### Changed
+
+- SenseGlove libraries have been updated to v2.7.1-965f90c with support for Linux AArch64.
+- The Virtual Hand and the Wrist Tracker debug gizmos (the intended use is only for SenseGlove developers for really low-level stuff; thus won't affect the users of the plugin at all) have been disabled and will be ignored due to an esoteric bug in the settings systems which has been scheduled to be fixed in the future releases.
+
+### Removed
+
+- Removed the redundant SenseGloveCoreTypes module which causes all kinds of packaging issues with certain versions of the engine.
+
+### Deprecated
+
+- This is the last release to support Unreal Engine 4.27 and please keep in mind that the current release is not obtainable through the Unreal Engine Marketplace. The latest published version on the Marketplace for 4.27 is v1.3.1. Per Epic's Marketplace policy regarding Code Plugins, we are only able to distribute or update the SenseGlove plugin for the last 3 stable versions of Unreal Engine. As a result, we won't be able to publish updates or bug fixes for the older versions of the Engine except on rare occasions and only through our official repository on Microsoft Azure DevOps.
+
+## [1.3.1] - 2023-04-28
+
+### Fixed
+
+- Fix RunUAT build issues caused by missing headers.
+- Minor documentation fixes.
+
+## [1.3.0] - 2023-04-28
+
+This release breaks ABI/API compatibility with the previous versions in addition to breaking coordinates systems conversions between Unreal Engine and the SenseGlove libraries.
+
+### Added
+
+- A new generic SenseGlove Debug module.
+- A debug virtual hand.
+
+### Fixed
+
+- Fix the wrist tracker miscalculations for the Quest 2 controllers (other headsets might need fixing as well, in that case, future releases will address that).
+- Minor code improvement and fixes.
+- Minor documentation fixes.
+
+### Changed
+
+- Breaking API/ABI changes in the Settings and the main SenseGlove module due to some settings refactoring.
+- Breaking changes in the SenseGlove/Unreal coordinates systems conversions due to underlying changes in the SenseGlove Core Libraries.
+- SenseGlove libraries have been updated to v2.6.0-aac3d56.
+
+## [1.2.1] - 2023-03-30
+
+### Fixed
+
+- Fix RunUAT build issues with Android.
+
+## [1.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 thousand 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-party 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 dotfiles inside the 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.

Config/FilterPlugin.ini

@@ -1,5 +1,3 @@
 [FilterPlugin]
+/CHANGELOG.md
 /Config/FilterPlugin.ini
-/Documentation/the-senseglove-unreal-engine-handbook.epub
-/Documentation/the-senseglove-unreal-engine-handbook.pdf
-/Documentation/the-senseglove-unreal-engine-handbook.zip

Handbook/BSDmakefile

@@ -1,34 +0,0 @@
-#
-# author: Mamadou Babaei <mamadou@senseglove.com>
-#
-# (The MIT License)
-#
-# Copyright (c) 2020 - 2025 SenseGlove
-#
-# Permission is hereby granted, free of charge, to any person obtaining a copy
-# of this software and associated documentation files (the "Software"), to deal
-# in the Software without restriction, including without limitation the rights
-# to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
-# copies of the Software, and to permit persons to whom the Software is
-# furnished to do so, subject to the following conditions:
-#
-# The above copyright notice and this permission notice shall be included in all
-# copies or substantial portions of the Software.
-#
-# THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
-# IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
-# FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
-# AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
-# LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
-# OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
-# SOFTWARE.
-#
-
-# pmake might add -J (private)
-FLAGS=${.MAKEFLAGS:C/\-J ([0-9]+,?)+//W}
-
-all: .DEFAULT
-.DEFAULT:
-	@which gmake > /dev/null 2>&1 || \
-		(echo "BSD Make is not supported; The build requires GNU Make." && exit 1)
-	@gmake ${.FLAGS} ${.TARGETS}

Handbook/GNUmakefile

@@ -1,695 +0,0 @@
-#
-# author: Mamadou Babaei <mamadou@senseglove.com>
-#
-# (The MIT License)
-#
-# Copyright (c) 2020 - 2025 SenseGlove
-#
-# Permission is hereby granted, free of charge, to any person obtaining a copy
-# of this software and associated documentation files (the "Software"), to deal
-# in the Software without restriction, including without limitation the rights
-# to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
-# copies of the Software, and to permit persons to whom the Software is
-# furnished to do so, subject to the following conditions:
-#
-# The above copyright notice and this permission notice shall be included in all
-# copies or substantial portions of the Software.
-#
-# THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
-# IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
-# FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
-# AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
-# LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
-# OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
-# SOFTWARE.
-#
-
-################################################################################
-# Generic Settings
-################################################################################
-
-SG_PROJECT_NAME	:=	The SenseGlove Unreal Engine Handbook
-
-SG_PROJECT_GIT_REPOSITORY	:=	https://dev.azure.com/SenseGlove/SenseGlove-Unreal/_git/SenseGlove-Unreal
-
-SG_HANDBOOK_ESCAPED_NAME	:=	$(shell echo $(SG_PROJECT_NAME) | tr '[:upper:]' '[:lower:]' | sed 's/ /-/g')
-
-SG_HANDBOOK_DIR						:=	$(CURDIR)
-SG_HANDBOOK_SRC_DIR					:=	$(SG_HANDBOOK_DIR)/src
-SG_HANDBOOK_TOML_FILE				:=	$(realpath $(SG_HANDBOOK_DIR)/book.toml)
-SG_HANDBOOK_CONFIG_HOME_DIR			:=	SenseGlove/ue-handbook
-SG_HANDBOOK_DEPLOY_CONFIG_FILENAME	:=	deploy.conf
-SG_HANDBOOK_DEPLOY_TEMP_DIR_NAME	:=	unreal-docs-senseglove-com-deploy-XXXXXXXXXX
-SG_HANDBOOK_FAVICON_FILE			:=	$(SG_HANDBOOK_SRC_DIR)/favicon.svg
-
-SG_DOT_GIT_DIR			:=	$(realpath $(SG_HANDBOOK_DIR)/../.git)
-SG_DOT_GIT_SHALLOW_FILE	:=	$(SG_DOT_GIT_DIR)/shallow
-
-SG_PLUGIN_DIR			:=	$(realpath $(SG_HANDBOOK_DIR)/..)
-SG_PLUGIN_RESOURCES_DIR	:=	$(SG_PLUGIN_DIR)/Resources
-SG_PLUGIN_FILE			:=	$(SG_PLUGIN_DIR)/SenseGlove.uplugin
-
-SG_DOCUMENTATION_URL			:=	https://unreal.docs.senseglove.com
-SG_DOCUMENTATION_DIR			:=	$(SG_PLUGIN_DIR)/Documentation
-SG_DOCUMENTATION_HTML_DIR_NAME	:=	html
-SG_DOCUMENTATION_HTML_DIR		:=	$(SG_DOCUMENTATION_DIR)/$(SG_DOCUMENTATION_HTML_DIR_NAME)
-SG_DOCUMENTATION_PDF_DIR		:=	$(SG_DOCUMENTATION_DIR)/pdf-outline
-SG_DOCUMENTATION_PDF_FILE		:=	$(SG_DOCUMENTATION_PDF_DIR)/output.pdf
-SG_DOCUMENTATION_EPUB_DIR		:=	$(SG_DOCUMENTATION_DIR)/epub
-SG_DOCUMENTATION_EPUB_FILE		:=	$(SG_DOCUMENTATION_EPUB_DIR)/$(SG_PROJECT_NAME).epub
-SG_DOCUMENTATION_PACK_DIR_NAME	:=	pack
-SG_DOCUMENTATION_PACK_DIR		:=	$(SG_DOCUMENTATION_DIR)/$(SG_DOCUMENTATION_PACK_DIR_NAME)
-
-SG_HANDBOOK_PACKED_HTML_DIR		:=	$(SG_DOCUMENTATION_PACK_DIR)/$(SG_HANDBOOK_ESCAPED_NAME)
-SG_HANDBOOK_PACKED_HTML_FILE	:=	$(SG_DOCUMENTATION_PACK_DIR)/$(SG_HANDBOOK_ESCAPED_NAME).zip
-SG_HANDBOOK_PACKED_PDF_FILE		:=	$(SG_DOCUMENTATION_PACK_DIR)/$(SG_HANDBOOK_ESCAPED_NAME).pdf
-SG_HANDBOOK_PACKED_EPUB_FILE	:=	$(SG_DOCUMENTATION_PACK_DIR)/$(SG_HANDBOOK_ESCAPED_NAME).epub
-
-SG_BROWSER_BINARY_PATH_LINUX	:=	/opt/brave.com/brave/brave
-SG_BROWSER_BINARY_PATH_WINDOWS	:=	C:\Program Files\BraveSoftware\Brave-Browser\Application\brave.exe
-
-SG_RSYNC_BIN_PATH_WINDOWS			:=	C:\Program Files\cwrsync\bin
-SG_RSYNC_BINARY_PATH_WINDOWS		:=	$(SG_RSYNC_BIN_PATH_WINDOWS)\rsync.exe
-SG_RSYNC_SSH_BINARY_PATH_WINDOWS	:=	$(SG_RSYNC_BIN_PATH_WINDOWS)\ssh.exe
-
-################################################################################
-# Platform Detection
-################################################################################
-
-SG_BUILD_ARCH_AMD64			:=	amd64
-SG_BUILD_PLATFORM_LINUX		:=	linux
-SG_BUILD_PLATFORM_WINDOWS	:=	windows
-
-ifeq ($(OS),Windows_NT)
-SG_BUILD_PLATFORM	:=	$(SG_BUILD_PLATFORM_WINDOWS)
-# Running a 32-bit (x86) Command Prompt sets PROCESSOR_ARCHITECTURE to x86,
-# and instead defines PROCESSOR_ARCHITEW6432 for 64-bit Windows detection.
-ifeq ($(PROCESSOR_ARCHITEW6432),AMD64)
-SG_BUILD_ARCH		:=	$(SG_BUILD_ARCH_AMD64)
-else # ($(PROCESSOR_ARCHITEW6432),AMD64)
-ifeq ($(PROCESSOR_ARCHITECTURE),AMD64)
-SG_BUILD_ARCH		:=	$(SG_BUILD_ARCH_AMD64)
-endif # ($(PROCESSOR_ARCHITECTURE),AMD64)
-endif # ($(PROCESSOR_ARCHITEW6432),AMD64)
-else # ($(OS),Windows_NT)
-SG_PLATFORM_UNAME	:=	$(shell uname -s)
-ifeq ($(SG_PLATFORM_UNAME),Linux)
-SG_BUILD_PLATFORM		:=	$(SG_BUILD_PLATFORM_LINUX)
-SG_PLATFORM_UNAME_ARCH	:=	$(shell uname -m)
-endif # ($(SG_PLATFORM_UNAME),Linux)
-ifeq ($(SG_PLATFORM_UNAME_ARCH),x86_64)
-SG_BUILD_ARCH	:=	$(SG_BUILD_ARCH_AMD64)
-endif # ($(SG_PLATFORM_UNAME_ARCH),x86_64)
-endif # ($(OS),Windows_NT)
-
-################################################################################
-# Target Settings - mdbook
-################################################################################
-
-SG_MDBOOK_HOST		:=	"localhost"
-SG_MDBOOK_PORT		:=	"8000"
-SG_MDBOOK_SRC_DIR	:=	"${SG_HANDBOOK_DIR}/src"
-SG_MDBOOK_DEST_DIR	:=	"${SG_DOCUMENTATION_DIR}"
-SG_MDBOOK_WATCHER	:=	"poll"
-
-SG_PLUGIN_CHANGELOG_FILE							:=	$(SG_PLUGIN_DIR)/CHANGELOG.md
-SG_PLUGIN_DIRECTORY_STRUCTURE_FILE					:=	$(SG_PLUGIN_DIR)/DIRECTORY_STRUCTURE.md
-SG_PLUGIN_LICENSE_FILE								:=	$(SG_PLUGIN_DIR)/LICENSE.md
-SG_PLUGIN_LICENSE_THIRD_PARTY_FILE					:=	$(SG_PLUGIN_DIR)/LICENSE_THIRD_PARTY.md
-SG_PLUGIN_PLANNED_FEATURES_COMPLETION_STATUS_FILE	:=	$(SG_PLUGIN_DIR)/PLANNED_FEATURES_COMPLETION_STATUS.md
-SG_PLUGIN_PLATFORM_SUPPORT_MATRIX_FILE				:=	$(SG_PLUGIN_DIR)/PLATFORM_SUPPORT_MATRIX.md
-
-################################################################################
-# Version and Build Information
-################################################################################
-
-SG_GIT_TREE_STATE_CLEAN	:=	clean
-SG_GIT_TREE_STATE_DIRTY	:=	dirty
-
-SG_GIT_NO	:=	no
-SG_GIT_YES	:=	yes
-
-SG_RELEASE_BRANCH_PATTERN	:=	^[0-9]+\.[0-9]+$$
-
-SG_GIT_BRANCH					:=	$(shell git rev-parse --abbrev-ref HEAD 2>/dev/null)
-SG_GIT_TAG						:=	$(shell git describe --tags --abbrev=0 2>/dev/null)
-SG_GIT_COMMIT					:=	$(shell git rev-parse --short HEAD 2>/dev/null)
-SG_GIT_COMMIT_NUMS_SINCE_TAG	:=	$(shell git rev-list --count HEAD ^`git describe --tags --abbrev=0 2>/dev/null` 2>/dev/null)
-SG_GIT_TREE_STATE				:=	$(shell test -n "`git status --porcelain 2>/dev/null`" && echo "$(SG_GIT_TREE_STATE_DIRTY)" || echo "$(SG_GIT_TREE_STATE_CLEAN)")
-SG_GIT_IS_SHALLOW_CLONE			:=	$(shell [ -d $(SG_DOT_GIT_DIR) ] && [ -f $(SG_DOT_GIT_SHALLOW_FILE) ] && echo "$(SG_GIT_YES)" || echo "$(SG_GIT_NO)")
-SG_GIT_LATEST_REMOTE_TAG		:=	$(shell git -c versionsort.suffix=- ls-remote --exit-code --refs --sort=version:refname --tags $(SG_PROJECT_GIT_REPOSITORY) '*.*.*' | tail -n 1 | sed 's/.*refs\/tags\///' 2>/dev/null)
-
-SG_PLUGIN_VERSION	:=	$(shell grep -o '"VersionName": "[^"]*"' ${SG_PLUGIN_FILE} | awk -F'"' '{print "v" $$4}')
-
-ifeq ($(strip $(SG_GIT_COMMIT_NUMS_SINCE_TAG)),)
-SG_GIT_COMMIT_NUMS_SINCE_TAG	:=	0
-endif # ($(strip $(SG_GIT_COMMIT_NUMS_SINCE_TAG)),)
-
-ifneq ($(strip $(SG_GIT_TAG)),)
-SG_GIT_VERSION	:=	$(SG_GIT_TAG)
-endif # ($(strip $(SG_GIT_TAG)),)
-
-ifeq ($(strip $(SG_GIT_VERSION)),)
-ifeq ($(strip $(SG_GIT_IS_SHALLOW_CLONE)),$(SG_GIT_YES))
-ifneq ($(strip $(SG_GIT_LATEST_REMOTE_TAG)),)
-SG_GIT_VERSION	:=	$(SG_GIT_LATEST_REMOTE_TAG)
-endif # ($(strip $(SG_GIT_LATEST_REMOTE_TAG)),)
-endif # ($(strip $(SG_GIT_IS_SHALLOW_CLONE)),$(SG_GIT_YES))
-endif # ($(strip $(SG_GIT_VERSION)),)
-
-SG_GIT_VERSION_MAJOR	:=	$(shell echo $(SG_GIT_VERSION) | cut -d '.' -f 1 | tr -d -c 0-9)
-ifeq ($(SG_GIT_VERSION_MAJOR),)
-SG_GIT_VERSION_MAJOR	:=	0
-endif # ($(SG_GIT_VERSION_MAJOR),)
-
-SG_GIT_VERSION_MINOR	:=	$(shell echo $(SG_GIT_VERSION) | cut -d '.' -f 2 | tr -d -c 0-9)
-ifeq ($(SG_GIT_VERSION_MINOR),)
-SG_GIT_VERSION_MINOR	:=	0
-endif # ($(SG_GIT_VERSION_MINOR),)
-
-SG_GIT_VERSION_PATCH	:=	$(shell echo $(SG_GIT_VERSION) | cut -d '.' -f 3 | tr -d -c 0-9)
-ifeq ($(SG_GIT_VERSION_PATCH),)
-SG_GIT_VERSION_PATCH	:=	0
-endif # ($(SG_GIT_VERSION_PATCH),)
-
-SG_PLUGIN_VERSION_MAJOR	:=	$(shell echo $(SG_PLUGIN_VERSION) | cut -d '.' -f 1 | tr -d -c 0-9)
-ifeq ($(SG_PLUGIN_VERSION_MAJOR),)
-SG_PLUGIN_VERSION_MAJOR	:=	0
-endif
-
-SG_PLUGIN_VERSION_MINOR	:=	$(shell echo $(SG_PLUGIN_VERSION) | cut -d '.' -f 2 | tr -d -c 0-9)
-ifeq ($(SG_PLUGIN_VERSION_MINOR),)
-SG_PLUGIN_VERSION_MINOR	:=	0
-endif # ($(SG_PLUGIN_VERSION_MINOR),)
-
-SG_PLUGIN_VERSION_PATCH	:=	$(shell echo $(SG_PLUGIN_VERSION) | cut -d '.' -f 3 | tr -d -c 0-9)
-ifeq ($(SG_PLUGIN_VERSION_PATCH),)
-SG_PLUGIN_VERSION_PATCH	:=	0
-endif # ($(SG_PLUGIN_VERSION_PATCH),)
-
-SG_BUILD_HOST	:=	$(shell hostname)
-SG_BUILD_TIME	:=	$(shell date '+%a %b %d, %Y %H:%M %Z %z')
-
-ifeq ($(strip $(SG_GIT_BRANCH)),dev)
-ifeq ($(strip $(SG_GIT_TAG)),)
-SG_HANDBOOK_REVISION	:=	next
-endif # ($(strip $(SG_GIT_TAG)),)
-endif # ($(strip $(SG_GIT_BRANCH)),dev)
-
-SG_IS_GIT_BRANCH_HEAD_OR_MASTER := $(or $(filter HEAD,$(strip $(SG_GIT_BRANCH))),$(filter master,$(strip $(SG_GIT_BRANCH))))
-
-ifneq ($(SG_IS_GIT_BRANCH_HEAD_OR_MASTER),)
-ifeq ($(strip $(SG_GIT_COMMIT_NUMS_SINCE_TAG)),0)
-ifeq ($(strip $(SG_GIT_TREE_STATE)),$(SG_GIT_TREE_STATE_CLEAN))
-ifeq ($(strip $(SG_GIT_VERSION)),$(strip $(SG_PLUGIN_VERSION)))
-SG_HANDBOOK_REVISION	:=	$(SG_PLUGIN_VERSION_MAJOR).$(SG_PLUGIN_VERSION_MINOR)
-endif # ($(strip $(SG_GIT_VERSION)),$(strip $(SG_PLUGIN_VERSION)))
-endif # ($(strip $(SG_GIT_TREE_STATE)),$(SG_GIT_TREE_STATE_CLEAN))
-endif # ($(strip $(SG_GIT_COMMIT_NUMS_SINCE_TAG)),0)
-endif # ($(SG_IS_GIT_BRANCH_HEAD_OR_MASTER),)
-
-ifeq ($(strip $(SG_GIT_IS_SHALLOW_CLONE)),$(SG_GIT_YES))
-SG_IS_GIT_BRANCH_RELEASE	:=	$(shell echo $(SG_GIT_BRANCH) | grep -E '$(SG_RELEASE_BRANCH_PATTERN)' || echo "")
-ifneq ($(SG_IS_GIT_BRANCH_RELEASE),)
-ifeq ($(strip $(SG_GIT_VERSION)),$(strip $(SG_PLUGIN_VERSION)))
-SG_HANDBOOK_REVISION	:=	$(SG_PLUGIN_VERSION_MAJOR).$(SG_PLUGIN_VERSION_MINOR)
-endif # ($(strip $(SG_GIT_VERSION)),$(strip $(SG_PLUGIN_VERSION)))
-endif # ($(SG_IS_GIT_BRANCH_RELEASE),)
-endif # ($(strip $(SG_GIT_IS_SHALLOW_CLONE)),$(SG_GIT_YES))
-
-ifeq ($(strip $(SG_HANDBOOK_REVISION)),)
-SG_HANDBOOK_REVISION	:=	mismatched
-endif # ($(strip $(SG_HANDBOOK_REVISION)),)
-
-ifneq ($(strip $(SG_HANDBOOK_REVISION)),mismatched)
-SG_MDBOOK_HTML_SITE_URL		:=	$(SG_HANDBOOK_REVISION)
-SG_HANDBOOK_REVISION_URL	:=	$(SG_DOCUMENTATION_URL)/$(SG_HANDBOOK_REVISION)
-SG_HANDBOOK_RELEASE_NAME	:=	$(shell echo $(SG_PROJECT_NAME)-$(SG_HANDBOOK_REVISION) | tr '[:upper:]' '[:lower:]' | sed 's/ /-/g')
-SG_HANDBOOK_PDF_URL			:=	$(SG_HANDBOOK_REVISION_URL)/$(SG_HANDBOOK_RELEASE_NAME).pdf
-SG_HANDBOOK_EPUB_URL		:=	$(SG_HANDBOOK_REVISION_URL)/$(SG_HANDBOOK_RELEASE_NAME).epub
-endif # ($(strip $(SG_HANDBOOK_REVISION)),mismatched)
-
-################################################################################
-# mdbook-pdf Configuration
-################################################################################
-
-ifneq ($(strip $(SG_HANDBOOK_REVISION)),mismatched)
-SG_MDBOOK_HTML_SITE_URL	:=	/$(SG_HANDBOOK_REVISION)/
-endif # ($(strip $(SG_HANDBOOK_REVISION)),mismatched)
-
-ifeq ($(SG_BUILD_PLATFORM),$(SG_BUILD_PLATFORM_LINUX))
-SG_MDBOOK_PDF_BROWSER_BINARY_PATH	:=	$(SG_BROWSER_BINARY_PATH_LINUX)
-else ifeq ($(SG_BUILD_PLATFORM),$(SG_BUILD_PLATFORM_WINDOWS))
-SG_MDBOOK_PDF_BROWSER_BINARY_PATH	:=	$(SG_BROWSER_BINARY_PATH_WINDOWS)
-else # ($(SG_BUILD_PLATFORM),$(SG_BUILD_PLATFORM_LINUX))
-$(error The target operating system is not supported!)
-endif # ($(SG_BUILD_PLATFORM),$(SG_BUILD_PLATFORM_LINUX))
-
-ifeq ($(SG_BUILD_PLATFORM),$(SG_BUILD_PLATFORM_LINUX))
-SG_LINUX_PYTHON_VENV_DIR		:=	$(shell mktemp -d)/sg-ue-handbook-venv
-SG_LINUX_PYTHON_VENV_BIN_DIR	:=	$(SG_LINUX_PYTHON_VENV_DIR)/bin
-export PATH			:=	$(SG_LINUX_PYTHON_VENV_BIN_DIR):$(PATH)
-export PWD			:=	$(SG_LINUX_PYTHON_VENV_BIN_DIR)
-export VIRTUAL_ENV	:=	$(SG_LINUX_PYTHON_VENV_DIR)
-else ifeq ($(SG_BUILD_PLATFORM),$(SG_BUILD_PLATFORM_WINDOWS))
-SG_DIST_DIR						:=	$(SG_HANDBOOK_DIR)/dist
-SG_WINPYTHON_DIR				:=	$(SG_DIST_DIR)/winpython
-SG_WINPYTHON_BIN_DIR			:=	$(SG_WINPYTHON_DIR)//python-3.12.4.amd64
-SG_WINPYTHON_BIN_SCRIPTS_DIR	:=	$(SG_WINPYTHON_BIN_DIR)/Scripts
-SG_WINPYTHON_SCRIPTS_DIR		:=	$(SG_WINPYTHON_DIR)/scripts
-export PATH	:=	$(SG_WINPYTHON_SCRIPTS_DIR);$(PATH)
-export PATH	:=	$(SG_WINPYTHON_BIN_SCRIPTS_DIR);$(PATH)
-export PATH	:=	$(SG_WINPYTHON_BIN_DIR);$(PATH)
-export PATH	:=	$(SG_RSYNC_BIN_PATH_WINDOWS);$(PATH)
-else # ($(SG_BUILD_PLATFORM),$(SG_BUILD_PLATFORM_LINUX))
-$(error The target operating system is not supported!)
-endif # ($(SG_BUILD_PLATFORM),$(SG_BUILD_PLATFORM_LINUX))
-
-################################################################################
-# Deployment Configuration
-################################################################################
-
-ifeq ($(SG_BUILD_PLATFORM),$(SG_BUILD_PLATFORM_LINUX))
-SG_HANDBOOK_DEPLOY_CONFIG_FILE	:= $(shell echo ~/.config/$(SG_HANDBOOK_CONFIG_HOME_DIR)/$(SG_HANDBOOK_DEPLOY_CONFIG_FILENAME))
-else ifeq ($(SG_BUILD_PLATFORM),$(SG_BUILD_PLATFORM_WINDOWS))
-SG_HANDBOOK_DEPLOY_CONFIG_FILE	:=	$(shell cygpath -u $(LOCALAPPDATA)/$(SG_HANDBOOK_CONFIG_HOME_DIR)/$(SG_HANDBOOK_DEPLOY_CONFIG_FILENAME))
-else # ($(SG_BUILD_PLATFORM),$(SG_BUILD_PLATFORM_LINUX))
-$(error The target operating system is not supported!)
-endif # ($(SG_BUILD_PLATFORM),$(SG_BUILD_PLATFORM_LINUX))
-
-################################################################################
-# Deployment Temporary Directory Setup
-################################################################################
-
-$(info Setting up a deployment temporary directory '$(SG_HANDBOOK_DEPLOY_TEMP_DIR_NAME)')
-SG_HANDBOOK_DEPLOY_TEMP_DIR	:=	$(shell mktemp -d -t $(SG_HANDBOOK_DEPLOY_TEMP_DIR_NAME))
-$(info Temporary directory has been set up at '$(SG_HANDBOOK_DEPLOY_TEMP_DIR)')
-
-SG_HANDBOOK_DEPLOY_GENERATED_PDF_FILE	:=	$(SG_HANDBOOK_DEPLOY_TEMP_DIR)/$(SG_HANDBOOK_RELEASE_NAME).pdf
-SG_HANDBOOK_DEPLOY_GENERATED_EPUB_FILE	:=	$(SG_HANDBOOK_DEPLOY_TEMP_DIR)/$(SG_HANDBOOK_RELEASE_NAME).epub
-
-SG_HANDBOOK_DEPLOY_REVISION_LIST_FILE	:=	$(SG_HANDBOOK_DEPLOY_TEMP_DIR)/revisions.txt
-
-SG_HANDBOOK_DEPLOY_GENERATED_HOME_INDEX_FILE	:=	$(SG_HANDBOOK_DEPLOY_TEMP_DIR)/index.html
-
-################################################################################
-# Env Configuration Functions
-################################################################################
-
-define load_env
-    $(eval ENV_FILE := $(1))
-    @echo "Loading configuration file '$(ENV_FILE)'..."
-    $(eval include $(ENV_FILE))
-    $(eval export)
-endef
-
-################################################################################
-# Make Targets - All
-################################################################################
-
-.PHONY: all
-all: help
-
-################################################################################
-# Make Targets - Misc
-################################################################################
-
-.PHONY: help
-help:
-	@echo ""
-	@echo "Available make targets:"
-	@echo ""
-	@echo "  - make build"
-	@echo "  - make clean"
-	@echo "  - make deploy"
-	@echo "  - make help"
-	@echo "  - make info"
-	@echo "  - make pack"
-	@echo "  - make serve"
-	@echo ""
-
-.PHONY: info
-info:
-	@echo ""
-	@echo "$(SG_PROJECT_NAME) build information:"
-	@echo ""
-	@echo "  - Handbook Revision     :  $(SG_HANDBOOK_REVISION)"
-	@echo "  - Handbook Revision URL :  $(SG_HANDBOOK_REVISION_URL)"
-	@echo "  - Handbook PDF URL      :  $(SG_HANDBOOK_PDF_URL)"
-	@echo "  - Handbook ePub URL     :  $(SG_HANDBOOK_EPUB_URL)"
-	@echo "  - Git Branch            :  $(SG_GIT_BRANCH)"
-	@echo "  - Git Tag               :  $(SG_GIT_TAG)"
-	@echo "  - Git Commit            :  $(SG_GIT_COMMIT)"
-	@echo "  - Git Commits Since Tag :  $(SG_GIT_COMMIT_NUMS_SINCE_TAG)"
-	@echo "  - Git Tree State        :  $(SG_GIT_TREE_STATE)"
-	@echo "  - Git Is Shallow Clone  :  $(SG_GIT_IS_SHALLOW_CLONE)"
-	@echo "  - Git Latest Remote Tag :  $(SG_GIT_LATEST_REMOTE_TAG)"
-	@echo "  - Git Version           :  $(SG_GIT_VERSION)"
-	@echo "  - Git Version Major     :  $(SG_GIT_VERSION_MAJOR)"
-	@echo "  - Git Version Minor     :  $(SG_GIT_VERSION_MINOR)"
-	@echo "  - Git Version Patch     :  $(SG_GIT_VERSION_PATCH)"
-	@echo "  - Plugin Version        :  $(SG_PLUGIN_VERSION)"
-	@echo "  - Plugin Version Major  :  $(SG_PLUGIN_VERSION_MAJOR)"
-	@echo "  - Plugin Version Minor  :  $(SG_PLUGIN_VERSION_MINOR)"
-	@echo "  - Plugin Version Patch  :  $(SG_PLUGIN_VERSION_PATCH)"
-	@echo "  - Build Host            :  $(SG_BUILD_HOST)"
-	@echo "  - Build Time            :  $(SG_BUILD_TIME)"
-	@echo ""
-
-.PHONY: clean
-clean:
-	@echo "Cleaning up $(SG_PROJECT_NAME)..."
-	@rm -rf "$(SG_MDBOOK_DEST_DIR)"
-	@echo "$(SG_PROJECT_NAME) has been cleaned up successfully!"
-
-.PHONY: install-build-deps
-install-build-deps:
-	@echo "Installing build dependencies if they have not already been installed..."
-	@cargo install mdbook --vers "^0.4" --locked
-	@cargo install xq --vers "^0.4" --locked
-	@cargo install mdbook-alerts --vers "^0.7" --locked
-	@cargo install mdbook-pdf --vers "^0.1" --locked
-ifeq ($(SG_BUILD_PLATFORM),$(SG_BUILD_PLATFORM_LINUX))
-	@echo "Installing mdbook-pdf-outline..."
-	@python -m venv $(VIRTUAL_ENV) \
-		&& . $(SG_LINUX_PYTHON_VENV_BIN_DIR)/activate \
-		&& pip install mdbook-pdf-outline 2>/dev/null
-endif # ($(SG_BUILD_PLATFORM),$(SG_BUILD_PLATFORM_LINUX))
-	@cargo install --git https://github.com/Michael-F-Bryan/mdbook-epub --rev d1536bbbdc1ca00320522ad73a967e15057ef573 --locked
-
-################################################################################
-# Make Targets - mdBook
-################################################################################
-
-.PHONY: prepare
-prepare:
-	@echo "Preparing the handbook $(SG_HANDBOOK_DIR)..."
-prepare: prepare-src
-prepare: prepare-dest
-
-.PHONY: prepare-dest
-prepare-dest:
-	@echo "Preparing the handbook target dir $(SG_MDBOOK_DEST_DIR)..."
-
-.PHONY: prepare-src
-prepare-src:
-	@echo "Preparing the handbook source dir $(SG_MDBOOK_SRC_DIR)..."
-
-.PHONY: verify-handbook-revision
-verify-handbook-revision:
-ifeq ($(SG_HANDBOOK_REVISION), next)
-	@echo "Building an unstable handbook for the next release..."
-else # ($(SG_HANDBOOK_REVISION), next)
-ifeq ($(SG_HANDBOOK_REVISION), mismatched)
-	@echo ""
-	@echo "Failed to verify the handbook build due to some discrepancies. Please verify the following:"
-	@echo ""
-	@echo "If you're building a release handbook:"
-	@echo "    - You are either on a release tag, e.g. v2.1.0, or on the master branch."
-	@echo "    - No commit has been made since the targeted tag."
-	@echo "    - The Git tree state is clean."
-	@echo "    - The Git version and plugin version match each other."
-	@echo ""
-	@echo "If you're building an unstable handbook for the next release:"
-	@echo "    - You're building from the dev branch."
-	@echo "    - The Git version value evaluates to empty."
-	@echo ""
-	@echo "If you're packaging the handbook:"
-	@echo "    - You're on a release branch."
-	@echo "    - You're shallow cloning."
-	@echo "    - The remorte Git repository contains releae tags."
-	@echo ""
-	@exit 1
-else # ($(SG_HANDBOOK_REVISION), mismatched)
-	@echo "Building a release handbook: $(SG_HANDBOOK_REVISION)..."
-endif # ($(SG_HANDBOOK_REVISION), mismatched)
-endif # ($(SG_HANDBOOK_REVISION), next)
-
-.PHONY: serve
-serve: info
-serve: install-build-deps
-serve: prepare
-serve: _mdbook_serve
-
-.PHONY: build
-build: info
-build: install-build-deps
-build: prepare
-build: verify-handbook-revision
-build: _mdbook_build
-
-.PHONY: pack
-pack: info
-pack: install-build-deps
-pack: prepare
-pack: verify-handbook-revision
-pack: _mdbook_build
-pack: _pack
-
-.PHONY: deploy
-deploy: info
-deploy: install-build-deps
-deploy: clean
-deploy: prepare
-deploy: verify-handbook-revision
-deploy: _mdbook_build
-deploy: _deploy
-
-.PHONY: _mdbook_serve
-_mdbook_serve:
-	@echo "Serving $(SG_HANDBOOK_DIR)..."
-	@env SG_PROJECT_NAME='$(SG_PROJECT_NAME)' \
-		SG_HANDBOOK_REVISION='$(SG_HANDBOOK_REVISION)' \
-		SG_HANDBOOK_REVISION_URL='$(SG_HANDBOOK_REVISION_URL)' \
-		SG_HANDBOOK_PDF_URL='$(SG_HANDBOOK_PDF_URL)' \
-		SG_HANDBOOK_EPUB_URL='$(SG_HANDBOOK_EPUB_URL)' \
-		SG_GIT_BRANCH='$(SG_GIT_BRANCH)' \
-		SG_GIT_TAG='$(SG_GIT_TAG)' \
-		SG_GIT_COMMIT='$(SG_GIT_COMMIT)' \
-		SG_GIT_COMMIT_NUMS_SINCE_TAG='$(SG_GIT_COMMIT_NUMS_SINCE_TAG)' \
-		SG_GIT_TREE_STATE='$(SG_GIT_TREE_STATE)' \
-		SG_GIT_IS_SHALLOW_CLONE='$(SG_GIT_IS_SHALLOW_CLONE)' \
-		SG_GIT_LATEST_REMOTE_TAG='$(SG_GIT_LATEST_REMOTE_TAG)' \
-		SG_GIT_VERSION='$(SG_GIT_VERSION)' \
-		SG_GIT_VERSION_MAJOR='$(SG_GIT_VERSION_MAJOR)' \
-		SG_GIT_VERSION_MINOR='$(SG_GIT_VERSION_MINOR)' \
-		SG_GIT_VERSION_PATCH='$(SG_GIT_VERSION_PATCH)' \
-		SG_PLUGIN_VERSION='$(SG_PLUGIN_VERSION)' \
-		SG_PLUGIN_VERSION_MAJOR='$(SG_PLUGIN_VERSION_MAJOR)' \
-		SG_PLUGIN_VERSION_MINOR='$(SG_PLUGIN_VERSION_MINOR)' \
-		SG_PLUGIN_VERSION_PATCH='$(SG_PLUGIN_VERSION_PATCH)' \
-		SG_BUILD_HOST='$(SG_BUILD_HOST)' \
-		SG_BUILD_TIME='$(SG_BUILD_TIME)' \
-		MDBOOK_output__html__site_url='$(SG_MDBOOK_HTML_SITE_URL)' \
-		MDBOOK_output__pdf__browser_binary_path='$(SG_MDBOOK_PDF_BROWSER_BINARY_PATH)' \
-			mdbook serve \
-				-n $(SG_MDBOOK_HOST) \
-				-p $(SG_MDBOOK_PORT) \
-				--watcher $(SG_MDBOOK_WATCHER) \
-				--dest-dir $(SG_MDBOOK_DEST_DIR)
-
-.PHONY: _mdbook_build
-_mdbook_build:
-	@echo "Building $(SG_HANDBOOK_DIR)..."
-	@env SG_PROJECT_NAME='$(SG_PROJECT_NAME)' \
-		SG_HANDBOOK_REVISION='$(SG_HANDBOOK_REVISION)' \
-		SG_HANDBOOK_REVISION_URL='$(SG_HANDBOOK_REVISION_URL)' \
-		SG_HANDBOOK_PDF_URL='$(SG_HANDBOOK_PDF_URL)' \
-		SG_HANDBOOK_EPUB_URL='$(SG_HANDBOOK_EPUB_URL)' \
-		SG_GIT_BRANCH='$(SG_GIT_BRANCH)' \
-		SG_GIT_TAG='$(SG_GIT_TAG)' \
-		SG_GIT_COMMIT='$(SG_GIT_COMMIT)' \
-		SG_GIT_COMMIT_NUMS_SINCE_TAG='$(SG_GIT_COMMIT_NUMS_SINCE_TAG)' \
-		SG_GIT_TREE_STATE='$(SG_GIT_TREE_STATE)' \
-		SG_GIT_IS_SHALLOW_CLONE='$(SG_GIT_IS_SHALLOW_CLONE)' \
-		SG_GIT_LATEST_REMOTE_TAG='$(SG_GIT_LATEST_REMOTE_TAG)' \
-		SG_GIT_VERSION='$(SG_GIT_VERSION)' \
-		SG_GIT_VERSION_MAJOR='$(SG_GIT_VERSION_MAJOR)' \
-		SG_GIT_VERSION_MINOR='$(SG_GIT_VERSION_MINOR)' \
-		SG_GIT_VERSION_PATCH='$(SG_GIT_VERSION_PATCH)' \
-		SG_PLUGIN_VERSION='$(SG_PLUGIN_VERSION)' \
-		SG_PLUGIN_VERSION_MAJOR='$(SG_PLUGIN_VERSION_MAJOR)' \
-		SG_PLUGIN_VERSION_MINOR='$(SG_PLUGIN_VERSION_MINOR)' \
-		SG_PLUGIN_VERSION_PATCH='$(SG_PLUGIN_VERSION_PATCH)' \
-		SG_BUILD_HOST='$(SG_BUILD_HOST)' \
-		SG_BUILD_TIME='$(SG_BUILD_TIME)' \
-		MDBOOK_output__html__site_url='$(SG_MDBOOK_HTML_SITE_URL)' \
-		MDBOOK_output__pdf__browser_binary_path='$(SG_MDBOOK_PDF_BROWSER_BINARY_PATH)' \
-			mdbook build \
-				--dest-dir $(SG_MDBOOK_DEST_DIR)
-
-.PHONY: _pack
-_pack:
-	@echo "Packing '$(SG_HANDBOOK_DIR)'..."
-	@echo "Cleaning up the pack directory '$(SG_DOCUMENTATION_PACK_DIR)'..."
-	@rm -rf "$(SG_DOCUMENTATION_PACK_DIR)"
-	@echo "Creating the pack directory '$(SG_DOCUMENTATION_PACK_DIR)'..."
-	@mkdir -p "$(SG_DOCUMENTATION_PACK_DIR)"
-	@echo "Moving '$(SG_DOCUMENTATION_HTML_DIR)' to '$(SG_HANDBOOK_PACKED_HTML_DIR)'..."
-ifeq ($(SG_BUILD_PLATFORM),$(SG_BUILD_PLATFORM_LINUX))
-	@mv "$(SG_DOCUMENTATION_HTML_DIR)" "$(SG_HANDBOOK_PACKED_HTML_DIR)"
-else # ($(SG_BUILD_PLATFORM),$(SG_BUILD_PLATFORM_LINUX))
-	@powershell -Command "Move-Item '$(SG_DOCUMENTATION_HTML_DIR)' '$(SG_HANDBOOK_PACKED_HTML_DIR)'"
-endif # ($(SG_BUILD_PLATFORM),$(SG_BUILD_PLATFORM_LINUX))
-	@echo "Compressing '$(SG_HANDBOOK_PACKED_HTML_DIR)' to '$(SG_HANDBOOK_PACKED_HTML_FILE)'..."
-ifeq ($(SG_BUILD_PLATFORM),$(SG_BUILD_PLATFORM_LINUX))
-	@cd "$(SG_DOCUMENTATION_PACK_DIR)" \
-		&& zip $(SG_HANDBOOK_PACKED_HTML_FILE) -r $(SG_HANDBOOK_ESCAPED_NAME)
-else # ($(SG_BUILD_PLATFORM),$(SG_BUILD_PLATFORM_LINUX))
-	@cd "$(SG_DOCUMENTATION_PACK_DIR)" \
-		&& powershell Compress-Archive $(SG_HANDBOOK_ESCAPED_NAME) $(SG_HANDBOOK_PACKED_HTML_FILE)
-endif # ($(SG_BUILD_PLATFORM),$(SG_BUILD_PLATFORM_LINUX))
-	@echo "Moving '$(SG_DOCUMENTATION_PDF_FILE)' to '$(SG_HANDBOOK_PACKED_PDF_FILE)'..."
-ifeq ($(SG_BUILD_PLATFORM),$(SG_BUILD_PLATFORM_LINUX))
-	@mv "$(SG_DOCUMENTATION_PDF_FILE)" "$(SG_HANDBOOK_PACKED_PDF_FILE)"
-else # ($(SG_BUILD_PLATFORM),$(SG_BUILD_PLATFORM_LINUX))
-	@powershell -Command "Move-Item '$(SG_DOCUMENTATION_PDF_FILE)' '$(SG_HANDBOOK_PACKED_PDF_FILE)'"
-endif # ($(SG_BUILD_PLATFORM),$(SG_BUILD_PLATFORM_LINUX))
-	@echo "Moving '$(SG_DOCUMENTATION_EPUB_FILE)' to '$(SG_HANDBOOK_PACKED_EPUB_FILE)'..."
-ifeq ($(SG_BUILD_PLATFORM),$(SG_BUILD_PLATFORM_LINUX))
-	@mv "$(SG_DOCUMENTATION_EPUB_FILE)" "$(SG_HANDBOOK_PACKED_EPUB_FILE)"
-else # ($(SG_BUILD_PLATFORM),$(SG_BUILD_PLATFORM_LINUX))
-	@powershell -Command "Move-Item '$(SG_DOCUMENTATION_EPUB_FILE)' '$(SG_HANDBOOK_PACKED_EPUB_FILE)'"
-endif # ($(SG_BUILD_PLATFORM),$(SG_BUILD_PLATFORM_LINUX))
-
-.PHONY: _deploy
-_deploy:
-	@echo "Deploying '$(SG_HANDBOOK_DIR)'..."
-	@echo "Loading the Handbook deployment configuration file..."
-	@$(call load_env, $(SG_HANDBOOK_DEPLOY_CONFIG_FILE))
-	@echo "Deploying '$(SG_HANDBOOK_DIR)' to '$(SG_HANDBOOK_SSH_USER)@$(SG_HANDBOOK_SSH_HOST):$(SG_HANDBOOK_SSH_REMOTE_DIR)/$(SG_HANDBOOK_REVISION)'..."
-ifeq ($(SG_BUILD_PLATFORM),$(SG_BUILD_PLATFORM_LINUX))
-	@rsync \
-		-avze "ssh -p $(SG_HANDBOOK_SSH_PORT)" \
-		--perms \
-		--chmod=u+rwx,g+rx,o+rx,g-w,o-wx \
-		--delete $(SG_DOCUMENTATION_HTML_DIR)/ \
-		$(SG_HANDBOOK_SSH_USER)@$(SG_HANDBOOK_SSH_HOST):$(SG_HANDBOOK_SSH_REMOTE_DIR)/$(SG_HANDBOOK_REVISION)
-else # ($(SG_BUILD_PLATFORM),$(SG_BUILD_PLATFORM_LINUX))
-	@cd "$(SG_DOCUMENTATION_DIR)" \
-		&& "$(SG_RSYNC_BINARY_PATH_WINDOWS)" \
-			-avze "\"$(SG_RSYNC_SSH_BINARY_PATH_WINDOWS)\" -p $(SG_HANDBOOK_SSH_PORT)" \
-			--perms \
-			--chmod=u+rwx,g+rx,o+rx,g-w,o-wx \
-			--delete $(SG_DOCUMENTATION_HTML_DIR_NAME)/ \
-			$(SG_HANDBOOK_SSH_USER)@$(SG_HANDBOOK_SSH_HOST):$(SG_HANDBOOK_SSH_REMOTE_DIR)/$(SG_HANDBOOK_REVISION)
-endif # ($(SG_BUILD_PLATFORM),$(SG_BUILD_PLATFORM_LINUX))
-	@echo "Copying '$(SG_DOCUMENTATION_PDF_FILE)' to '$(SG_HANDBOOK_DEPLOY_GENERATED_PDF_FILE)'..."
-	@cp -v "$(SG_DOCUMENTATION_PDF_FILE)" "$(SG_HANDBOOK_DEPLOY_GENERATED_PDF_FILE)"
-	@echo "Uploading '$(SG_HANDBOOK_DEPLOY_GENERATED_PDF_FILE)' to '$(SG_HANDBOOK_SSH_USER)@$(SG_HANDBOOK_SSH_HOST):$(SG_HANDBOOK_SSH_REMOTE_DIR)/$(SG_HANDBOOK_REVISION)'..."
-	@scp \
-		-P $(SG_HANDBOOK_SSH_PORT) \
-		"$(SG_HANDBOOK_DEPLOY_GENERATED_PDF_FILE)" \
-		$(SG_HANDBOOK_SSH_USER)@$(SG_HANDBOOK_SSH_HOST):$(SG_HANDBOOK_SSH_REMOTE_DIR)/$(SG_HANDBOOK_REVISION)
-	@echo "Copying '$(SG_DOCUMENTATION_EPUB_FILE)' to '$(SG_HANDBOOK_DEPLOY_GENERATED_EPUB_FILE)'..."
-	@cp -v "$(SG_DOCUMENTATION_EPUB_FILE)" "$(SG_HANDBOOK_DEPLOY_GENERATED_EPUB_FILE)"
-	@echo "Uploading '$(SG_HANDBOOK_DEPLOY_GENERATED_EPUB_FILE)' to '$(SG_HANDBOOK_SSH_USER)@$(SG_HANDBOOK_SSH_HOST):$(SG_HANDBOOK_SSH_REMOTE_DIR)/$(SG_HANDBOOK_REVISION)'..."
-	@scp \
-		-P $(SG_HANDBOOK_SSH_PORT) \
-		"$(SG_HANDBOOK_DEPLOY_GENERATED_EPUB_FILE)" \
-		$(SG_HANDBOOK_SSH_USER)@$(SG_HANDBOOK_SSH_HOST):$(SG_HANDBOOK_SSH_REMOTE_DIR)/$(SG_HANDBOOK_REVISION)
-	@echo "Retrieving the list of deployed handbook revisions from '$(SG_HANDBOOK_SSH_USER)@$(SG_HANDBOOK_SSH_HOST):$(SG_HANDBOOK_SSH_PORT)/$(SG_HANDBOOK_SSH_REMOTE_DIR)'..."
-	@ssh \
-		-p $(SG_HANDBOOK_SSH_PORT) $(SG_HANDBOOK_SSH_USER)@$(SG_HANDBOOK_SSH_HOST) \
-		"mkdir -p $(SG_HANDBOOK_SSH_REMOTE_DIR)"
-	@ssh \
-		-p $(SG_HANDBOOK_SSH_PORT) $(SG_HANDBOOK_SSH_USER)@$(SG_HANDBOOK_SSH_HOST) \
-		"find $(SG_HANDBOOK_SSH_REMOTE_DIR) -maxdepth 1 -type d ! -path $(SG_HANDBOOK_SSH_REMOTE_DIR) -exec basename {} \; | sort -r" \
-		> $(SG_HANDBOOK_DEPLOY_REVISION_LIST_FILE)
-	@{ \
-		grep -i 'next' $(SG_HANDBOOK_DEPLOY_REVISION_LIST_FILE); \
-		grep -vi 'next' $(SG_HANDBOOK_DEPLOY_REVISION_LIST_FILE) \
-		| sort -r; \
-	} > "$(SG_HANDBOOK_DEPLOY_REVISION_LIST_FILE).tmp"
-	@mv "$(SG_HANDBOOK_DEPLOY_REVISION_LIST_FILE).tmp" "$(SG_HANDBOOK_DEPLOY_REVISION_LIST_FILE)"
-	@echo "Revisions list saved to '$(SG_HANDBOOK_DEPLOY_REVISION_LIST_FILE)'!"
-	@echo "Current revisions:"
-	@sed 's/^/ - /' "$(SG_HANDBOOK_DEPLOY_REVISION_LIST_FILE)"
-	@echo "Generating '$(SG_HANDBOOK_DEPLOY_GENERATED_HOME_INDEX_FILE)'..."
-	@echo "<html>" > "$(SG_HANDBOOK_DEPLOY_GENERATED_HOME_INDEX_FILE)"
-	@echo "<head>" >> "$(SG_HANDBOOK_DEPLOY_GENERATED_HOME_INDEX_FILE)"
-	@echo "<title>Welcome to $(SG_PROJECT_NAME)</title>" >> "$(SG_HANDBOOK_DEPLOY_GENERATED_HOME_INDEX_FILE)"
-	@echo "<link rel='icon' href='favicon.svg'>" >> "$(SG_HANDBOOK_DEPLOY_GENERATED_HOME_INDEX_FILE)"
-	@echo "<link rel='shortcut icon' href='favicon.svg'>" >> "$(SG_HANDBOOK_DEPLOY_GENERATED_HOME_INDEX_FILE)"
-	@echo "<style>" >> "$(SG_HANDBOOK_DEPLOY_GENERATED_HOME_INDEX_FILE)"
-	@echo "body {" >> "$(SG_HANDBOOK_DEPLOY_GENERATED_HOME_INDEX_FILE)"
-	@echo "font-family: Arial, sans-serif;" >> "$(SG_HANDBOOK_DEPLOY_GENERATED_HOME_INDEX_FILE)"
-	@echo "background-color: #003070;" >> "$(SG_HANDBOOK_DEPLOY_GENERATED_HOME_INDEX_FILE)"
-	@echo "color: #fff;" >> "$(SG_HANDBOOK_DEPLOY_GENERATED_HOME_INDEX_FILE)"
-	@echo "margin: 0;" >> "$(SG_HANDBOOK_DEPLOY_GENERATED_HOME_INDEX_FILE)"
-	@echo "padding: 0;" >> "$(SG_HANDBOOK_DEPLOY_GENERATED_HOME_INDEX_FILE)"
-	@echo "}" >> "$(SG_HANDBOOK_DEPLOY_GENERATED_HOME_INDEX_FILE)"
-	@echo ".container {" >> "$(SG_HANDBOOK_DEPLOY_GENERATED_HOME_INDEX_FILE)"
-	@echo "padding: 2.0em;" >> "$(SG_HANDBOOK_DEPLOY_GENERATED_HOME_INDEX_FILE)"
-	@echo "}" >> "$(SG_HANDBOOK_DEPLOY_GENERATED_HOME_INDEX_FILE)"
-	@echo ".logo-container {" >> "$(SG_HANDBOOK_DEPLOY_GENERATED_HOME_INDEX_FILE)"
-	@echo "text-align: center;" >> "$(SG_HANDBOOK_DEPLOY_GENERATED_HOME_INDEX_FILE)"
-	@echo "}" >> "$(SG_HANDBOOK_DEPLOY_GENERATED_HOME_INDEX_FILE)"
-	@echo ".logo-container img {" >> "$(SG_HANDBOOK_DEPLOY_GENERATED_HOME_INDEX_FILE)"
-	@echo "max-width: 100%;" >> "$(SG_HANDBOOK_DEPLOY_GENERATED_HOME_INDEX_FILE)"
-	@echo "height: auto;" >> "$(SG_HANDBOOK_DEPLOY_GENERATED_HOME_INDEX_FILE)"
-	@echo "}" >> "$(SG_HANDBOOK_DEPLOY_GENERATED_HOME_INDEX_FILE)"
-	@echo ".title-container {" >> "$(SG_HANDBOOK_DEPLOY_GENERATED_HOME_INDEX_FILE)"
-	@echo "text-align: center;" >> "$(SG_HANDBOOK_DEPLOY_GENERATED_HOME_INDEX_FILE)"
-	@echo "}" >> "$(SG_HANDBOOK_DEPLOY_GENERATED_HOME_INDEX_FILE)"
-	@echo ".revisions-container {" >> "$(SG_HANDBOOK_DEPLOY_GENERATED_HOME_INDEX_FILE)"
-	@echo "display: table;" >> "$(SG_HANDBOOK_DEPLOY_GENERATED_HOME_INDEX_FILE)"
-	@echo "width: 300px;" >> "$(SG_HANDBOOK_DEPLOY_GENERATED_HOME_INDEX_FILE)"
-	@echo "margin: 0 auto;" >> "$(SG_HANDBOOK_DEPLOY_GENERATED_HOME_INDEX_FILE)"
-	@echo "padding: 20px;" >> "$(SG_HANDBOOK_DEPLOY_GENERATED_HOME_INDEX_FILE)"
-	@echo "}" >> "$(SG_HANDBOOK_DEPLOY_GENERATED_HOME_INDEX_FILE)"
-	@echo ".row {" >> "$(SG_HANDBOOK_DEPLOY_GENERATED_HOME_INDEX_FILE)"
-	@echo "display: table-row;" >> "$(SG_HANDBOOK_DEPLOY_GENERATED_HOME_INDEX_FILE)"
-	@echo "}" >> "$(SG_HANDBOOK_DEPLOY_GENERATED_HOME_INDEX_FILE)"
-	@echo ".cell {" >> "$(SG_HANDBOOK_DEPLOY_GENERATED_HOME_INDEX_FILE)"
-	@echo "display: table-cell;" >> "$(SG_HANDBOOK_DEPLOY_GENERATED_HOME_INDEX_FILE)"
-	@echo "background-color: #004890;" >> "$(SG_HANDBOOK_DEPLOY_GENERATED_HOME_INDEX_FILE)"
-	@echo "border-radius: 5px;" >> "$(SG_HANDBOOK_DEPLOY_GENERATED_HOME_INDEX_FILE)"
-	@echo "box-shadow: 0 4px 8px rgba(0, 0, 0, 0.1);" >> "$(SG_HANDBOOK_DEPLOY_GENERATED_HOME_INDEX_FILE)"
-	@echo "margin: 10px;" >> "$(SG_HANDBOOK_DEPLOY_GENERATED_HOME_INDEX_FILE)"
-	@echo "padding: 20px;" >> "$(SG_HANDBOOK_DEPLOY_GENERATED_HOME_INDEX_FILE)"
-	@echo "text-align: center;" >> "$(SG_HANDBOOK_DEPLOY_GENERATED_HOME_INDEX_FILE)"
-	@echo "transition: transform 0.2s;" >> "$(SG_HANDBOOK_DEPLOY_GENERATED_HOME_INDEX_FILE)"
-	@echo "}" >> "$(SG_HANDBOOK_DEPLOY_GENERATED_HOME_INDEX_FILE)"
-	@echo ".cell:hover {" >> "$(SG_HANDBOOK_DEPLOY_GENERATED_HOME_INDEX_FILE)"
-	@echo "transform: scale(1.05);" >> "$(SG_HANDBOOK_DEPLOY_GENERATED_HOME_INDEX_FILE)"
-	@echo "}" >> "$(SG_HANDBOOK_DEPLOY_GENERATED_HOME_INDEX_FILE)"
-	@echo ".cell a {" >> "$(SG_HANDBOOK_DEPLOY_GENERATED_HOME_INDEX_FILE)"
-	@echo "display: block;" >> "$(SG_HANDBOOK_DEPLOY_GENERATED_HOME_INDEX_FILE)"
-	@echo "height: 100%;" >> "$(SG_HANDBOOK_DEPLOY_GENERATED_HOME_INDEX_FILE)"
-	@echo "width: 100%;" >> "$(SG_HANDBOOK_DEPLOY_GENERATED_HOME_INDEX_FILE)"
-	@echo "text-decoration: none;" >> "$(SG_HANDBOOK_DEPLOY_GENERATED_HOME_INDEX_FILE)"
-	@echo "color: #fff;" >> "$(SG_HANDBOOK_DEPLOY_GENERATED_HOME_INDEX_FILE)"
-	@echo "font-weight: bold;" >> "$(SG_HANDBOOK_DEPLOY_GENERATED_HOME_INDEX_FILE)"
-	@echo "}" >> "$(SG_HANDBOOK_DEPLOY_GENERATED_HOME_INDEX_FILE)"
-	@echo "</style>" >> "$(SG_HANDBOOK_DEPLOY_GENERATED_HOME_INDEX_FILE)"
-	@echo "</head>" >> "$(SG_HANDBOOK_DEPLOY_GENERATED_HOME_INDEX_FILE)"
-	@echo "<body>" >> "$(SG_HANDBOOK_DEPLOY_GENERATED_HOME_INDEX_FILE)"
-	@echo "<div class='container'>" >> "$(SG_HANDBOOK_DEPLOY_GENERATED_HOME_INDEX_FILE)"
-	@echo "<div class='logo-container'>" >>  $(SG_HANDBOOK_DEPLOY_GENERATED_HOME_INDEX_FILE)
-	@echo "<img src="favicon.svg" alt='SenseGlove' />" >> "$(SG_HANDBOOK_DEPLOY_GENERATED_HOME_INDEX_FILE)"
-	@echo "</div>" >> "$(SG_HANDBOOK_DEPLOY_GENERATED_HOME_INDEX_FILE)"
-	@echo "<div class='title-container'>" >> "$(SG_HANDBOOK_DEPLOY_GENERATED_HOME_INDEX_FILE)"
-	@echo "<h1>Welcome to the SenseGlove Unreal Engine Handbook</h1>" >> "$(SG_HANDBOOK_DEPLOY_GENERATED_HOME_INDEX_FILE)"
-	@echo "<h3>Please choose a revision to continue!</h3>" >> "$(SG_HANDBOOK_DEPLOY_GENERATED_HOME_INDEX_FILE)"
-	@echo "<h5>* Please note that the next revision is the documentation for the unstable next release of the plugin and subject to change!</h5>" >> "$(SG_HANDBOOK_DEPLOY_GENERATED_HOME_INDEX_FILE)"
-	@echo "</div>" >> "$(SG_HANDBOOK_DEPLOY_GENERATED_HOME_INDEX_FILE)"
-	@echo "<div class='revisions-container'>" >> "$(SG_HANDBOOK_DEPLOY_GENERATED_HOME_INDEX_FILE)"
-	@while read dir; \
-		do \
-			echo "<div class='row'><div class='cell'><a href=\"$$dir\">$$dir</a></div></div>"; \
-		done < $(SG_HANDBOOK_DEPLOY_REVISION_LIST_FILE) >> "$(SG_HANDBOOK_DEPLOY_GENERATED_HOME_INDEX_FILE)"
-	@echo "</div>" >> "$(SG_HANDBOOK_DEPLOY_GENERATED_HOME_INDEX_FILE)"
-	@echo "</div>" >> "$(SG_HANDBOOK_DEPLOY_GENERATED_HOME_INDEX_FILE)"
-	@echo "</body>" >> "$(SG_HANDBOOK_DEPLOY_GENERATED_HOME_INDEX_FILE)"
-	@echo "</html>" >> "$(SG_HANDBOOK_DEPLOY_GENERATED_HOME_INDEX_FILE)"
-	@echo "Uploading '$(SG_HANDBOOK_FAVICON_FILE)' to '$(SG_HANDBOOK_SSH_USER)@$(SG_HANDBOOK_SSH_HOST):$(SG_HANDBOOK_SSH_REMOTE_DIR)'"
-	@scp \
-		-P $(SG_HANDBOOK_SSH_PORT) \
-		"$(SG_HANDBOOK_FAVICON_FILE)" \
-		$(SG_HANDBOOK_SSH_USER)@$(SG_HANDBOOK_SSH_HOST):$(SG_HANDBOOK_SSH_REMOTE_DIR)
-	@echo "Uploading '$(SG_HANDBOOK_DEPLOY_GENERATED_HOME_INDEX_FILE)' to '$(SG_HANDBOOK_SSH_USER)@$(SG_HANDBOOK_SSH_HOST):$(SG_HANDBOOK_SSH_REMOTE_DIR)'"
-	@scp \
-		-P $(SG_HANDBOOK_SSH_PORT) \
-		"$(SG_HANDBOOK_DEPLOY_GENERATED_HOME_INDEX_FILE)" \
-		$(SG_HANDBOOK_SSH_USER)@$(SG_HANDBOOK_SSH_HOST):$(SG_HANDBOOK_SSH_REMOTE_DIR)

Handbook/README.md

@@ -1,91 +0,0 @@
-# The SenseGlove Unreal Engine Handbook
-
-## Prerequisites
-
-- Brave Browser (for PDF generation; in case you have Brave installed in a non-conventional path, or you'd like to use a different Chromium-based browser you need to adjust the path inside the GNUmakefile).
-- cygpath (Windows only) provided by [Git for Windows](https://gitforwindows.org/).
-- GNU Make.
-- Git.
-- PowerShell (Windows only) required only by the `pack` make target.
-- Python3 along with venv and pip. For Windows, a version of [WinPython](https://winpython.github.io/) is already shipped with this repo, so it's not an external requirement.
-- Rsync and OpenSSH ([cwRsync](https://itefix.net/cwrsync) provides these for Windows) required only by the `deploy` make target.
-- The Rust Toolchain and the Cargo package manager.
-- Other common Unix utilities such as `awk`, `cp`, `cut`, `date`, `find`, `grep`, `hostname`, `mkdir`, `mktemp`, `mv`, `scp`, `sed`, `ssh`, `sort`, `tr`, and `uname` provided by most distors. On Windows these are mostly provided by [Git for Windows](https://gitforwindows.org/).
-- `zip` command (Linux only) required only by the `pack` make target.
-
-### Microsoft Windows Prerequisites Installation Notes
-
-- Download and install [Git for Windows](https://gitforwindows.org/).
-- Download and install [the Rust Toolchain](https://rustup.rs/).
-- Download [a without-guile binary build of GNU Make for Windows from ezwinports](https://sourceforge.net/projects/ezwinports/files/), e.g. <code>make-4.4.1-without-guile-w32-bin.zip</code>.
-- <code>make-\*-without-guile-w32-bin.zip/*</code> contents should be extracted and copied to your <code>Git\\mingw64\\</code>, e.g. <code>C:\\Program Files\\Git\\mingw64\\</code>, merging the folders, WITHOUT overwriting/replacing any existing files.
-- After Git Bash installation, the changes to environment variables require a reboot. In order for these changes to take effect reboot the system, then proceed to the build section.
-- Download and install [cwRsync](https://itefix.net/cwrsync) which is only required for the `deploy` make target. In case you won't intend to use that, this could be skipped.
-
-## How to preview, build, and deploy?
-
-In order to generate the handbook, on either GNU/Linux and Microsoft Windows everything is done through running the <code>make</code> command. Simply entering the <code>make</code> or <code>make help</code> inside your desired terminal will show you all the available make targets:
-
-```sh
-$ make help
-
-Available make targets:
-
-  - make build
-  - make clean
-  - make deploy
-  - make help
-  - make info
-  - make pack
-  - make serve
-```
-
-### make info
-
-This target prints the build and version information.
-
-### make clean
-
-This target cleans up the output directory for the generated handbook, which is the <code>/Documentation</code> folder.
-
-### make serve
-
-This tatget could be used for viewing or live-previwing the handbook while editing simultaneously editing it. Simply run this tatget and leave your terminal open and inside your web browser of choice head to <code>http://localhost:8000/</code>. You can modify the handbook source code inside any text editor and upon saving your web browser will refresh in realtime once a change is detected.
-
-### make build
-
-This tatget builds the final handbook and outputs it to the <code>/Documentation</code> folder.
-
-If you're building a release handbook, please make sure:
-
-- You are either on a release tag, e.g. v2.1.0, or on the master branch.
-- No commit has been made since the targeted tag.
-- The Git tree state is clean.
-- The Git version and plugin version match each other.
-
-If you're building an unstable handbook for the next release, please make sure:
-
-- You're building from the dev branch.
-- The Git version value evaluates to empty.
-
-### make deploy
-
-This tatget is used to build and upload the final draft of the handbook. This tatget first runs the <code>clean</code> target and then the <code>build</code> target; and only then attempts to upload the content. Thus, any rule that applies to the <code>build</code> target, will apply to this target as well.
-
-_Noete_: Building on Windows requires sourcing the deployment configuration file, otherwise the deployment will fail; e.g.:
-
-```sh
-$ source /c/Users/mamadou/AppData/Local/SenseGlove/ue-handbook/deploy.conf && make deploy
-```
-
-Also, on Windows you probably need to adjust the follwoing variables at the top of the `GNUmakefile`:
-
-```make
-SG_RSYNC_BIN_PATH_WINDOWS		:=	C:\Program Files\cwrsync\bin
-SG_RSYNC_BINARY_PATH_WINDOWS		:=	$(SG_RSYNC_BIN_PATH_WINDOWS)\rsync.exe
-SG_RSYNC_SSH_BINARY_PATH_WINDOWS	:=	$(SG_RSYNC_BIN_PATH_WINDOWS)\ssh.exe
-```
-
-### make pack
-
-This target is meant to be used by the `sgum-packager` utility located in the [Packager](../Packager) folder in order to deploy the documentation in various formats along with the plugin to [Fab](https://www.fab.com/).

Handbook/bin/sg-preprocessor.sh

@@ -1,106 +0,0 @@
-#!/usr/bin/env sh
-
-#
-# author: Mamadou Babaei <mamadou@senseglove.com>
-#
-# (The MIT License)
-#
-# Copyright (c) 2020 - 2025 SenseGlove
-#
-# Permission is hereby granted, free of charge, to any person obtaining a copy
-# of this software and associated documentation files (the "Software"), to deal
-# in the Software without restriction, including without limitation the rights
-# to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
-# copies of the Software, and to permit persons to whom the Software is
-# furnished to do so, subject to the following conditions:
-#
-# The above copyright notice and this permission notice shall be included in all
-# copies or substantial portions of the Software.
-#
-# THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
-# IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
-# FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
-# AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
-# LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
-# OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
-# SOFTWARE.
-#
-
-if [ "$1" = "supports" ]
-then
-    exit 0
-fi
-
-readonly JSON_INPUT=$(cat)
-
-readonly CONTEXT=$(echo "${JSON_INPUT}" | xq '.[0]')
-readonly BOOK=$(echo "${JSON_INPUT}" | xq '.[1]')
-
-escape_string() {
-    printf '%s' "$1" | sed -e 's/\\/\\\\/g' -e 's/"/\\"/g'
-}
-
-SG_PROJECT_NAME_ESCAPED=$(escape_string "${SG_PROJECT_NAME}")
-SG_HANDBOOK_REVISION_ESCAPED=$(escape_string "${SG_HANDBOOK_REVISION}")
-SG_HANDBOOK_REVISION_URL_ESCAPED=$(escape_string "${SG_HANDBOOK_REVISION_URL}")
-SG_HANDBOOK_EPUB_URL_ESCAPED=$(escape_string "${SG_HANDBOOK_EPUB_URL}")
-SG_HANDBOOK_PDF_URL_ESCAPED=$(escape_string "${SG_HANDBOOK_PDF_URL}")
-SG_GIT_BRANCH_ESCAPED=$(escape_string "${SG_GIT_BRANCH}")
-SG_GIT_TAG_ESCAPED=$(escape_string "${SG_GIT_TAG}")
-SG_GIT_COMMIT_ESCAPED=$(escape_string "${SG_GIT_COMMIT}")
-SG_GIT_COMMIT_NUMS_SINCE_TAG_ESCAPED=$(escape_string "${SG_GIT_COMMIT_NUMS_SINCE_TAG}")
-SG_GIT_TREE_STATE_ESCAPED=$(escape_string "${SG_GIT_TREE_STATE}")
-SG_GIT_IS_SHALLOW_CLONE_ESCAPED=$(escape_string "${SG_GIT_IS_SHALLOW_CLONE}")
-SG_GIT_LATEST_REMOTE_TAG_ESCAPED=$(escape_string "${SG_GIT_LATEST_REMOTE_TAG}")
-SG_GIT_VERSION_ESCAPED=$(escape_string "${SG_GIT_VERSION}")
-SG_GIT_VERSION_MAJOR_ESCAPED=$(escape_string "${SG_GIT_VERSION_MAJOR}")
-SG_GIT_VERSION_MINOR_ESCAPED=$(escape_string "${SG_GIT_VERSION_MINOR}")
-SG_GIT_VERSION_PATCH_ESCAPED=$(escape_string "${SG_GIT_VERSION_PATCH}")
-SG_PLUGIN_VERSION_ESCAPED=$(escape_string "${SG_PLUGIN_VERSION}")
-SG_PLUGIN_VERSION_MAJOR_ESCAPED=$(escape_string "${SG_PLUGIN_VERSION_MAJOR}")
-SG_PLUGIN_VERSION_MINOR_ESCAPED=$(escape_string "${SG_PLUGIN_VERSION_MINOR}")
-SG_PLUGIN_VERSION_PATCH_ESCAPED=$(escape_string "${SG_PLUGIN_VERSION_PATCH}")
-SG_BUILD_HOST_ESCAPED=$(escape_string "${SG_BUILD_HOST}")
-SG_BUILD_TIME_ESCAPED=$(escape_string "${SG_BUILD_TIME}")
-
-PARSED_BOOK=$(echo "${BOOK}" | xq "
-    .sections[] |= (
-        if has(\"Chapter\") then
-            .Chapter.content |=
-                walk(if type == \"string\" then
-                    . | gsub(\"{{ #sg-project-name }}\"; \"${SG_PROJECT_NAME_ESCAPED}\") |
-                        gsub(\"{{ #sg-handbook-revision }}\"; \"${SG_HANDBOOK_REVISION_ESCAPED}\") |
-                        gsub(\"{{ #sg-handbook-revision-url }}\"; \"${SG_HANDBOOK_REVISION_URL_ESCAPED}\") |
-                        gsub(\"{{ #sg-handbook-epub-url }}\"; \"${SG_HANDBOOK_EPUB_URL_ESCAPED}\") |
-                        gsub(\"{{ #sg-handbook-pdf-url }}\"; \"${SG_HANDBOOK_PDF_URL_ESCAPED}\") |
-                        gsub(\"{{ #sg-git-branch }}\"; \"${SG_GIT_BRANCH_ESCAPED}\") |
-                        gsub(\"{{ #sg-git-tag }}\"; \"${SG_GIT_TAG_ESCAPED}\") |
-                        gsub(\"{{ #sg-git-commit }}\"; \"${SG_GIT_COMMIT_ESCAPED}\") |
-                        gsub(\"{{ #sg-git-commit-nums-since-tag }}\"; \"${SG_GIT_COMMIT_NUMS_SINCE_TAG_ESCAPED}\") |
-                        gsub(\"{{ #sg-git-tree-state }}\"; \"${SG_GIT_TREE_STATE_ESCAPED}\") |
-                        gsub(\"{{ #sg-git-is-shallow-clone }}\"; \"${SG_GIT_IS_SHALLOW_CLONE_ESCAPED}\") |
-                        gsub(\"{{ #sg-git-latest-remote-tag }}\"; \"${SG_GIT_LATEST_REMOTE_TAG_ESCAPED}\") |
-                        gsub(\"{{ #sg-git-version }}\"; \"${SG_GIT_VERSION_ESCAPED}\") |
-                        gsub(\"{{ #sg-git-version-major }}\"; \"${SG_GIT_VERSION_MAJOR_ESCAPED}\") |
-                        gsub(\"{{ #sg-git-version-minor }}\"; \"${SG_GIT_VERSION_MINOR_ESCAPED}\") |
-                        gsub(\"{{ #sg-git-version-patch }}\"; \"${SG_GIT_VERSION_PATCH_ESCAPED}\") |
-                        gsub(\"{{ #sg-plugin-version }}\"; \"${SG_PLUGIN_VERSION_ESCAPED}\") |
-                        gsub(\"{{ #sg-plugin-version-major }}\"; \"${SG_PLUGIN_VERSION_MAJOR_ESCAPED}\") |
-                        gsub(\"{{ #sg-plugin-version-minor }}\"; \"${SG_PLUGIN_VERSION_MINOR_ESCAPED}\") |
-                        gsub(\"{{ #sg-plugin-version-patch }}\"; \"${SG_PLUGIN_VERSION_PATCH_ESCAPED}\") |
-                        gsub(\"{{ #sg-build-host }}\"; \"${SG_BUILD_HOST_ESCAPED}\") |
-                        gsub(\"{{ #sg-build-time }}\"; \"${SG_BUILD_TIME_ESCAPED}\")
-                else
-                    .
-                end)
-        else
-            .
-        end
-    )")
-
-# For debugging purpose only!
-#echo "CONTEXT: ${CONTEXT}" >&2
-#echo "BOOK: ${BOOK}" >&2
-#echo "PARSED_BOOK: ${PARSED_BOOK}" >&2
-
-echo "${PARSED_BOOK}" | xq '.'

Handbook/book.toml

@@ -1,115 +0,0 @@
-#
-# author: Mamadou Babaei <mamadou@senseglove.com>
-#
-# (The MIT License)
-#
-# Copyright (c) 2020 - 2025 SenseGlove
-#
-# Permission is hereby granted, free of charge, to any person obtaining a copy
-# of this software and associated documentation files (the "Software"), to deal
-# in the Software without restriction, including without limitation the rights
-# to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
-# copies of the Software, and to permit persons to whom the Software is
-# furnished to do so, subject to the following conditions:
-#
-# The above copyright notice and this permission notice shall be included in all
-# copies or substantial portions of the Software.
-#
-# THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
-# IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
-# FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
-# AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
-# LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
-# OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
-# SOFTWARE.
-#
-
-[book]
-authors = ["Mamadou Babaei"]
-description = "Welcome to the SenseGlove Unreal Engine documentation!"
-language = "en"
-multilingual = false
-src = "src"
-text-direction = "ltr"
-title = "The SenseGlove Unreal Engine Handbook"
-
-[build]
-build-dir = "book"
-create-missing = false
-extra-watch-dirs = ["assets"]
-use-default-preprocessors = true
-
-[preprocessor.index]
-
-[preprocessor.links]
-
-[preprocessor.alerts]
-
-[preprocessor.senseglove]
-after = [ "index", "links" ]
-command = "sh ./bin/sg-preprocessor.sh"
-
-[output.epub]
-no-section-label = false
-curly-quotes = true
-epub-version = 3
-footnote-backrefs = true
-
-[output.html]
-additional-css = ["styles/custom.css"]
-additional-js = []
-cname = "unreal.docs.senseglove.com"
-copy-fonts = true
-default-theme = "navy"
-git-repository-url = "https://dev.azure.com/SenseGlove/_git/SenseGlove-Unreal"
-git-repository-icon = "fa-git"
-input-404 = "404.md"
-mathjax-support = false
-no-section-label = false
-preferred-dark-theme = "navy"
-smart-punctuation = false
-theme = ""
-
-[output.html.fold]
-enable = false
-level = 0
-
-[output.html.print]
-enable = true
-page-break = true
-
-[output.html.search]
-boost-hierarchy = 1
-boost-paragraph = 1
-boost-title = 2
-copy-js = true
-enable = true
-expand = true
-heading-split-level = 3
-limit-results = 128
-teaser-word-count = 64
-use-boolean-and = true
-
-[output.pdf]
-trying-times = 1
-timeout = 300
-# https://chromedevtools.github.io/devtools-protocol/tot/Page/#method-printToPDF
-landscape = false
-display-header-footer = true
-print-background = false
-scale = 1.0
-paper-width = 8
-paper-height = 10
-margin-top = 0.5
-margin-bottom = 0.5
-margin-left = 0.5
-margin-right = 0.5
-page-ranges = ""
-ignore-invalid-page-ranges = false
-header-template = "<h3 style='font-size:8px; margin-left: 48%' class='title'></h3>"
-footer-template = "<p style='font-size:10px; margin-left: 48%'><span class='pageNumber'></span> / <span class='totalPages'></span></p>"
-prefer-css-page-size = true
-
-[output.pdf-outline]
-optional = true
-like-wkhtmltopdf = true

Handbook/dist/.gitignore

@@ -1,6 +0,0 @@
-# Reset all rules from parent .gitignore files!
-!*/
-!**/*
-
-# Recursively ignore all __pycache__ folders!
-__pycache__/