kinecttovr/amethyst-releases

This repository holds the published releases of Amethyst

Discord server | Site

KinectToVR

KinectToVR is an application for emulating Vive trackers in SteamVR for full-body tracking using a Kinect for Xbox 360, Kinect for Xbox One or PlayStation Move controllers and cameras.

This version of the app (0.9) will be the last based on this repo. Development on 1.0 and onward is happening elsewhere, more on that later.

Authors

AutoCalibration scripts are written by コレヂャン
KinectToVR base is Sharky's
Triping organizes the whole project
The installer's property of Himbeer
Rest is probably written by 公彦赤屋先

License

This project is licensed under the GNU GPL v3 License

Build

You'll need:

• Visual Studio 2019 (with: C++, v142 tools, ATL)
  or just build tools for same (see GitHub Actions script)
• Kinect SDK 1.8 & 2.0 installed and visible in PATH
• Working installation of SteamVR for testing

Follow GitHub Actions script, or:

• Install vcpkg and its Visual Studio integration
  (cd into somewhere you want it to be)
  git clone https://github.com/Microsoft/vcpkg.git
cd vcpkg
./bootstrap-vcpkg.sh
./vcpkg integrate install

• Install needed libraries (You should choose one linking method for all packages)
  vcpkg install opencv3[world]:x64-windows boost:x64-windows glm:x64-windows curlpp:x64-windows cereal:x64-windows sfml:x64-windows glew:x64-windows
  (Now you may rest a bit, also consider using a drive other than C:, it'll be about 6-7GB without cleaned buildtrees)

• Clone the latest OpenVR, GLM and Eigen3 into external/:
  git clone https://github.com/ValveSoftware/openvr external/openvr
git clone https://gitlab.com/libeigen/eigen external/eigen git clone https://github.com/g-truc/glm external/glm

• Fix min/max error in GLM (unresolved with NOMINMAX for now) sed -i '/#include <limits>/c\#include <limits>\n\n#undef min\n#undef max' external/glm/glm/gtx/component_wise.inl

• Clone the latest K2APP and setup shortcuts to external deps:
  git clone https://github.com/KinectToVR/k2vr-application external/KTVR
New-Item -ItemType Junction -Path external/KTVR/external/openvr -Target external/openvr
New-Item -ItemType Junction -Path external/KTVR/external/eigen -Target external/eigen
New-Item -ItemType Junction -Path external/KTVR/external/glm -Target external/glm

• Setup GLog
  git clone https://github.com/google/glog.git external/glog
git reset --hard f8c8e99fdfb998c2ba96cfb470decccf418f0b30
cd external/glog
mkdir vcbuild; cd vcbuild
cmake -DBUILD_SHARED_LIBS=ON ..
msbuild glog.vcxproj "/p:Configuration=Release;Platform=x64
WindowsTargetPlatformVersion=10.0"
  

• Setup GFlags
  git clone https://github.com/gflags/gflags.git external/gflags
git reset --hard 827c769e5fc98e0f2a34c47cef953cc6328abced
cd external/gflags
mkdir vcbuild; cd vcbuild
cmake -DBUILD_SHARED_LIBS=ON ..
msbuild gflags.vcxproj "/p:Configuration=Release;Platform=x64;WindowsTargetPlatformVersion=10.0"
  

• Setup SFGUI
  git clone https://github.com/KimihikoAkayasaki/SFGUI external/SFGUI
cd external/SFGUI
mkdir build; cd build
cmake "-DBUILD_SHARED_LIBS=ON [YOUR VCPKG TOOLCHAIN COMMAND HERE]" ..
msbuild SFGUI.vcxproj "/p:Configuration=Release;Platform=x64;WindowsTargetPlatformVersion=10.0"
  

• Build the K2API & K2APP's OpenVR driver:
  msbuild "/t:KinectToVR_API" "/p:Configuration=Release;Platform=x64;WindowsTargetPlatformVersion=10.0"
msbuild "/t:Driver_KinectToVR" "/p:Configuration=Release;Platform=x64;WindowsTargetPlatformVersion=10.0"

• Build the K2EX:
  msbuild "/p:Configuration=Release;Platform=x64;WindowsTargetPlatformVersion=10.0"

Deploy

All needed dlls are automatically copied to the output folder.
Please note that everything from vcpkg is being linked dynamically,
so to avoid errors with the driver, if you've added any additional libraries,
build it alone and copy to the desired folder, including all present dlls inside the output folder.
For now, the folder structure is generated and dlls are copied automatically.
You will find the built driver in external/KTVR/x64/$(Configuration)/driver/
and the built K2EX in x64/$(Configuration). (Release configuration should be used, though)

amethyst-releases's Issues

Backward facing trackers?

After the calibration the trackers have been placed in the correct places but they were all facing in the opposite direction.
I had to manually flip every tracker by setting a 180° rotation, this completely resolved the issue.
This also happens by using the official stable K2VR release.

Request: Switch joycon support

have it work similar to owotrack but for a switch joycon via bluetooth.
you could either put in native joycon support or make slimevr wrangler to work.

Amethyst Crashes With Azure Kinect Driver 1.0

While in the 'dashboard is closed' state the app seems fine, it connects to the Kinect and shows status for device and steame vr as 'succeeded'.

I can get the app to sometimes show me a skeleton before it crashes when i power up the headset.

Once I have an app (say vrchat) try to access the FBT amethyst crashes and generates a WER.

Let me know if you want more logs or bet

WER Metadata:

Faulting application name: Amethyst.exe, version: 1.2.8.0, time stamp: 0x65310000
Faulting module name: k4abt.DLL, version: 1.1.2.0, time stamp: 0x627d5fb4
Exception code: 0xc0000005
Fault offset: 0x0000000000297918
Faulting process id: 0x0xC1B8
Faulting application start time: 0x0x1DA46A1D83F895E
Faulting application path: C:\Program Files\WindowsApps\11835K2VRTeam.Amethyst-OpenSourceBodyTracking_1.2.8.0_x64__g2vc4cfdbyb66\Amethyst.exe
Faulting module path: C:\Users\alex\AppData\Local\Packages\11835K2VRTeam.Amethyst-OpenSourceBodyTracking_g2vc4cfdbyb66\LocalState\Plugins\K2VRTEAM-AME2-APII-DVCE-DVCEKINECTAZ\k4abt.DLL
Report Id: 82d6263c-5703-4cc6-bafd-146bb2d88600
Faulting package full name: 11835K2VRTeam.Amethyst-OpenSourceBodyTracking_1.2.8.0_x64__g2vc4cfdbyb66
Faulting package-relative application ID: Amethyst

This is the log requested in the github home page
Amethyst_Installer_20240113-152019.618267.log
VRDriver_20240113-202630.898553.log

These are the only other seemingly relevant logs to the same timestamp
Amethyst_20240113-202629.460892.log
Amethyst_20240113-202630.123891.log

Amethyst 1.2.9.0 lagging bug (sudden no response) xbox one kinect

tonight i test 1.2.9.0 and this is a feedback

avatar and skeleton do not follow real body every 2 (or less) minute
i record tonight's experience , vrchat and amethyst in same screen
full video is (https://1drv.ms/u/s!Ap1L0UYYunrTnrNfY6fo8DmwXSWh1Q?e=gDEt5w)
short version https://1drv.ms/v/s!Ap1L0UYYunrTnrNgGR15Qkxm44e5wA?e=1Yjnyw and timelines are marked
logs amethyst 1.2.9.0 log.zip
480p short version https://github.com/KinectToVR/Amethyst-Releases/assets/51767950/7ae15e5c-7c63-4df2-8a7a-bd0f5fde29e6

i also test 1.2.1.4 (last version before windows store) tonight. this bug also happens and period is longer(about 4 minutes)
i use 1.1.0.0 for daily practice and in my mind this version do not contain this bug

though i think platform is not the cause, I list below just in case
windows 10 up to date
5600x + 3060-12gb + 32gb ram + tufgamingB550Mplus

——————————

Anyway, thanks for your effort to make Kinect useful and funny~

Installation stalling at "Registering Amethyst SteamVR add-on..."

Basically what the title states, my installation is stuck at registering to SteamVR, the last few lines of the log are

I20230327 20:25:05.452898  2472 AmethystModule.cs::HandleDrivers:116] Checking for conflicting SteamVR add-ons...
I20230327 20:25:05.453913  2472 AmethystModule.cs::HandleDrivers:131] Registering Amethyst SteamVR add-on...
I20230327 20:25:05.454933  2472 OpenVRUtil.Drivers.cs::RegisterSteamVrDriver:57] Attempting to register via openvrpaths...
I20230327 20:25:08.115786 23232 MainWindow.xaml.cs::OverridePage:229] Overriding view to page Logs...
I20230327 20:25:18.625659 23232 MainWindow.xaml.cs::GoToLastPage:258] Changing view to previous page Installation...
I20230327 20:26:39.417909 23232 MainWindow.xaml.cs::OverridePage:229] Overriding view to page Logs...

Everything installs fine on my laptop and it works well, but on my desktop, I get stuck at registering to SteamVR

Manual Calibration not responding to controller input

You can blame it on WMR or SteamVR but this function is unusable for me.

I've tried both desktop modes and in manual calibration (for example for waist trackers), moving the joysticks on the controllers doesn't rotate or move the trackers. I remember it used to work but I can't make it work anymore.

I'm using Amethyst v1.2.5.0 from GitHub.

help

cannot download kinect 360 drivers does not install

Can't select Refresh in VR Desktop mode

When using VR desktop, pressing the trigger on Refresh always results in this drop-down menu. Pressing Disconnect from the drop-down menu always closes the drop-down menu. There's no way to refresh anything that has a drop-down menu without using the mouse cursor.

How to repro (tested on Reverb G2 with WMR controllers):

1. Open WMR Desktop in VR
2. Go to an Amethyst menu that has a drop-down button, for example Devices
3. Try to refresh with a controller's trigger
4. Result example:
   

Installation Failure Due to Space in Destination Path

I am going through the process of getting Amethyst installed and it is stalling on the "registering SteamVR Addon" section. I have determined that it is a result of the space in the installation path. Thinking about it, if this issue is present in this step, any other subsequent steps using the same path would also likely fail.

I would prefer to not have it in the root directory for organizations sake. (Though I have done it for the sake of testing)

Error message for reference.
F20220918 11:29:02.143900 13148 OpenVRUtil.Drivers.cs::RegisterSteamVrDriver:50] vrpathreg failed: Code: -2 Args: "adddriver D:\Program Files\Amethyst\Amethyst"

Let me know if you need any other log information, though I think the cause for this issue is fairly straight forward.