Compare commits

...
627 Commits
Author SHA1 Message Date
Mamadou Babaei ed906960ae bump the plugin version to v2.6.3 2025-06-27 18:35:01 +02:00
Mamadou Babaei e37fcb4e3e add third-party openxr integration documentation section 2025-06-27 18:35:01 +02:00
Mamadou Babaei fb201fb916 bump the plugin version to v2.6.2 2025-06-10 09:14:28 +02:00
Mamadou Babaei 69013ea9cc add a vr optimization third-party tutorial 2025-06-10 09:14:28 +02:00
Mamadou Babaei c4c94623b3 bump the plugin version to v2.6.1 2025-06-05 13:21:34 +02:00
Mamadou Babaei 8c5d42f826 changelog fixes 2025-06-05 12:40:45 +02:00
Mamadou Babaei 481471a1ae bump senseglove libraries to v2.204.0-3a37b1977 2025-06-05 12:40:43 +02:00
Mamadou Babaei 97dbd6e19c fix a changelog typo 2025-06-05 12:40:36 +02:00
Mamadou Babaei 5dbccfb61c bump the plugin version to v2.6.0 2025-06-04 02:36:20 +02:00
Mamadou Babaei 2e74e67e5a fix a runuat build issue due to a missing header providing engine version macros 2025-06-04 02:36:20 +02:00
Mamadou Babaei ba165fdc36 deprecate ue 5.3 support 2025-06-04 02:36:20 +02:00
Mamadou Babaei d17161b230 reoder changelog's last entry sections 2025-06-04 02:36:20 +02:00
Mamadou Babaei f2588cccec revamp the ubt third-party dependency system 2025-06-04 02:36:20 +02:00
Mamadou Babaei 4112f429fb fix build issue with sgbackend by deleting the impl struct copy constructor and copy assignment operator 2025-06-04 02:36:20 +02:00
Mamadou Babaei bd74607124 fix a closing #endif directive comment 2025-06-04 02:36:20 +02:00
Mamadou Babaei eb312697a9 minor code formatting fix 2025-06-04 02:36:20 +02:00
Mamadou Babaei 126d58d88f thread-safe sgbackend initialization 2025-06-04 02:36:20 +02:00
Mamadou Babaei 597a1766f3 thread-safe sglog initialization 2025-06-04 02:36:20 +02:00
Mamadou Babaei ae601173fc revamp sglog to use unreal's tuniqueptr instead of std::unique_ptr 2025-06-04 02:36:20 +02:00
Mamadou Babaei 15bb6d9f1f fix critical deadlock between render and game threads in UE 5.6 when invoking IHeadMountedDisplay::GetHMDMonitorInfo() 2025-06-04 02:36:20 +02:00
Mamadou Babaei 7a553a0621 fix sglog windows/msvc build issues caused by the recent sglog refactor 2025-06-04 02:36:20 +02:00
Mamadou Babaei 48ffaaaaa3 update the changelog 2025-06-04 02:36:20 +02:00
Mamadou Babaei e48ef8e4d3 add a missing header that causes build issues on linux aarch64 due to incomplete uaniminstance type 2025-06-04 02:36:20 +02:00
Mamadou Babaei 1634e99fbf fix type conversion safety and consistency issues across all sglog formatters 2025-06-04 02:36:20 +02:00
Mamadou Babaei 45d5268be7 fix unreal engine 5.6 string conversion build issues on linux 2025-06-04 02:36:20 +02:00
Mamadou Babaei 796d09d907 Revert "bump embedded winpython distribution to v3.12.10"
This reverts commit 4fe067cf9a.
2025-06-04 02:36:19 +02:00
Mamadou Babaei c5bf8e79c6 Revert "attempt at fixing handbook's broken make pack on windows by upgrading mdbook-pdf-outline"
This reverts commit 1be45f2cba.
2025-06-04 02:36:18 +02:00
Mamadou Babaei 2a13908f64 attempt at fixing handbook's broken make pack on windows by upgrading mdbook-pdf-outline 2025-06-04 02:36:18 +02:00
Mamadou Babaei af863176c9 bump the SenseGlove Unreal Engine Marketplace Packager to v0.6.0-4108c6f 2025-06-04 02:36:18 +02:00
Mamadou Babaei 1869c1e01e bump senseglove libraries to v2.203.0-f3d3e676 which migrates to C++20 2025-06-04 02:36:16 +02:00
Mamadou Babaei f51ed2ed1f bump embedded winpython distribution to v3.12.10 2025-06-04 02:36:15 +02:00
Mamadou Babaei 82cc0dc232 lock the mdbook crate version to v0.49.0 2025-06-04 02:36:13 +02:00
Mamadou Babaei 10fcfc99a9 bump senseglove libraries to v2.202.0-5d54da32 which fixes linux build issues for ue 5.5/5.6 by linking against libc++ instead of libstdc++ 2025-06-04 02:36:13 +02:00
Mamadou Babaei e577bade69 update the outdated directory structure section inside the handbook with the latest changes 2025-06-04 02:36:11 +02:00
Mamadou Babaei 9eceebb2f2 bump the senseglove libraries to libraries to v2.201.0-edef7655 and replace epic native toolchain v24 with v25 2025-06-04 02:36:10 +02:00
Mamadou Babaei d3d08f7923 bump the plugin version to v2.5.0 2025-05-09 16:49:38 +02:00
Mamadou Babaei 3e34b3e2ae fix bad warning emoji character inside the platform support matrix 2025-05-09 16:49:38 +02:00
Mamadou Babaei 8686dacd1d improve the changelog formatting as much as possible 2025-05-09 16:36:12 +02:00
Mamadou Babaei 3f6c2a57f2 mention ue 5.2 and epic native toolchain v21 removal in the changelog 2025-05-09 16:36:12 +02:00
Mamadou Babaei 291658ecf7 minor punctuation fix 2025-05-09 16:36:12 +02:00
Mamadou Babaei fd38bf8cb0 update the planned featured completion status with regards to the latest changes 2025-05-09 16:36:11 +02:00
Mamadou Babaei 2efe9e99da update the changelog 2025-05-09 16:36:11 +02:00
Mamadou Babaei a922a140a0 bump the SenseGlove libraries to the v2.200.0-0cb715d0 release with BLE (Bluetooth Low Energy) support 2025-05-09 16:36:11 +02:00
Mamadou Babaei 03b7893e3e remove ue 5.2 deployment from sgum-packager 2025-05-09 16:36:09 +02:00
Mamadou Babaei be23dbb3dd list the third-party tutorials inside the extra resources section in a categorized manner 2025-05-09 16:36:09 +02:00
Mamadou Babaei ce426c6364 minor handbook fixes 2025-05-09 16:36:09 +02:00
Mamadou Babaei 42b219d9a1 downgrade mdbook-epub crate to cac03b7f4b151f106f7f05b13da4c33fc098dd2c 2025-05-09 16:36:09 +02:00
Mamadou Babaei 24a5e98294 fix a broken handbook url 2025-05-09 16:36:09 +02:00
Mamadou Babaei 414261eb96 revamp the sensecom instructions and divide it into ble and btserial sections 2025-05-09 16:36:09 +02:00
Mamadou Babaei 0da813a3d3 bump mdbook-epub crate to the latest v0.4.x 2025-05-09 16:36:09 +02:00
Mamadou Babaei 24dc0fdb6a fix a critical deadlock issue (UE-212224) in UE 5.5/5.6 during PipelinedFrameState acquisition 2025-05-09 16:36:09 +02:00
Mamadou Babaei 09a9dfc7fd bump the SenseGlove libraries to the v2.199.1-8de3deb9 experimental release with BLE (Bluetooth Low Energy) support 2025-05-09 16:36:09 +02:00
Mamadou Babaei 5ffde6ae47 bump the SenseGlove libraries to the v2.199.0-b35c8158 experimental release with BLE (Bluetooth Low Energy) support 2025-05-09 16:36:08 +02:00
Mamadou Babaei 8e2d094708 mark ue 5.2 as out of support in the platform support matrix 2025-05-09 16:36:06 +02:00
Mamadou Babaei ef65cb6e7e bump the senseglove libraries to the latest experimental ble builds 2025-05-09 16:36:05 +02:00
Mamadou Babaei 571282bb8b add missing changelogs from the previous commit 2025-05-09 16:36:04 +02:00
Mamadou Babaei cbe193e547 revamp android backend initialization error handling and bump the senseglove libraries to the latest experimental ble builds 2025-05-09 16:36:03 +02:00
Mamadou Babaei b6ca5015a9 list the license section inside the overview section as well 2025-05-09 16:36:02 +02:00
Mamadou Babaei c07e36bc89 fix a main menu title missing keyword 2025-05-09 16:36:02 +02:00
Mamadou Babaei 7865724e0a a minor punctuation fix in the changelog 2025-05-09 16:36:01 +02:00
Mamadou Babaei 30300cd265 add sgble and sgblexx rust dependency licenses 2025-05-09 16:36:01 +02:00
Mamadou Babaei f95b70a778 bump the senseglove libraries to a ble-aware version that resolves android build issues 2025-05-09 16:36:00 +02:00
Mamadou Babaei eb234ebaa6 bump sgconnect for android to an experimental unreleased ble-aware implementation 2025-05-09 16:35:59 +02:00
Mamadou Babaei 88960dec55 bump senseglove libraries to a yet to be versioned, experimental release, with ble support 2025-05-09 16:35:58 +02:00
Mamadou Babaei 73ed4e8d16 add initial support for epic native toolchain v24 2025-05-09 16:35:57 +02:00
Mamadou Babaei a56cd8d211 bump the senseglove libraries to v2.106.0-d5361a48 2025-05-09 16:35:56 +02:00
Mamadou Babaei b5ebf59916 bump the plugin version to v2.4.2 2025-02-17 13:29:27 +01:00
Mamadou Babaei 9f7bc80fb9 list the third-party tutorials with a description in their corresponding parent sections 2025-02-17 13:29:27 +01:00
Mamadou Babaei 2127a1959c bump the plugin version to v2.4.1 2025-02-14 15:25:15 +01:00
Mamadou Babaei 2b3d8830d9 fix a bug that breaks the custom styles on the release urls 2025-02-14 15:07:38 +01:00
Mamadou Babaei 7c245ceddb apply a minor handbook makefile fix 2025-02-14 15:07:38 +01:00
Mamadou Babaei 7010a8c057 bump the plugin version to v2.4.0 2025-02-14 12:21:25 +01:00
Mamadou Babaei c283ae3d0c update the list of supported hmds in the planned features completion status 2025-02-14 12:11:26 +01:00
Mamadou Babaei 81d1b90dfe remove meta xr plugin compatibility from the planned features completion status 2025-02-14 12:11:26 +01:00
Mamadou Babaei 2406297806 fix documentation errors and confusions 2025-02-14 12:11:26 +01:00
Mamadou Babaei 2e48b503ad list the vrexpansion plugin demo in the extra resources section 2025-02-14 12:11:26 +01:00
Mamadou Babaei 0b5feb962d Revert "experiment with a hacky approach to make metaxr work"
This reverts commit f3bc6502e4.
2025-02-14 12:11:26 +01:00
Mamadou Babaei f80c6bdab1 Revert "add SetupMetaXRAvailability during the build time to define WITH_METAXR"
This reverts commit e2c50e9c77.
2025-02-14 12:11:26 +01:00
Mamadou Babaei 800522bd04 remove metaxr compatibility from the documentation along with its assets and replace it with a caution incompatibility note 2025-02-14 12:11:26 +01:00
Mamadou Babaei e77728ff0c remove metaxr compatibility notes from the changelog for this release 2025-02-14 12:11:26 +01:00
Mamadou Babaei 1105ffd01b minor changelog fixes 2025-02-14 12:11:26 +01:00
Mamadou Babaei c2fd40d486 minor documentation fixes 2025-02-14 12:11:25 +01:00
Mamadou Babaei 2ed6197879 add notes in regards to pcvr and standlone modes support for vive and meta hmds 2025-02-14 12:11:25 +01:00
Mamadou Babaei 07fc3a6b24 fix the platform support matrix formatting 2025-02-14 12:11:25 +01:00
Mamadou Babaei 18c5bc731b add a deprecation note for ue 5.2 2025-02-14 12:11:25 +01:00
Mamadou Babaei 6b1f5c10f8 mark ue 5.5 meta quest standalone mode as supported 2025-02-14 12:11:25 +01:00
Mamadou Babaei 361cd30740 mark ue 5.5 meta quest standalone mode as supported 2025-02-14 12:11:19 +01:00
Mamadou Babaei 7853dd2ed3 add a few third-party tutorials 2025-02-14 12:11:15 +01:00
Mamadou Babaei b8cf402bb6 minor url fix 2025-02-14 12:11:15 +01:00
Mamadou Babaei 5709de714b experiment with a hacky approach to make metaxr work 2025-02-14 12:11:15 +01:00
Mamadou Babaei 5a26fab5ae add SetupMetaXRAvailability during the build time to define WITH_METAXR 2025-02-14 12:11:15 +01:00
Mamadou Babaei 4a1aec916c fix the changelog's grammatical issues and typos 2025-02-14 12:11:15 +01:00
Mamadou Babaei 7648891cbe add missing headers to solve runuat build issues 2025-02-14 12:11:15 +01:00
Mamadou Babaei b00127554d add htc vive optimal rendering settings 2025-02-14 12:11:14 +01:00
Mamadou Babaei 76c7cbb27f add htc vive specific optimization tips for running in standalone mode 2025-02-14 12:11:14 +01:00
Mamadou Babaei aaadad657b update viveopenxr XR_EXT_hand_tracking and wrist-tracking documentation with more accurate details 2025-02-14 12:11:14 +01:00
Mamadou Babaei 26a38ecfd0 add initial ultimate tracker and OpenXRXrTracker support which is not fully functional 2025-02-14 12:11:14 +01:00
Mamadou Babaei c5ba565568 bring the wrist-tracking hardware setup and XR_EXT_hand_tracking documentation on par with the recent changes 2025-02-14 12:11:14 +01:00
Mamadou Babaei 6427fd7157 clear up debug logs 2025-02-14 12:11:14 +01:00
Mamadou Babaei 079fe14613 add support for htc vive wrist trackers on android 2025-02-14 12:11:14 +01:00
Mamadou Babaei 251dbb4840 fix a comment formatting 2025-02-14 12:11:14 +01:00
Mamadou Babaei cee33aa684 fix a typo 2025-02-14 12:11:14 +01:00
Mamadou Babaei a1ce48e133 add support for htc vive focus vision hmd auto-detection and various htc hmds auto-detection support on android 2025-02-14 12:11:14 +01:00
Mamadou Babaei 5a70218a71 optimize FSGArrayUtils by pre-allocating memory instead of growing by every emplace_back or add 2025-02-14 12:11:14 +01:00
Mamadou Babaei 426f6e8855 fix a comment 2025-02-14 12:11:14 +01:00
Mamadou Babaei 664fdef477 use fixed-width integers 2025-02-14 12:11:14 +01:00
Mamadou Babaei f6df174a68 clarify how to setup the VIVE Wrist Trackers in various configurations 2025-02-14 12:11:14 +01:00
Mamadou Babaei f387b8a54b add ue 5.2 deprectation notes to the changelog 2025-02-14 12:11:14 +01:00
Mamadou Babaei d827399097 minor comment fixes 2025-02-14 12:11:13 +01:00
Mamadou Babaei ec067bdacc remove redundant sgxrtracker code 2025-02-14 12:11:13 +01:00
Mamadou Babaei d8f7f7db59 use engine api to set the tracking motion source 2025-02-14 12:11:13 +01:00
Mamadou Babaei 31e03380c9 fix the non-editor build issues caused by the recent motion sources refactor 2025-02-14 12:11:13 +01:00
Mamadou Babaei 6f9f0c55b6 refactor the way we populate and utilize motion sources for viveopenxr compatibility 2025-02-14 12:11:13 +01:00
Mamadou Babaei 151e0bdee2 remove redundant dependency module 2025-02-14 12:11:13 +01:00
Mamadou Babaei 955f3487a5 add the FSGPluginUtils utility class for other plugins or modules availability detection such as Meta XR and ViveOpenXR 2025-02-14 12:11:13 +01:00
Mamadou Babaei 8f1eff6e22 mention meta xr and viveopenxr plugins compatibility in the planned features completion status 2025-02-14 12:11:13 +01:00
Mamadou Babaei c1b2527513 revamp the Enabling XR_EXT_hand_tracking OpenXR Extension on VR Headsets and Deploying to Android (Standalone) documentation and the Meta XR-compatibile and ViveOpenXR-compatibile instructions 2025-02-14 12:11:13 +01:00
Mamadou Babaei 3a5c8e1f89 add FSGConnectJNI::Initialize() and FSGCoreJNI::Initialize() return codes to Android logs for detailed debugging purposes through adb logcat 2025-02-14 12:11:13 +01:00
Mamadou Babaei 2237b15e67 add a missing url 2025-02-14 12:11:13 +01:00
Mamadou Babaei f358e0292b apply some minor changelog fixes 2025-02-14 12:11:13 +01:00
Mamadou Babaei aded745d06 update the changelog with the unreleased changes 2025-02-14 12:11:13 +01:00
Mamadou Babaei 09bd8b8955 use ue 5.5 header github links in the fxrmotioncontrollerdata page since its removal is likey in ue 5.6 2025-02-14 12:11:13 +01:00
Mamadou Babaei 90cacff9a9 fixed a few broken URLs caused by bad markdown formatting 2025-02-14 12:11:12 +01:00
Mamadou Babaei 5df61c7085 update the changelog with the unreleased changes 2025-02-14 12:11:12 +01:00
Mamadou Babaei 532e18ea73 bump the SenseGlove Unreal Engine Marketplace Packager v0.5.0-7df1183 2025-02-14 12:11:12 +01:00
Mamadou Babaei 5eb1e0be31 make the handbook scp operations safer by utilizing quotes 2025-02-14 12:11:12 +01:00
Mamadou Babaei ba95e455f5 reintroduce Michael-F-Bryan/mdbook-epub backend for the handbook as its issue #115 have been solved 2025-02-14 12:11:12 +01:00
Mamadou Babaei d05c814c40 make the handbook makefile safer by wrapping files/folder navigations/operations in quotes 2025-02-14 12:11:12 +01:00
Mamadou Babaei bee2f4ff38 remove a redundant copy from the handbook makefile 2025-02-14 12:11:12 +01:00
Mamadou Babaei 0ca91da448 remove redundant steps from the handbook makefile 2025-02-14 12:11:12 +01:00
Mamadou Babaei 70e669e89d remove unused variable SG_DOCUMENTATION_EPUB_DIR from the handbook makefile 2025-02-14 12:11:12 +01:00
Mamadou Babaei 8f4afa1587 migrate the documentation changelogs for the next unreleased version to its own section 2025-02-14 12:11:12 +01:00
Mamadou Babaei a7c9ba2480 bump the mdbook-alerts crate to v0.7.x 2025-02-14 12:11:11 +01:00
Mamadou Babaei 97c134dd19 bump the SenseGlove libraries to v2.105.3-97ea18cb 2025-02-14 12:11:11 +01:00
Mamadou Babaei e5bbf750c5 update the changelog with unreleased changes 2025-02-14 12:11:11 +01:00
Mamadou Babaei 0a8ad801bc bump the SenseGlove Unreal Engine Marketplace Packager v0.4.1-e39a4f4 2025-02-14 12:11:10 +01:00
Mamadou Babaei 0544e3e821 fix the changelog formatting 2025-02-14 12:11:10 +01:00
Mamadou Babaei 18201c1e79 bump the copyright years 2025-02-14 12:11:10 +01:00
Mamadou Babaei 083a54678b clarify htc vive stand-alone support status in the platform support matrix 2025-02-14 12:11:10 +01:00
Mamadou Babaei beafb0df65 bump the plugin version to v2.3.2 2025-01-28 14:55:50 +01:00
Mamadou Babaei a21469e09b fix a critical issue where HandStates->GetTransform(KeyPoint) was incorrectly resolving to (&HandStates[0])->GetTransform(KeyPoint), causing both hands to use the left hand's wrist transform under specific conditions 2025-01-28 14:55:50 +01:00
Mamadou Babaei 11fd74b88c bump the plugin version to v2.3.1 2024-11-27 10:11:50 +01:00
Mamadou Babaei 222cefaedc do an ensure check instead of silently ignoring the non-existent joint 2024-11-27 10:11:50 +01:00
Mamadou Babaei 9687d8c52b calculate the bone ref transforms using the current mesh rather than the reference mesh 2024-11-27 10:11:50 +01:00
Mamadou Babaei 205380cfbf white space and code formatting fixes 2024-11-27 10:11:50 +01:00
Mamadou Babaei bc0f269479 bump the plugin version to v2.3.0 2024-11-14 00:31:28 +01:00
Mamadou Babaei a1938bd151 fix ue 5.5 deprecation warnings inside USGVirtualHandComponent 2024-11-14 00:26:43 +01:00
Mamadou Babaei a1ad2314dd fix rocket build issues by adding missing the headers 2024-11-14 00:26:43 +01:00
Mamadou Babaei fb75ea3db0 list AndroidPermission plugin as a dependency 2024-11-14 00:26:42 +01:00
Mamadou Babaei 6d0b59446c remove comments that probably pasted by mistake 2024-11-14 00:26:42 +01:00
Mamadou Babaei e61e8e7d29 revamp the way the plugin requests permisions on Android by showing a pop-up to the user rather than silently crashing if those permisions were not already given 2024-11-14 00:26:42 +01:00
Mamadou Babaei a9cd37f7bd implement the android permissions singleton responsible for requesting android permissions and checking those 2024-11-14 00:26:42 +01:00
Mamadou Babaei 37f2d7ecdf re-order the required permissions alphabetically inside the android upl file 2024-11-14 00:26:42 +01:00
Mamadou Babaei 62df2be2e6 make the USGBackend constructor private 2024-11-14 00:26:42 +01:00
Mamadou Babaei ff4cc765f3 remove USGBackend class config specifier 2024-11-14 00:26:42 +01:00
Mamadou Babaei 33438f1c01 apply a minor formatting fix to the changelog 2024-11-14 00:26:42 +01:00
Mamadou Babaei ae3ca0f427 bump the plugin version to v2.2.2 2024-11-08 12:24:44 +01:00
Mamadou Babaei 4deb7162b4 fix a chain of glove and hand-tracking bugs that render the hand-tracking state invalid at certain times 2024-11-08 12:24:44 +01:00
Mamadou Babaei c15be7eb69 bump the plugin version to v2.2.1 2024-10-23 14:50:28 +02:00
Mamadou Babaei 588add1523 revise documentation to point to fab instead of ue marketplace 2024-10-23 14:50:28 +02:00
Mamadou Babaei bdbcbe7e39 bump the plugin version to v2.2.0 2024-10-22 06:57:25 +02:00
Mamadou Babaei 58c2d2027f remove ue 5.5+ code that causes build failure and cannot be wrapped inside if/def/end preprocessors due to lack of its support in uht 2024-10-22 06:57:24 +02:00
Mamadou Babaei c4ebfa8e60 list ue 5.5 in the sgum-packager configuration file 2024-10-22 06:57:24 +02:00
Mamadou Babaei 4871ba3012 include Runtime/Launch/Resources/Version.h only where it matters 2024-10-22 06:57:24 +02:00
Mamadou Babaei d62756beb8 add the documentation on consuming the FXRHandTrackingState struct in both Blueprint and C++ 2024-10-22 06:57:24 +02:00
Mamadou Babaei 6af11e125e minor formatting fix 2024-10-22 06:57:24 +02:00
Mamadou Babaei 44fc879037 change SG_BROWSER_BINARY_PATH_LINUX binary path 2024-10-22 06:57:24 +02:00
Mamadou Babaei 64857c7b3a migrate away from the deprecated FXRMotionControllerData in favor of FXRMotionControllerState and FXRHandTrackingState on UE 5.5+ 2024-10-22 06:57:18 +02:00
Mamadou Babaei 72e742e508 bump the plugin version to v2.1.4 2024-10-22 05:30:16 +02:00
Mamadou Babaei 2535b9c4fb add the missing release title to the v2.1.3 changelog entry 2024-10-22 05:30:16 +02:00
Mamadou Babaei be1823c16f update the documentation on consuming the FXRMotionControllerData struct 2024-10-22 05:30:16 +02:00
Mamadou Babaei 1bf32dc10f bump the plugin version to v2.1.3 2024-10-11 12:31:23 +02:00
Mamadou Babaei a8db78d521 update the platform support matrix and also add a note in regards to fab and ue marketplace transition 2024-10-11 12:31:23 +02:00
Mamadou Babaei 0ec25246e5 add the planned features for the v2.2.x release series 2024-10-11 12:31:23 +02:00
Mamadou Babaei e7a9915757 silence another ue 5.5 deprecation warning with a temporary workaround for the time being 2024-10-11 12:31:23 +02:00
Mamadou Babaei e0829008bf avoid mentioning the patch releases in the planned features completion status page 2024-10-11 12:31:23 +02:00
Mamadou Babaei f60fd2ff66 address a few ue 5.5 deprecation warnings 2024-10-11 12:31:23 +02:00
Mamadou Babaei b69bb080f6 add a missing header 2024-10-11 12:31:23 +02:00
Mamadou Babaei cddba9a591 add support for epic native toolchain v23 2024-10-11 12:31:23 +02:00
Mamadou Babaei 7b36d9fc4d bump the senseglove libraries to v2.105.2-f2de4b89 2024-10-11 12:31:22 +02:00
Mamadou Babaei 7dcc472062 fix code formatting 2024-10-11 12:31:22 +02:00
Mamadou Babaei f17ddfdaf2 remove a redundant header 2024-10-11 12:31:22 +02:00
Mamadou Babaei cd71b90a53 fix a bug inside USGVirtualHandComponent::PostEditChangeProperty() where the get member name check happens against the wrong class and member names 2024-10-11 12:31:22 +02:00
Mamadou Babaei b34f1cfc86 fix a grammatical typo in a comment 2024-10-11 12:31:22 +02:00
Mamadou Babaei 173806b336 bump the plugin version to v2.1.2 2024-09-02 19:38:34 +02:00
Mamadou Babaei 8069ced45a update the changelog 2024-09-02 19:38:34 +02:00
Mamadou Babaei fd0ee0a7bc update the changelog 2024-09-02 19:38:34 +02:00
Mamadou Babaei 82f1f8fe0a fix a few virtual hand component visibility issues 2024-09-02 19:38:34 +02:00
Mamadou Babaei 40d6325a0f fix the non-existent default hand-mesh warnings polluting the logs when packaging the game 2024-09-02 19:38:34 +02:00
Mamadou Babaei 6996bac162 update the changelog 2024-09-02 19:38:34 +02:00
Mamadou Babaei cd2297d695 fix the wrong script name for USXRTrackerKismetLibrary 2024-09-02 19:38:34 +02:00
Mamadou Babaei 92c066bb05 fix the wrong script name for USGHMDTrackerKismetLibrary 2024-09-02 19:38:34 +02:00
Mamadou Babaei 56af08e261 expand the clickable area on the handbook index page revision buttons 2024-09-02 19:38:34 +02:00
Mamadou Babaei c1db061d4c an overview title fix to match the summary file 2024-09-02 19:38:33 +02:00
Mamadou Babaei 13956cc579 bump the SenseGlove Unreal Engine Plugin to v2.1.1 2024-08-18 01:46:51 +02:00
Mamadou Babaei 105053e442 fix documentation typos 2024-08-18 01:46:51 +02:00
Mamadou Babaei 7787296c3a fix a bug where SG_GIT_IS_SHALLOW_CLONE while building the handbook is always set to yes even if it's not a shadow clone 2024-08-18 01:32:51 +02:00
Mamadou Babaei 34b66f54a2 removed android ndk r25 armv7 and x86 dependencies brought back by mistake while merging v2.1.0 from the dev branch to the master branch 2024-08-18 00:55:32 +02:00
Mamadou Babaei 9df3e94e60 fix a bug that causes a handbook revision mismatch when deploying the handbook from the dev branch 2024-08-18 00:28:33 +02:00
Mamadou Babaei 365f660f34 fix the messed up changelog file caused by cherry-picking merge conflicts between the dev branch and the master branch 2024-08-18 00:10:38 +02:00
Mamadou Babaei 34a508a3a2 bump the plugin version to v2.1.0 2024-08-16 19:55:24 +02:00
Mamadou Babaei ac65009fdd fix build issues caused by cherry-pick order between v2.0.x and v2.1.x releases; the dev branch already contains these fixes 2024-08-16 19:55:24 +02:00
Mamadou Babaei 2960661a0c extract the git version from the remote repo when it's a shallow clone to allow the sgum-packager work with release branches 2024-08-16 19:09:25 +02:00
Mamadou Babaei e0d2d994f3 determine the value of mdbook site-url from the makefile instead of hardcoding it per branch 2024-08-16 18:01:52 +02:00
Mamadou Babaei cac90aea0f fix ue 5.4 runuat build issues inside the sggrabcomponent caused by missing headers 2024-08-16 18:01:52 +02:00
Mamadou Babaei 115ef0adce fix a broken url 2024-08-16 18:01:52 +02:00
Mamadou Babaei 3584e9e947 add make pack to the output of make help 2024-08-16 18:01:52 +02:00
Mamadou Babaei d5f3b0d65d fix a broken url 2024-08-16 18:01:52 +02:00
Mamadou Babaei 8cf22586bb fix a url 2024-08-16 18:01:52 +02:00
Mamadou Babaei f9ae32f8bd add topic: Upgrade Guide 2024-08-16 18:01:52 +02:00
Mamadou Babaei a371ca283c add the sub-topic: Optimizing Unreal Projects for Mobile 2024-08-16 18:01:52 +02:00
Mamadou Babaei 2df8295ba4 formatting fixes 2024-08-16 18:01:52 +02:00
Mamadou Babaei b038fa70a1 add topic: Optimizing Your Project for Higher FPS 2024-08-16 18:01:51 +02:00
Mamadou Babaei 1d2b965e2e lock cargo dependencies for the hadbook to pecific major/minor releases and not patch releases 2024-08-16 18:01:51 +02:00
Mamadou Babaei a895f45700 clarify the note about how the separation of the real and virtual hand rendering is broken 2024-08-16 18:01:51 +02:00
Mamadou Babaei a2425bef89 fix a typo 2024-08-16 18:01:51 +02:00
Mamadou Babaei 4d10c34fa5 remove troublesome inline keywords added by jetbrains rider 2024-08-16 18:01:51 +02:00
Mamadou Babaei e89cd20117 mark the separation of the real and virtual hand rendering as broken and a note to the known issues section 2024-08-16 18:01:51 +02:00
Mamadou Babaei f412c56654 fix a few bugs that does affect the real hand collision events because of SetVisibility and redundant checking against grabbed actor 2024-08-16 18:01:51 +02:00
Mamadou Babaei 55ba62deaa replace SGPawn::FImpl::EnableActorPhysics() and SGPawn::FImpl::DisableActorPhysics() with USGGrabComponent::SimulatePhysics() 2024-08-16 18:01:51 +02:00
Mamadou Babaei 3717c86614 enable bGravityEnabled, bSimulatePhysics, and call WakeRigidBody on grab component's owning actor at BeginPlay() if bAffectPhysicsState is enabled 2024-08-16 18:01:51 +02:00
Mamadou Babaei 02a2f58fd1 document Configuring the SGPawn and Plugin Virtual Hand Mesh Settings as the final step in setting up the virtual hand meshes 2024-08-16 18:01:51 +02:00
Mamadou Babaei 14613bed31 fix a typo 2024-08-16 18:01:51 +02:00
Mamadou Babaei c77504c44a use the value of GrabAttachPointSocketName from the plugin settings as default for USGGrabComponent's AttachmentSocketName uproperty 2024-08-16 18:01:51 +02:00
Mamadou Babaei e02db1e3fc add the sgbasicdemo-openxr repository to the examples and demo projects section 2024-08-16 18:01:51 +02:00
Mamadou Babaei 6a41d4464a minor fix 2024-08-16 18:01:51 +02:00
Mamadou Babaei b89fc2405d add video tutorials 2024-08-16 18:01:51 +02:00
Mamadou Babaei b812ca08d7 add the contents for setting up the grab/release, and the touch systems 2024-08-16 18:01:51 +02:00
Mamadou Babaei 461e1b18dd add another android note 2024-08-16 18:01:51 +02:00
Mamadou Babaei 2701c6a0cf fix the display name for various overloads of the Blueprint-exposed function Queue Command Vibro Level to expose sensible display names. 2024-08-16 18:01:50 +02:00
Mamadou Babaei 1c362a9ecb a changelog fix 2024-08-16 18:01:50 +02:00
Mamadou Babaei 98e7994ecf fix a topic title 2024-08-16 18:01:50 +02:00
Mamadou Babaei 06dc267743 minor fix 2024-08-16 18:01:50 +02:00
Mamadou Babaei db1b209f1a add topic: Deploying to Android (Standalone) 2024-08-16 18:01:50 +02:00
Mamadou Babaei 7c9ae5bed1 add a note in regards to meta xr and vive openxr plugins incompatibility 2024-08-16 18:01:50 +02:00
Mamadou Babaei 52480c7543 add instructions: Setting up the SenseGlove Grab and Touch Sockets 2024-08-16 18:01:50 +02:00
Mamadou Babaei 3521b03fed remove irrelevant section as it's already set up by the plugin automatically 2024-08-16 18:01:50 +02:00
Mamadou Babaei 18ac65e070 mention a relevant video tutorial 2024-08-16 18:01:50 +02:00
Mamadou Babaei 1b748e3cd4 close the div tag properly 2024-08-16 18:01:50 +02:00
Mamadou Babaei 97887723be add the instructions for: Setting up the Rigid Bodies 2024-08-16 18:01:50 +02:00
Mamadou Babaei 7b0d2ef57f fix license titles 2024-08-16 18:01:50 +02:00
Mamadou Babaei 5959fa69cd add instructions for importing / exporting compatible virtual hand meshes 2024-08-16 18:01:50 +02:00
Mamadou Babaei d03e4d63de minor fix 2024-08-16 18:01:49 +02:00
Mamadou Babaei ec02fef4ba update the overview section 2024-08-16 18:01:49 +02:00
Mamadou Babaei 4b69b80faa add the content for setting up the wrist tracking hardware section 2024-08-16 18:01:49 +02:00
Mamadou Babaei 2f932da631 add important notes for setting up the wrist tracker and virtual hands 2024-08-16 18:01:49 +02:00
Mamadou Babaei b0ba8e5fb2 add the complete documentation for setting up the senseglove default classes 2024-08-16 18:01:49 +02:00
Mamadou Babaei 0d02e4ad6b fix a build issue on ue 5.2 2024-08-16 18:01:49 +02:00
Mamadou Babaei a2844e9e86 apply summary.md changes to the overview page 2024-08-16 18:01:49 +02:00
Mamadou Babaei 59db3090b7 fix borken links 2024-08-16 18:01:49 +02:00
Mamadou Babaei 0aef4b13cb add more topics to the menu 2024-08-16 18:01:49 +02:00
Mamadou Babaei 893707beeb minor fix 2024-08-16 18:01:49 +02:00
Mamadou Babaei 35294a9ab5 add the introduction to the senseglove default classes 2024-08-16 18:01:49 +02:00
Mamadou Babaei 52386cf471 fix the wrong content path 2024-08-16 18:01:49 +02:00
Mamadou Babaei dd4fe78880 fix README.md broken links 2024-08-16 18:01:49 +02:00
Mamadou Babaei 4dcc629198 add a caution for bvalidateifdefaultclassesaresgcompliant 2024-08-16 18:01:49 +02:00
Mamadou Babaei 00f2efc1c7 fix a typo 2024-08-16 18:01:49 +02:00
Mamadou Babaei a55e85ec05 add the console commands SG_GetEngineScalabilitySettings and SG_SetEngineScalabilitySettings 2024-08-16 18:01:49 +02:00
Mamadou Babaei afef6987f7 add the license terms for the handbook 2024-08-16 18:01:49 +02:00
Mamadou Babaei 93d5a20f12 add the boilerplate for setting up the senseglove default classes 2024-08-16 18:01:49 +02:00
Mamadou Babaei 72950feb78 fix broken links in the overview page by adding .. to the relative urls 2024-08-16 18:01:48 +02:00
Mamadou Babaei ca461ad6dc fix broken index/readme.md links in the overview page 2024-08-16 18:01:48 +02:00
Mamadou Babaei 25f1d8628b minor fix 2024-08-16 18:01:48 +02:00
Mamadou Babaei 6a40f832af add the content for the overview page 2024-08-16 18:01:48 +02:00
Mamadou Babaei 106d4d9581 minor fix 2024-08-16 18:01:48 +02:00
Mamadou Babaei 5aa2bdb052 complete the plugin configuration, settings, and overrides, sections 2024-08-16 18:01:48 +02:00
Mamadou Babaei 4b2c151948 improve the repo's main readme file 2024-08-16 18:01:48 +02:00
Mamadou Babaei ba8935c3b0 reference the handbook's extra resources 2024-08-16 18:01:48 +02:00
Mamadou Babaei 8edf5a72a4 bring on par the SGSettings blueprint api with the cpp api 2024-08-16 18:01:48 +02:00
Mamadou Babaei d14a73f990 add some custom css styles for better html formatting 2024-08-16 18:01:48 +02:00
Mamadou Babaei bf754aead1 add the plugin-settings section 2024-08-16 18:01:48 +02:00
Mamadou Babaei 52655cc8aa add a note about Hand and Body Tracking settings 2024-08-16 18:01:48 +02:00
Mamadou Babaei 9d11d5de88 add the sensecom documentation 2024-08-16 18:01:48 +02:00
Mamadou Babaei f25f09e638 add a caution in regards to broken meta quest hmds on steamvr 2024-08-16 18:01:48 +02:00
Mamadou Babaei 60e3aa6c35 fix youtube video urls 2024-08-16 18:01:48 +02:00
Mamadou Babaei 7b5f3d7ffa whitespace fix 2024-08-16 18:01:48 +02:00
Mamadou Babaei c8f785e88e add the low level api documentation 2024-08-16 18:01:48 +02:00
Mamadou Babaei 36a39e3748 complete installation instructions 2024-08-16 18:01:47 +02:00
Mamadou Babaei 3395d25376 Revert "move bFallbackToHandTrackingIfNoGloveDetected from tracking settings to glove tracking settings"
This reverts commit e16c1d216f.
2024-08-16 18:01:47 +02:00
Mamadou Babaei 3b6f38a214 move bFallbackToHandTrackingIfNoGloveDetected from tracking settings to glove tracking settings 2024-08-16 18:01:47 +02:00
Mamadou Babaei 4f64fed83c add an important alert 2024-08-16 18:01:47 +02:00
Mamadou Babaei eee3c99a69 minor fixes 2024-08-16 18:01:47 +02:00
Mamadou Babaei d1fac4a9ee fix a broken link 2024-08-16 18:01:47 +02:00
Mamadou Babaei d010686604 add instructions: Enabling XR_EXT_hand_tracking OpenXR extension on VR Headsets 2024-08-16 18:01:47 +02:00
Mamadou Babaei a2c1eb713d add topic: Extra Resources 2024-08-16 18:01:47 +02:00
Mamadou Babaei fd85eab3a6 add instructions: Safe and Reliable Glove Access in Blueprint 2024-08-16 18:01:47 +02:00
Mamadou Babaei 6832b5b426 center all youtube videos 2024-08-16 18:01:47 +02:00
Mamadou Babaei 958aab50c5 add instructions: Enabling The SenseGlove Unreal Engine Plugin and Veirfying the Plugin Version 2024-08-16 18:01:47 +02:00
Mamadou Babaei e94eb4a811 whitespace fix 2024-08-16 18:01:47 +02:00
Mamadou Babaei 089476fddd add the epic games launcher installation instructions 2024-08-16 18:01:47 +02:00
Mamadou Babaei bf9ed153f7 replace inline code blocks with back tilde inside the changelog 2024-08-16 18:01:47 +02:00
Mamadou Babaei 36eaafbf1f update the changelog 2024-08-16 18:01:47 +02:00
Mamadou Babaei f9ef0f0513 revamp the main readme file with the latest information and instructions 2024-08-16 18:01:47 +02:00
Mamadou Babaei 4c51cda376 change the DocsURL from the old blueprint docs to the handbook 2024-08-16 18:01:46 +02:00
Mamadou Babaei d0bda099df improve the main index layout 2024-08-16 18:01:46 +02:00
Mamadou Babaei 0ec3695103 make the main index generation code more readable 2024-08-16 18:01:46 +02:00
Mamadou Babaei a320b20309 deploy the favicon to the main index as well 2024-08-16 18:01:46 +02:00
Mamadou Babaei c6bfb6d718 bump the SenseGlove Unreal Engine Marketplace Packager v0.4.0-a65bb20 2024-08-16 18:01:46 +02:00
Mamadou Babaei eab44d1ea4 fix the windows cmd.exe issues with rename/copy and always use move when invoking the pack target 2024-08-16 18:01:46 +02:00
Mamadou Babaei 00de3431e8 remove the changelog.md file from filterplugin list and list the pdf and html documentation files 2024-08-16 18:01:46 +02:00
Mamadou Babaei 3254baa358 minor fixes 2024-08-16 18:01:46 +02:00
Mamadou Babaei 9873c844a8 document for dependencies 2024-08-16 18:01:46 +02:00
Mamadou Babaei 63c05aa340 mention the purpose of make pack in the handbook readme file 2024-08-16 18:01:46 +02:00
Mamadou Babaei 1c883e942c add make pack target to the handbook makefile 2024-08-16 18:01:46 +02:00
Mamadou Babaei 1ee9e1697e try to fix rsync error on windows: error in rsync protocol data stream (code 12) 2024-08-16 18:01:46 +02:00
Mamadou Babaei b148eea514 fix the windows rsync/git bash issue: the source and destination cannot both be remote 2024-08-16 18:01:46 +02:00
Mamadou Babaei 42f8fc4eb8 add a deployment note in regards to sourcing the deployment configurations on windows + git bash setups 2024-08-16 18:01:46 +02:00
Mamadou Babaei b43cf9e93d introduce #sg-handbook-revision-url and #sg-handbook-revision-url + other preprocessor improvements 2024-08-16 18:01:46 +02:00
Mamadou Babaei f5c6688803 add the initial implementation for the deploy target 2024-08-16 18:01:46 +02:00
Mamadou Babaei eda0b0864d revamp the handbook make targets 2024-08-16 18:01:45 +02:00
Mamadou Babaei 73fed8a5f7 fix the broken pdf toc generation on linux 2024-08-16 18:01:45 +02:00
Mamadou Babaei ad8dc9b5a0 replace all bitfield uproperties with booleans 2024-08-16 18:01:45 +02:00
Mamadou Babaei ec83c132f4 adjust the exclusion list to the latest repo structure overhaul 2024-08-16 18:01:45 +02:00
Mamadou Babaei da18b160d8 merge the pack branch into the plugin's source and add the sgum-packager v0.3.0 utility for automatic packaging and deployment to epic marketplace 2024-08-16 18:01:45 +02:00
Mamadou Babaei ee725626e0 winpython fixes and fix pdf-outline generation on gentoo using a temporary python env 2024-08-16 18:01:45 +02:00
Mamadou Babaei 0248a2444d minor fixes and clean up 2024-08-16 18:01:45 +02:00
Mamadou Babaei c2d9eb2e70 replace inline code blocks with back tilde 2024-08-16 18:01:45 +02:00
Mamadou Babaei 6f70a748fd complete advanced-topics/openxr/consuming-fxrmotioncontrollerdata/cpp tutorial 2024-08-16 18:01:45 +02:00
Mamadou Babaei 6675c6e708 set the default value of bValidateIfDefaultClassesAreSGCompliant to false 2024-08-16 18:01:45 +02:00
Mamadou Babaei 742201c264 crop the image edge 2024-08-16 18:01:45 +02:00
Mamadou Babaei e9a3cb2024 add winpython and enable pdf-outline 2024-08-16 18:01:44 +02:00
Mamadou Babaei 7bd4f85d61 complete advanced-topics/openxr/consuming-fxrmotioncontrollerdata/blueprint tutorial 2024-08-16 18:01:44 +02:00
Mamadou Babaei 50f2278a87 fix a bug where tracking status not being set when the hand data is valid 2024-08-16 18:01:44 +02:00
Mamadou Babaei b1def88b73 specify the browser binary path from the gnu-make file 2024-08-16 18:01:43 +02:00
Mamadou Babaei dba1ee290c formatting fix 2024-08-16 18:01:43 +02:00
Mamadou Babaei d2368533db add partial content to Handbook/src/advanced-topics/openxr/consuming-fxrmotioncontrollerdata/blueprint.md 2024-08-16 18:01:43 +02:00
Mamadou Babaei 8da516a169 minor fix 2024-08-16 18:01:43 +02:00
Mamadou Babaei 7d1a182900 add links to the ue source code from github 2024-08-16 18:01:43 +02:00
Mamadou Babaei f726697856 add the blueprint title line 2024-08-16 18:01:43 +02:00
Mamadou Babaei 96dad6e606 minor fix 2024-08-16 18:01:43 +02:00
Mamadou Babaei 9eee881350 minor fix 2024-08-16 18:01:43 +02:00
Mamadou Babaei 150ea6c169 mention the pdf format as well 2024-08-16 18:01:43 +02:00
Mamadou Babaei c7bf97032e add mdbook-pdf support which is able to print pdfs using chromedevtools protocol retaining images 2024-08-16 18:01:43 +02:00
Mamadou Babaei b186d1d85a remove cargo installs for typst-cli, mdbook-typst, and mdbook-epub 2024-08-16 18:01:43 +02:00
Mamadou Babaei 60d1166d72 move the /assets/* content to their relative folders as it creates printing issues 2024-08-16 18:01:43 +02:00
Mamadou Babaei 1ba70e0a5a add the content for the Consuming FXRMotionControllerData section 2024-08-16 18:01:43 +02:00
Mamadou Babaei 1b61d49d62 replace c++ standard int type definitions with the ones from unreal 2024-08-16 18:01:43 +02:00
Mamadou Babaei e72bbb7df4 remove the pdf and epub backend due to build errors and inability to show markdown images 2024-08-16 18:01:43 +02:00
Mamadou Babaei a51566d194 consider the value of site-url when verifying the handbook revision and simplify the makefile code to do so as well 2024-08-16 18:01:43 +02:00
Mamadou Babaei 1a18e8f200 make the default site-url next 2024-08-16 18:01:43 +02:00
Mamadou Babaei a964f8c2c7 mention the pdf and epub formats as well and rename the pdf output filename 2024-08-16 18:01:43 +02:00
Mamadou Babaei e6325ef3ca rename a page 2024-08-16 18:01:43 +02:00
Mamadou Babaei 9d0b5c9f05 switch to typst-cli from crates.io instead of git 2024-08-16 18:01:43 +02:00
Mamadou Babaei afece5c62b bump senseglove libraries to v2.104.1-55fddbd2 2024-08-16 18:01:42 +02:00
Mamadou Babaei d1a18d6e98 fix the inro notice 2024-08-16 18:01:42 +02:00
Mamadou Babaei 74a35dae3e fix a table column header 2024-08-16 18:01:42 +02:00
Mamadou Babaei 373297cc21 remove edit-url-template from the book.toml file 2024-08-16 18:01:42 +02:00
Mamadou Babaei b72e6bb07e minor fix 2024-08-16 18:01:42 +02:00
Mamadou Babaei 184c8d7d15 remove mdbook-lintcheck 2024-08-16 18:01:42 +02:00
Mamadou Babaei 72c6a0bb77 add github flavored markdown alerts to the handbook 2024-08-16 18:01:42 +02:00
Mamadou Babaei 777cd97963 add experimental mdbook plugins for epub and pdf generation 2024-08-16 18:01:42 +02:00
Mamadou Babaei ba6d461d36 fix the mdbook errors 2024-08-16 18:01:42 +02:00
Mamadou Babaei 512885c030 add more change logs 2024-08-16 18:01:42 +02:00
Mamadou Babaei 2ea5100f9a add more change logs 2024-08-16 18:01:42 +02:00
Mamadou Babaei 97e6f11282 update the changelog with many of the recent changes 2024-08-16 18:01:42 +02:00
Mamadou Babaei bbe9097320 minor changelog fix 2024-08-16 18:01:42 +02:00
Mamadou Babaei ba0e10aa03 add FSGDebugCube 2024-08-16 18:01:42 +02:00
Mamadou Babaei 0209458767 reorganize the handbook structure and add new sections 2024-08-16 18:01:42 +02:00
Mamadou Babaei b4b618f772 rename SGGameUserSettingSettings to SGGameUserSettingsSettings 2024-08-16 18:01:42 +02:00
Mamadou Babaei 63d0433ecd rename SGHardwareBenchmarkSettings to SGHardwareBenchmarkingSettings 2024-08-16 18:01:41 +02:00
Mamadou Babaei ebb8cabf3d apply the plugin settings when the user overrides the settings for the first time 2024-08-16 18:01:41 +02:00
Mamadou Babaei cb785a7213 do not ensure as it's possible to get a nullpointer during component uninitialization 2024-08-16 18:01:41 +02:00
Mamadou Babaei 990c62c586 re-implement the virtual hand settings overrides; and apply plenty of other improvements and bug fixes to the settings system; and introduce sgdebugcubesettings 2024-08-16 18:01:41 +02:00
Mamadou Babaei b23fafd451 rename verify-build-type target to verify-handbook-revision 2024-08-16 18:01:41 +02:00
Mamadou Babaei 9a72b93b0b rename verify-build-type target to verify-build-revision 2024-08-16 18:01:41 +02:00
Mamadou Babaei 140c52b9be remove the motion source wrist tracking overrides from the wrist tracker component due to the fact that it's utilized only inside the underlying tracking module and overriding it has no effects 2024-08-16 18:01:41 +02:00
Mamadou Babaei 1804cce12a re-implement the wrist tracking settings overrides 2024-08-16 18:01:41 +02:00
Mamadou Babaei 7c3ede865b rename bInIsVisibleWhenHandDataUnavailable to bInVisibleWhenHandDataUnavailable 2024-08-16 18:01:41 +02:00
Mamadou Babaei 7c5172b661 apply some sgxrtracker enum parsing improvements 2024-08-16 18:01:41 +02:00
Mamadou Babaei 86a9adae75 rename bIsVirtualHandVisible to bVirtualHandVisible 2024-08-16 18:01:41 +02:00
Mamadou Babaei 8aac677fac delete the engine utils default constructor and destructor 2024-08-16 18:01:41 +02:00
Mamadou Babaei 0408c2b67e add the editor utils class 2024-08-16 18:01:41 +02:00
Mamadou Babaei ec12cadfa4 fix the debug virtual hand settings and logic 2024-08-16 18:01:41 +02:00
Mamadou Babaei 81f3d03fd8 fix a comment 2024-08-16 18:01:41 +02:00
Mamadou Babaei fb876cc236 introduce the senseglove unreal engine handbook 2024-08-16 18:01:41 +02:00
Mamadou Babaei d69eb6cd96 a const correctness fix 2024-08-16 18:01:41 +02:00
Mamadou Babaei 58047435ac make FSGXRTracker::GetMotionControllerData() behave the same as 5.4 on both 5.2 and 5.3 2024-08-16 18:01:41 +02:00
Mamadou Babaei 99619c2a42 minor fix 2024-08-16 18:01:41 +02:00
Mamadou Babaei 5f58470f9c update the changelog and clarify what happens when other openxr hand tracking provider's are enabled and the possible workarounds 2024-08-16 18:01:41 +02:00
Mamadou Babaei 873534d246 workaround the runuat 5.2/5.3 build issue due to missing IOpenXRHMD.h from epic public headers 2024-08-16 18:01:41 +02:00
Mamadou Babaei 0259eedf48 fix various runuat buiild issues 2024-08-16 18:01:41 +02:00
Mamadou Babaei 0c32d5bb9f break a circular dependency 2024-08-16 18:01:41 +02:00
Mamadou Babaei 70164ef27d do not reigger OnGrabStateUpdated and OnTouchStateUpdated at all when the hand mesh is not valid or visible and also some other extra measures to make sure even if they are triggered they won't affect anything 2024-08-16 18:01:40 +02:00
Mamadou Babaei cedcd5dbdb take into account the device visual type when updating the hand visibility 2024-08-16 18:01:40 +02:00
Mamadou Babaei 32a010de27 clarify the meta xr and vive openxr plugins incompatibility 2024-08-16 18:01:40 +02:00
Mamadou Babaei d43e6692c0 rename variable 2024-08-16 18:01:40 +02:00
Mamadou Babaei 7a18efe25b seprate the engine and senseglove module dependency lists 2024-08-16 18:01:40 +02:00
Mamadou Babaei c2c410f969 implement our own GetMotionControllerData instead of using the one from the XRTrackingSystem as it only picks up the first hand tracking plugin in order to make sure at least internally we use the hand-tracking data from senseglove 2024-08-16 18:01:40 +02:00
Mamadou Babaei 10c4e045f2 minor fixes 2024-08-16 18:01:40 +02:00
Mamadou Babaei 26f44b45a6 mark the SenseGlove settings as DefaultConfig 2024-08-16 18:01:40 +02:00
Mamadou Babaei f85522b041 add more bluetooth permissions to be able to request access for nearby devices on android api level 32 in addition to 29 2024-08-16 18:01:40 +02:00
Mamadou Babaei 79b92dcfc8 add the gradle deprecation warnings 2024-08-16 18:01:40 +02:00
Mamadou Babaei 8c30058bc6 never extend the content browser context menu if any skeletal mesh or skeltons selected at the same time 2024-08-16 18:01:40 +02:00
Mamadou Babaei c8f9072de9 clean up and remove the redundant asset type actions no longer required by the senseglove sockets editor 2024-08-16 18:01:40 +02:00
Mamadou Babaei 31b7184016 implement the SenseGlove grab/touch sockets one-click-setup ability on any Epic-compliant virtual hand mesh from within the Unreal Editor's Content Browser, Skeleton Editor, or Skeletal Mesh Editor 2024-08-16 18:01:40 +02:00
Mamadou Babaei 2206d54631 update the implemented features list 2024-08-16 18:01:40 +02:00
Mamadou Babaei 332b0f3a82 revamp the whole settings system in order to unify the settings across various systems, modules, and api layers 2024-08-16 18:01:40 +02:00
Mamadou Babaei 4916aa394c make the virtual hand anim instance proxy safer 2024-08-16 18:01:40 +02:00
Mamadou Babaei 72888881aa minor fix: get object by reference 2024-08-16 18:01:40 +02:00
Mamadou Babaei 4784dcb66f add the DebugVirtualHandSettings to the Debugging category 2024-08-16 18:01:40 +02:00
Mamadou Babaei a30e3d85f5 rename SGVirtualHandTrackingSettings to SGVirtualHandSettings 2024-08-16 18:01:40 +02:00
Mamadou Babaei 698cd06f57 remove the deperecated jcenter repository from the android upl file 2024-08-16 18:01:40 +02:00
Mamadou Babaei cfff76cb8a mark the x86 and armeabi-v7a platforms as unsupported inside the android upl file 2024-08-16 18:01:40 +02:00
Mamadou Babaei 563c803741 fix a critical Android crash that happens where the default development hand meshes could not be found 2024-08-16 18:01:40 +02:00
Mamadou Babaei 7a8404d63f remove the hardcoded SG_HAND_MESH_YAW_CORRECTION_OFFSET and rely on FVirtualHandTrackingSettings::RootBoneRotationCorrection 2024-08-16 18:01:39 +02:00
Mamadou Babaei 731d4e8c9a update the changelog 2024-08-16 18:01:39 +02:00
Mamadou Babaei 42eaeccd71 mention the wrist tracking hardware visualization bug as a known issue with the new openxr system 2024-08-16 18:01:39 +02:00
Mamadou Babaei 1e7b4973a6 fix runuat build issues for ue 5.4 caused by missing headers 2024-08-16 18:01:39 +02:00
Mamadou Babaei 099c30a527 remove redundant header files 2024-08-16 18:01:39 +02:00
Mamadou Babaei 0a33eec318 fix more runuat issues due to missing headers 2024-08-16 18:01:39 +02:00
Mamadou Babaei 8d3802aa09 fix runuat build issues for ue 5.2 2024-08-16 18:01:39 +02:00
Mamadou Babaei 722b95627b fix a crash when the wrist-tracker hardware set to auto-detection 2024-08-16 18:01:39 +02:00
Mamadou Babaei 643b47b92a fix a few build issues 2024-08-16 18:01:39 +02:00
Mamadou Babaei fec98b78ac fix the wrong kismet library class name 2024-08-16 18:01:39 +02:00
Mamadou Babaei f2f2b909d5 formatting fix 2024-08-16 18:01:39 +02:00
Mamadou Babaei a1328df8b1 update the changelog 2024-08-16 18:01:39 +02:00
Mamadou Babaei cc2532bed8 whitespace fix 2024-08-16 18:01:39 +02:00
Mamadou Babaei a0bf55a8d8 add missing header that contains engine version definitions 2024-08-16 18:01:39 +02:00
Mamadou Babaei 0415fd4dac drop the minimal api specifier 2024-08-16 18:01:39 +02:00
Mamadou Babaei 43bf62f764 remove redundant headers 2024-08-16 18:01:39 +02:00
Mamadou Babaei f08f252d51 remove unnecessary initialization 2024-08-16 18:01:39 +02:00
Mamadou Babaei 9e8241bd3b whitespace fix 2024-08-16 18:01:39 +02:00
Mamadou Babaei d0730d402e fix wrong kismet script names and class exports 2024-08-16 18:01:39 +02:00
Mamadou Babaei 0950cf1fb8 remove the experimental bHandTrackingVisualizationAllowed feature 2024-08-16 18:01:39 +02:00
Mamadou Babaei 9a4b23054b remove SetWristTrackingSettings from the FSGWristTrackerComponent's header file since it does not have any implementation 2024-08-16 18:01:39 +02:00
Mamadou Babaei 9f0492f961 perform a ensure before dereferencing 2024-08-16 18:01:39 +02:00
Mamadou Babaei 50c0bae537 formatting fix 2024-08-16 18:01:39 +02:00
Mamadou Babaei efe893def3 revamp the GetControllerOrientationAndPosition and GetWristTransform to use the same caluclations and get rid of bMotionSourceHandTracking in senseglove joint calculations 2024-08-16 18:01:38 +02:00
Mamadou Babaei f726960abc check if motioncontrollerdata is valid 2024-08-16 18:01:38 +02:00
Mamadou Babaei 6350c08332 remove the ability to override wrist tracking settings from the wrist tracker component 2024-08-16 18:01:38 +02:00
Mamadou Babaei 107dc1b713 fix the how we determine the motion source inside the GetControllerOrientationAndPosition and GetControllerTrackingStatus for ue versions earlier than 5.3 2024-08-16 18:01:38 +02:00
Mamadou Babaei 5d61d4a99f add htc vive stand-alone support status to the platform support matrix 2024-08-16 18:01:38 +02:00
Mamadou Babaei 4be655888d fix ue 5.2 and 5.3 build issues 2024-08-16 18:01:38 +02:00
Mamadou Babaei 6d6dfa1f77 update the changelog and the readme 2024-08-16 18:01:38 +02:00
Mamadou Babaei 3636347f72 update the changelog 2024-08-16 18:01:38 +02:00
Mamadou Babaei 6eb4777842 add the editor user interface for adding the senseglove sockets 2024-08-16 18:01:38 +02:00
Mamadou Babaei 143fdad989 temporarility change the way we calculate the wrist offset 2024-08-16 18:01:38 +02:00
Mamadou Babaei 8daae2e794 remove SGWristTrackerVisualizationComponent 2024-08-16 18:01:38 +02:00
Mamadou Babaei 0828396722 fix a few wrist tracker issues and introduce SGWristTrackerVisualizationComponent 2024-08-16 18:01:38 +02:00
Mamadou Babaei 8e1226a324 pass outer as the worldcontextobject to glovetracker::getinstance 2024-08-16 18:01:38 +02:00
Mamadou Babaei 2f23fffb73 make USGGloveTracker::GetInstance as flexible as possible 2024-08-16 18:01:38 +02:00
Mamadou Babaei f044fa9f66 simplify getworld implementation 2024-08-16 18:01:38 +02:00
Mamadou Babaei 10d14bb40f migrate the static getworld to sgengineutils 2024-08-16 18:01:38 +02:00
Mamadou Babaei 271317b292 safer in-editor getworld without the polluting logs 2024-08-16 18:01:38 +02:00
Mamadou Babaei 0c7ccd9ed9 fix the you are not the main thread and the editor is currently in a play mode errors 2024-08-16 18:01:38 +02:00
Mamadou Babaei 821215a78a fix the MarkRenderStateDirty data race condition by gathering as much as data only on the game thread 2024-08-16 18:01:38 +02:00
Mamadou Babaei 6f64f0c34a introduce bValidateIfDefaultClassesAreSGCompliant 2024-08-16 18:01:38 +02:00
Mamadou Babaei 7d5c0904e9 fix the blueprint category naming to adhere to the rest of the settings system 2024-08-16 18:01:38 +02:00
Mamadou Babaei 5f7e0d161d move hardware benchmarking settings to its own class 2024-08-16 18:01:38 +02:00
Mamadou Babaei 0554e288c3 disable bFallbackToHandTrackingIfNoGloveDetected by default 2024-08-16 18:01:38 +02:00
Mamadou Babaei 528243f849 fix a bug where sgpawn hand's finger collider interact with the world when the hand is not mesh visible 2024-08-16 18:01:37 +02:00
Mamadou Babaei 3325cb5e8f add the USGVirtualHandComponent::OnHandVisibilityChanged() event 2024-08-16 18:01:37 +02:00
Mamadou Babaei 76f5dda49a try to disable collision alltogether when the hand mesh is not visible 2024-08-16 18:01:37 +02:00
Mamadou Babaei 036b382109 update the changelog 2024-08-16 18:01:37 +02:00
Mamadou Babaei 2b7f5bd5e2 improve the sgusersettings implementation by introducing custom enum item and more accuracy 2024-08-16 18:01:37 +02:00
Mamadou Babaei 32073d34f4 implement the game user settings system 2024-08-16 18:01:37 +02:00
Mamadou Babaei 0405f6bc7c minor formatting fix 2024-08-16 18:01:37 +02:00
Mamadou Babaei 8cd10ae312 minor formatting fix 2024-08-16 18:01:37 +02:00
Mamadou Babaei 715c3b8617 add a partial workaround for a bug when the virtual hand inside the game is not visible but still have collisions with other objects inside the scene 2024-08-16 18:01:37 +02:00
Mamadou Babaei 23d30f92cd add IsAMetaQuestDevice() and IsAHtcViveDevice() methods 2024-08-16 18:01:37 +02:00
Mamadou Babaei cd93e78d2e fix vive pro detection issues by introducing additional device identifier 2024-08-16 18:01:37 +02:00
Mamadou Babaei 5acd74c855 removed the allbreaker virtual hand model as it's no longer compatible with the openxr integration 2024-08-16 18:01:37 +02:00
Mamadou Babaei 92ee0fb231 fix android build issues 2024-08-16 18:01:37 +02:00
Mamadou Babaei 281d00bfac update the changelog 2024-08-16 18:01:37 +02:00
Mamadou Babaei 926f10ad9a remove minor ue 5.1 comments and hints 2024-08-16 18:01:37 +02:00
Mamadou Babaei 2666191634 update the changelog 2024-08-16 18:01:37 +02:00
Mamadou Babaei 5a917afa27 implement bHandTrackingVisualizationAllowed 2024-08-16 18:01:37 +02:00
Mamadou Babaei d8248bfaec improve the wrist tracking code when using motion controllers 2024-08-16 18:01:37 +02:00
Mamadou Babaei b54067945a refactor the sgxrtracker internals to use transforms as pimpl methods args instead of a combination of fvectors/fquats 2024-08-16 18:01:37 +02:00
Mamadou Babaei 2d495b0f6b minor fixes, mostrly formatting 2024-08-16 18:01:37 +02:00
Mamadou Babaei 33b0e8a167 remove unused pimpl method 2024-08-16 18:01:37 +02:00
Mamadou Babaei 852f19eb92 remove dead code 2024-08-16 18:01:37 +02:00
Mamadou Babaei 19d6badb66 even more optimal fxrmotioncontroller data calculations that considers mesh when outputting senseglove data 2024-08-16 18:01:37 +02:00
Mamadou Babaei ce20af5c31 document more unreleased changes 2024-08-16 18:01:36 +02:00
Mamadou Babaei ce7dd27505 fix the wrong palm bone names on the allbreaker virtual hand models 2024-08-16 18:01:36 +02:00
Mamadou Babaei 0f9039fa86 somewhat unfinished refactored sg bone calculations 2024-08-16 18:01:36 +02:00
Mamadou Babaei 6a20cf3464 increase the default finger distal phalanges length 2024-08-16 18:01:36 +02:00
Mamadou Babaei 89ec8efe79 add the senseglove debug kismet module 2024-08-16 18:01:36 +02:00
Mamadou Babaei ec7eb93ed7 unfinished improvements based on the last commit 2024-08-16 18:01:36 +02:00
Mamadou Babaei b68faeeb7e attempt at calculating a hand model and feeding it to get hand pose 2024-08-16 18:01:36 +02:00
Mamadou Babaei c744a27a08 refactor the way we calculate the mesh bone reference transforms to read from the settings system instead of the hardcoded values 2024-08-16 18:01:36 +02:00
Mamadou Babaei fa9d45b3d5 add the hard-coded hand defaulet reference bone transfomrs to the virtual hand settings 2024-08-16 18:01:36 +02:00
Mamadou Babaei 0242b63817 openxr bugfixes and improvements + 1st attempt at calculating the fxrmotioncontrollerdata based off of the hand mesh 2024-08-16 18:01:36 +02:00
Mamadou Babaei 27aad3f005 fix more UE 5.4 RunUAT build issues 2024-08-16 18:01:36 +02:00
Mamadou Babaei e78adbab69 refactor the animation, wrist tracking, and hand interaction manipulation systems for FXRMotionControllerData compatibility 2024-08-16 18:01:36 +02:00
Mamadou Babaei 0f6e16b863 update the readme 2024-08-16 18:01:36 +02:00
Mamadou Babaei 10a8b3e793 implement the OpenXR-compatible hand tracking (XR_EXT_hand_tracking) support 2024-08-16 18:01:36 +02:00
Mamadou Babaei 3a2a50fd4b rename sgheadmountdisplay to sgheadmounteddisplay 2024-08-16 18:01:36 +02:00
Mamadou Babaei c7df5d7287 add extra null checks 2024-08-16 18:01:36 +02:00
Mamadou Babaei 71847e84f4 add vive xr elite hmd auto-detection checkes and other vive headset detection bug fixes and improvements 2024-08-16 18:01:36 +02:00
Mamadou Babaei 9fb69e1e22 remove ASGVirtualHandActor 2024-08-16 18:01:36 +02:00
Mamadou Babaei 1e77d973d7 make the sgsettings constructor private 2024-08-16 18:01:36 +02:00
Mamadou Babaei 9238109b6f bump senseglove libraries to v2.102.0-4a8bd81d and drop support for ue 5.1 and epic native toolchain v20 2024-08-16 18:01:35 +02:00
Mamadou Babaei 8d9ef757a7 remove debug logs from FSGHeadMountDisplay::GetDeviceType() 2024-08-16 18:01:35 +02:00
Mamadou Babaei 113cd4edde check hmd auto-detection against various identifiers as the names returns from the engine is not reliable 2024-08-16 18:01:35 +02:00
Mamadou Babaei 252b78af22 improve vive pro and vive focus 3 detection by utilizing optic resolution to distinguish them 2024-08-16 18:01:35 +02:00
Mamadou Babaei 1440489dc3 implement hmd and wrist tracker hardware auto-detection fallback when it's not set explicitly 2024-08-16 18:01:35 +02:00
Mamadou Babaei 1bbe19074b bump the plugin version to v2.0.8 2024-07-16 00:30:16 +02:00
Mamadou Babaei f354904290 fix a bug where the sgpawn right-hand grab colliders' default size is mistakenly set to the default value for the left-hand grab colliders at cdo initialization time 2024-07-16 00:30:16 +02:00
Mamadou Babaei f95242abdf bump the plugin version to v2.0.7 2024-05-29 12:48:31 +02:00
Mamadou Babaei 9e06a76183 make the allbreaker assets compatible with ue 5.1+ again 2024-05-29 12:48:31 +02:00
Mamadou Babaei 99b0a7a624 bump the plugin version to v2.0.6 2024-05-29 11:40:44 +02:00
Mamadou Babaei 35ade3c676 remove dev/test virtual hand models that leaked into the 5.3 branch 2024-05-29 11:34:24 +02:00
Mamadou Babaei 722c5fe7d8 bump the plugin version to v2.0.5 2024-05-22 17:33:53 +02:00
Mamadou Babaei 34559c81cd fix the wrong palm bone names on the allbreaker virtual hand models 2024-05-22 17:33:52 +02:00
Mamadou Babaei c76ae5ad59 bump the plugin version to v2.0.4 2024-05-17 11:41:09 +02:00
Mamadou Babaei 4f31b7a8d1 bump the plugin version to v2.0.3 2024-05-16 20:01:59 +02:00
Mamadou Babaei 0c785c1ffd fix v2.0.2 UE 5.4 RunUAT build issues that mostly caused by missing headers 2024-05-15 04:43:49 +02:00
Mamadou Babaei b43f06fa7a improve target platform detection when building SenseGloveConnectImpl and SenseGloveCoreImpl modules and also distinguish x64 builds from arm64 on windows 2024-05-15 04:43:48 +02:00
Mamadou Babaei deb7778aed fix: asking CppCompileEnvironment for a single Architecture, but it has multiple Architectures (arm64, x64) 2024-05-15 04:43:47 +02:00
Mamadou Babaei e88533db1d bump the plugin version to v2.0.2 2024-04-25 12:56:51 +02:00
Mamadou Babaei f57c57d93b bump the plugin version to v2.0.1 2024-04-15 15:09:02 +02:00
Mamadou Babaei dc4412e3fd do not call FSGHandLayer::ResetCalibration on every backend initialization 2024-04-15 15:09:01 +02:00
Mamadou Babaei c201da4f33 only instantiate the connected glove once instead of recreating and destroying it every frame 2024-04-15 15:09:00 +02:00
Mamadou Babaei e3053fee04 bump senseglove libraries to v2.102.0-35d4de3f 2024-04-15 15:09:00 +02:00
Mamadou Babaei 53caea650d fix the wrong header file description sections for the header files 2024-04-15 15:08:58 +02:00
Mamadou Babaei 06a60da7e4 update the changelog with the unreleased changes 2024-04-15 15:08:58 +02:00
Mamadou Babaei 01b0d43ab3 update the outdated platform support matrix remarks 2024-03-23 17:24:46 +01:00
Mamadou Babaei fd0bbfa2b5 add ue 5.4 to the list of supported engines through azure devops 2024-03-23 17:24:46 +01:00
Mamadou Babaei e8c631841b bump the plugin version to v2.0.0 2024-03-22 21:36:00 +01:00
Mamadou Babaei 7d970fc13f update the changelog 2024-03-22 21:36:00 +01:00
Mamadou Babaei d48a4f1bf0 add missing modules to the directory structure 2024-03-22 21:35:59 +01:00
Mamadou Babaei 67646bbacf update the planned features status 2024-03-22 20:59:52 +01:00
Mamadou Babaei a1d820b688 fix other build issues with non-unity builds 2024-03-22 20:59:52 +01:00
Mamadou Babaei 8921c2676a add the missing string header that causes build issues in non-unity builds 2024-03-22 20:59:52 +01:00
Mamadou Babaei cc5dd956cc remove the platform dependant build hacks inside FSGArrayUtils::FromStdVector as msvc is not able to deduce TArray<T>::SizeType 2024-03-22 20:59:51 +01:00
Mamadou Babaei de6fec33cf bump the senseglove libraries to v2.101.12-62b1be11 2024-03-22 20:59:51 +01:00
Mamadou Babaei 44cd706daa fix android build issue inside FSGArrayUtils::FromStdVector introduced by 0cdc7e03ac 2024-03-22 20:59:51 +01:00
Mamadou Babaei e3f28ce1a7 Revert "try to init/uninit the backend module at the module start/shutdown"
This reverts commit c45bcaf618.
2024-03-22 20:59:51 +01:00
Mamadou Babaei 19818746bd fix a build issue inside FSGArrayUtils::FromStdVector introduced by newer msvc updates due to stricter implicit uint64 to int32 conversions 2024-03-22 20:59:51 +01:00
Mamadou Babaei 58b863257e bump the senseglove backend libraries to v2.101.11-2d6fe9ce 2024-03-22 20:59:50 +01:00
Mamadou Babaei deeb71d119 correct the module logs grammars 2024-03-22 20:59:50 +01:00
Mamadou Babaei 273a10bf3c try to init/uninit the backend module at the module start/shutdown 2024-03-22 20:59:50 +01:00
Mamadou Babaei 41aad88a28 allow the c++ compiler the opportunity to perform rvo/nrvo if applicable 2024-03-22 20:59:50 +01:00
Mamadou Babaei 63466786fe bump senseglove libraries to v2.101.10-7e515114 2024-03-22 20:59:49 +01:00
Mamadou Babaei 446fed595f update the changelog with added quest 3 controllers support 2024-03-22 20:59:49 +01:00
Mamadou Babaei c78fb20eef integrate the virtual hand mesh from allbreaker 2024-03-22 20:59:47 +01:00
Mamadou Babaei 11a6e6ed63 remove redundant headers 2024-03-22 20:59:24 +01:00
Mamadou Babaei 06966042d1 expose as little as dependencies as possible 2024-03-22 20:59:23 +01:00
Mamadou Babaei 079990b2c5 correct the hand mesh yaw rotation inside the sgpawn after the squat/sgvect3d changes 2024-03-22 20:59:23 +01:00
Mamadou Babaei 9b1385edef replace SupportedTargetPlatforms with PlatformAllowList 2024-03-22 20:59:23 +01:00
Mamadou Babaei 7db37a4fa6 clean up unsed unreal version headers 2024-03-22 20:59:23 +01:00
Mamadou Babaei 25664bf6f3 declare the openxr plugin as a dependency 2024-03-22 20:59:23 +01:00
Mamadou Babaei e5cfcb3405 utilize UXRDeviceVisualizationComponent to display meshes on UE 5.2 onwards 2024-03-22 20:59:23 +01:00
Mamadou Babaei 85c378db38 fix the changelog errors 2024-03-22 20:59:23 +01:00
Mamadou Babaei 5f7c987fae remove a changelog that is not valid anymore 2024-03-22 20:59:23 +01:00
Mamadou Babaei aaa32574e9 bump the senseglove libraries to v2.101.9-8abfc26d 2024-03-22 20:59:22 +01:00
Mamadou Babaei 038441266c bump the plugin version to v1.9.8 2024-03-22 20:59:22 +01:00
Mamadou Babaei 86db7ae4dd apply a temporary workaround in order to ameliorate the hand animation after sgquat, sgvect3d fixes 2024-03-22 20:59:22 +01:00
Mamadou Babaei 2a010811a3 make bones rotations a private field 2024-03-22 20:59:22 +01:00
Mamadou Babaei f8046a27cb update the changelog 2024-03-22 20:59:22 +01:00
Mamadou Babaei 9b5beaaf61 proper angle conversions for vectors 2024-03-22 20:59:22 +01:00
Mamadou Babaei f08dbf57b9 proper sgvect3d and squat conversions to fvector and fquat 2024-03-22 20:59:22 +01:00
Mamadou Babaei cf62bf1274 apply senseglove/unreal angle conversions in the gloves' api 2024-03-22 20:59:22 +01:00
Mamadou Babaei 3f21d3302c fix a crash when calling one of the SGHandInterpolatorImpl constructors which happens due to unintialized pimpl object 2024-03-22 20:59:22 +01:00
Mamadou Babaei 36b5b30148 update the changelog 2024-03-22 20:59:22 +01:00
Mamadou Babaei f9e15913c8 bump senseglove libraries to v2.101.8-a2a2075b which resolves the android writehaptics crash 2024-03-22 20:59:21 +01:00
Mamadou Babaei ae760aaa36 update the change log with unreleased changes 2024-03-22 20:59:21 +01:00
Mamadou Babaei b9691e2807 bump senseglove libraries to v2.101.7-3580cd9f 2024-03-22 20:59:21 +01:00
Mamadou Babaei 3e96da7f08 bump senseglove libraries to v2.101.5-f0aff76b 2024-03-22 20:59:20 +01:00
Mamadou Babaei fd645b6925 bump senseglove libraries to v2.101.4-6c860c42 with android fixes and fix a android crash 2024-03-22 20:59:19 +01:00
Mamadou Babaei 95f0e003b2 bump senseglove libraries to v2.101.3-e583f6de 2024-03-22 20:59:18 +01:00
Mamadou Babaei ecd701d8e6 implement the api updates and bump the senseglove libraries to v2.101.2-2eb7439f 2024-03-22 20:59:17 +01:00
Mamadou Babaei 503d13cabc force glove recalibration on backend initialize 2024-03-22 20:59:17 +01:00
Mamadou Babaei a7d9c4bfca add as*glove/device casting methods that resolves the sgpawn vibrotactile issues 2024-03-22 20:59:17 +01:00
Mamadou Babaei 4a572e06f9 use device impl casts 2024-03-22 20:59:17 +01:00
Mamadou Babaei 80f1b4c770 list nova 2 gloves in the get devices from the device list 2024-03-22 20:59:17 +01:00
Mamadou Babaei 8ba5b84f37 another attempt at improving the glove casts 2024-03-22 20:59:17 +01:00
Mamadou Babaei aa3e2af861 try an alternative approach for glove instances upcasting at the lower levels of the api 2024-03-22 20:59:17 +01:00
Mamadou Babaei 10d7b5b853 try to add a solution for glove type-casting in higher levels of the api 2024-03-22 20:59:17 +01:00
Mamadou Babaei 3af01c23a4 fix the send custom waveform signature on the hand layer 2024-03-22 20:59:17 +01:00
Mamadou Babaei 078eee1c38 fix a bug inside the ESGHapticLocation enum conversions 2024-03-22 20:59:17 +01:00
Mamadou Babaei 764961e7d0 bump senseglove libraries for v2.101.1-edc1163a 2024-03-22 20:59:16 +01:00
Mamadou Babaei 0b0ba04a43 implement the nova2 api updates and bump the senseglove libraries to v2.101.0-3e1693fb 2024-03-22 20:59:16 +01:00
Mamadou Babaei aecd56326e bump the plugin version to v1.9.8 2024-03-12 20:32:39 +01:00
Mamadou Babaei 9e9c724ece make bones rotations a private field 2024-03-12 20:32:39 +01:00
Mamadou Babaei c10ba275a0 fix a crash inside the USGHandPose::FromHandAngles in higher levels of the api 2024-03-12 20:32:38 +01:00
Mamadou Babaei fe9c282885 drop the prefix for internal typedefs 2024-03-12 20:32:38 +01:00
Mamadou Babaei 415dfba694 add some performance optimizations by utilizing MoveTemp in return statements 2024-03-12 20:32:37 +01:00
Mamadou Babaei d2dd65dc54 fix a bug where the right hand mesh is always hidden inside the game no matter whether the right glove is connected or not 2024-03-12 20:32:37 +01:00
Mamadou Babaei 71772c568f fix a wrong variable name 2024-03-12 20:32:36 +01:00
Mamadou Babaei e6479c16e7 only include the sgconnect header if the build platform is android 2024-03-12 20:32:36 +01:00
Mamadou Babaei f591c7ef9d bump the plugin version to v1.9.7 2024-02-18 20:30:07 +01:00
Mamadou Babaei daa335e2dd apply vibrotactile and force-feedback fixes backported from next major release 2024-02-18 20:30:07 +01:00
Mamadou Babaei 9b416115f8 bump the plugin version to v1.9.6 2024-02-14 14:56:27 +01:00
Mamadou Babaei d0aa66bfa8 fix the NovaGlove class instantiation methods to initialize a NovaGloveImpl instead of a SenseGloveImpl 2024-02-14 14:56:27 +01:00
Mamadou Babaei e992475b15 bump the plugin version to v1.9.5 2024-02-09 10:53:35 +01:00
Mamadou Babaei 6046e576db fix a potential segfault inside SGDeviceModel::ParseFirmware 2024-02-09 10:53:35 +01:00
Mamadou Babaei 9fad645027 bump the plugin version to v1.9.4 2024-02-08 07:47:45 +01:00
Mamadou Babaei 59473aa4e3 fix the bluprint parse fucntion signature to accept OutGloveInfo by reference 2024-02-08 07:47:45 +01:00
Mamadou Babaei e370ff5c88 fix changelog formatting 2024-02-08 07:47:45 +01:00
Mamadou Babaei 66a473d01c bump the plugin version to v1.9.3 2024-02-03 04:53:45 +01:00
Mamadou Babaei 0f9bf98845 rephrase fixed changes 2024-02-03 04:53:45 +01:00
Mamadou Babaei 764642e9c8 bump the copyright years 2024-02-03 04:53:45 +01:00
Mamadou Babaei ce0f9a7813 minor changelog fixes 2024-02-03 04:53:45 +01:00
Mamadou Babaei d33bfb3dbf fix the wrong version numbers inside the paltform support matrix and the main .uplugin file 2024-02-03 04:53:45 +01:00
Mamadou Babaei a2faffeeb9 apply a few critical fixes backported from the next major release 2024-02-03 04:53:45 +01:00
Mamadou Babaei 4b577a83d7 a minor changelog fix 2024-02-03 04:53:45 +01:00
Mamadou Babaei b367211ef5 bump the plugin version to v1.9.2 2023-11-03 18:38:42 +01:00
Mamadou Babaei 6c0ee7292d fix a bug where released actor is going to be null whenever the OnActorReleased event fires 2023-11-03 18:38:42 +01:00
Mamadou Babaei fd5a2e5569 restructure the planned features completion status 2023-11-03 18:38:41 +01:00
Mamadou Babaei 6ab09fc330 update the list of planned features and their completion status 2023-11-03 18:38:41 +01:00
Mamadou Babaei d6e4ffa95d update the list of planned features and their completion status 2023-11-03 18:38:40 +01:00
Mamadou Babaei 9be6bc96bc update the list of planned features and their completion status 2023-11-03 18:38:40 +01:00
Mamadou Babaei c704cafd83 add a list of planned features and their completion status to the main readme file 2023-11-03 18:38:39 +01:00
Mamadou Babaei fc32d7f816 bump the plugin version to v1.9.1 2023-10-11 17:03:18 +02:00
Mamadou Babaei 753bfa57df add the missing unreal header that defines ENGINE_*_VERSION macros in order to pass epic store builds for ue 5.3 2023-10-11 17:03:18 +02:00
Mamadou Babaei 22ee09fc2d bump the plugin version to v1.9.0 2023-10-10 17:31:16 +02:00
Mamadou Babaei ea885503ea change the ufunction specifier for sgpawn blueprint implementable events to blueprint native event in order to allow overrides from c++ as well 2023-10-10 17:31:16 +02:00
Mamadou Babaei 2756410129 add a missing release note fix for v1.8.0 to the changelog file 2023-10-10 17:31:15 +02:00
Mamadou Babaei 0bf3f10f80 bump the plugin version to v1.8.0 2023-10-10 16:13:42 +02:00
Mamadou Babaei 1d7482cc23 This single commit inroduces the following changes:
- 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.
2023-10-10 16:13:42 +02:00
Mamadou Babaei db74a8bcd8 bump the plugin version to v1.7.0 2023-09-14 18:53:38 +02:00
Mamadou Babaei fe236eafdf bump senseglove headers and libraries for linux and android to v2.12.0-19c9854 2023-09-14 18:53:38 +02:00
Mamadou Babaei 74807283f3 bump senseglove libraries for windows to v2.12.0-19c9854 2023-09-14 18:53:37 +02:00
Mamadou Babaei 005522d05c move SGCoreImpl/SGPlatform to SGBuildHacks/SGPlatform and introduce SG_CPP20 and SG_CAPTURE_THIS 2023-09-14 18:53:37 +02:00
Mamadou Babaei e00b684ff1 update the changelog 2023-09-14 18:53:37 +02:00
Mamadou Babaei 8a469e4870 update the changelog with unreleased changes 2023-09-14 18:53:37 +02:00
Mamadou Babaei 6245d77fac introduce senseglove backend and backend kismet modules in order to properly initialize the backend in order to avoid a bug where sgcoonect::init gets called every frame 2023-09-14 18:53:37 +02:00
Mamadou Babaei d09fa355cc update the changelog with unreleased changes 2023-09-14 18:53:37 +02:00
Mamadou Babaei ada6fd05d4 remove a duplicate log 2023-09-14 18:53:37 +02:00
Mamadou Babaei 7e2c6212bc add sggameinstance for future use 2023-09-14 18:53:37 +02:00
Mamadou Babaei c470274f14 remove a duplicated slash in a header's path 2023-09-14 18:53:37 +02:00
Mamadou Babaei e091b3a541 bump the plugin version to v1.6.1 2023-08-14 21:24:03 +02:00
Mamadou Babaei 14b86ef351 fix the platform support matrix 2023-08-14 21:24:03 +02:00
Mamadou Babaei e468558c43 add a missing header that causes build issues on ue 5.0 2023-08-14 21:24:02 +02:00
Mamadou Babaei 0c3c969023 set the engine version to v5.3.0 2023-08-14 17:31:21 +02:00
9186 changed files with 65614 additions and 45404 deletions
+10
View File
@@ -38,3 +38,13 @@ 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
+8
View File
@@ -125,3 +125,11 @@ 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
-299
View File
@@ -1,299 +0,0 @@
# 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.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.
+3 -1
View File
@@ -1,3 +1,5 @@
[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
Binary file not shown.
Binary file not shown.
Binary file not shown.
Binary file not shown.
Binary file not shown.
Binary file not shown.
Binary file not shown.
+34
View File
@@ -0,0 +1,34 @@
#
# 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}
+695
View File
@@ -0,0 +1,695 @@
#
# 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 --version "0.4.49" --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 cac03b7f4b151f106f7f05b13da4c33fc098dd2c --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)
+91
View File
@@ -0,0 +1,91 @@
# 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/).
+106
View File
@@ -0,0 +1,106 @@
#!/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 '.'
+115
View File
@@ -0,0 +1,115 @@
#
# 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
+6
View File
@@ -0,0 +1,6 @@
# Reset all rules from parent .gitignore files!
!*/
!**/*
# Recursively ignore all __pycache__ folders!
__pycache__/
Binary file not shown.
Binary file not shown.
Binary file not shown.
Binary file not shown.
BIN
View File
Binary file not shown.
BIN
View File
Binary file not shown.
Binary file not shown.
Binary file not shown.
Binary file not shown.
Binary file not shown.
Binary file not shown.
BIN
View File
Binary file not shown.
Binary file not shown.
Binary file not shown.
Binary file not shown.
Binary file not shown.
Binary file not shown.
Binary file not shown.
Binary file not shown.
Binary file not shown.
Binary file not shown.
Binary file not shown.
Binary file not shown.
Binary file not shown.
Binary file not shown.
Binary file not shown.
Binary file not shown.
Binary file not shown.
Binary file not shown.
Binary file not shown.
Binary file not shown.
Binary file not shown.
Binary file not shown.
Binary file not shown.
Binary file not shown.
Binary file not shown.
Binary file not shown.
Binary file not shown.
Binary file not shown.
Binary file not shown.
Binary file not shown.
Binary file not shown.
Binary file not shown.
Binary file not shown.
Binary file not shown.
Binary file not shown.
Binary file not shown.
Binary file not shown.
Binary file not shown.
Binary file not shown.
Binary file not shown.
Binary file not shown.
Binary file not shown.
Binary file not shown.
Binary file not shown.
Binary file not shown.
Binary file not shown.
Binary file not shown.
Binary file not shown.
Binary file not shown.
Binary file not shown.

Some files were not shown because too many files have changed in this diff Show More