Skip to content

OCSYT/SlimeTora

Repository files navigation

SlimeTora

A program that connects the HaritoraX trackers to the SlimeVR server, supporting both the HaritoraX Wireless and HaritoraX Wired (1.1b/1.1/1.0). Supports Bluetooth (low energy), Bluetooth (classic) (w/ COM), and the GX(6/2) communication dongles (w/ COM).

Read the wiki to get started: https://github.com/OCSYT/SlimeTora/wiki

For support, join the Discord server: https://discord.gg/XdfnKD9QVM

Screenshots

Connection section Tracker info section
SlimeTora Connection section Tracker Info section
Global settings section Per-tracker settings page (chest)
SlimeTora global settings section SlimeTora per-tracker (chest) settings page
About section Debugging section
SlimeTora about section SlimeTora debugging section

Features

  • Support for all currently-released HaritoraX trackers
    • Supports HaritoraX Wireless and HaritoraX Wired (1.1b/1.1/1.0)
    • Unknown support for Haritora (before Shiftall // DIY)
  • Bluetooth (LE/Classic) and COM/GX(6/2) support (with all at the same time supported on HaritoraX Wireless)
  • Use of haritorax-interpreter package to process tracker data
  • Get started with the program (and SlimeVR Server) easily through the guided onboarding process!
    • Through the "automatic setup", run auto-detection to let the program set itself up for you!
    • Automatically detect your tracker model, connection mode (including COM ports), and tracker settings
  • Set tracker settings per-tracker (HaritoraX Wireless only)
  • Localization support
    • You can help translate the program! Clone the repo and make a new file under /src/static/languages/ with a two-letter language identifier (ending with .json, e.g. jp.json)!
  • Linux support
    • This was done as SlimeVR is supported on Linux, making this the first time HaritoraX trackers work on Linux!
    • ..however this needs more testing. Please let us know if there are issues
  • Button bindings to SlimeVR functions (e.g. resets)
  • Update checking (for app and translations)
  • Tracker visualization
  • Magnetometer statuses
  • Per-tracker battery information (in-app and SlimeVR/SteamVR)
  • Compact view of the trackers
  • Censor tracker serial numbers in-app
  • Debugging options
  • ..and many more improvements coming soon!

Known issues

  • On SlimeVR Server v0.13.0, you cannot pass the "IMU Calibration" setup wizard step
    • This has been fixed with a future update, v1.3.0 (caused by weirdly high acceleration on idle due to IMU noise?)
    • SlimeVR Server v0.13.1 will exclude Haritora trackers (as calibration isn't needed) & include a skip button
    • Either skip the setup wizard and perform the steps manually via the navbar, or use 0.12.1 (not recommended)
  • Battery information jumps to incorrect percentages/voltage randomly
    • Unfortunately this is an issue I can't fix.. because it's literally an issue with the trackers reporting those random values themselves
    • This has been slightly mitigated with v1.2.0, which uses a "stable average" of the battery percentage and voltage instead
  • Running "auto-detection" more than once without restarting breaks tracker settings auto-detection (device/ports detection still works)
  • Running "auto-detection" on HaritoraX Wired (1.1b/1.1/1.0) trackers doesn't work
  • (LINUX) Connecting to trackers via "Bluetooth (LE)" always fails
    • The Bluetooth package we are using, noble, requires root/sudo to be able to interact with BLE devices - its workarounds (and running as sudo) break Electron due to setcap disabling the LD_LIBRARY_PATH environment variable for security and modifying the bluetooth.conf for dbus does not work (at least, for me)
    • Any help on this is appreciated, though haritorax-interpreter may need to use both noble and node-ble (with a minor tweak on the user's side) to work.
    • Fixed with a future update, v1.3.0

Documentation & Getting Started

Read the wiki to get started: https://github.com/OCSYT/SlimeTora/wiki

For support, join the Discord server: https://discord.gg/XdfnKD9QVM

Support the project

Love SlimeTora? You can show your support to the developers of SlimeTora through their Ko-Fi links, check them out!

Special thanks to the project's supporters: