SlimeVR-Rust

A monorepo for SlimeVR's Rust code.

Project Structure

A monorepo stores mutliple librares and apps all in one git repo. The main projects are:

• SlimeVR Overlay: An OpenVR Overlay that displays the skeletal model of SlimeVR for easier debugging and tuning of body proportions
• Skeletal Model: A WIP implementation of a new fullbody FK/IK solver with the goal of being callable from several languages, including Typescript(node.js) and Java.
• Firmware: A rust implementation of the firmware, built on embedded-hal instead of Arduino. Targets the ESP32-C3 and nrf52840.
• SolarXR Client: A rust client for the solarxr protocol.

Motivation

• Fulfill the Rewrite It In Rust meme
• Anger Java developers

Jokes aside, the official Java and C++ implementations of SlimeVR make up most of the core SlimeVR codebase. Many people know Java and C++, but there is a growing interest in Rust too. By providing this repository, we hope to encourage people interested in Rust to contribute to SlimeVR. This may lead to new applications and features that can either work alongside, or give back to, the mainline Java codebase.

Contributing

A guide for contributors can be found in CONTRIBUTING.md

License

Unless otherwise specified, all code in this repository is dual-licensed under either:

• MIT License (LICENSE-MIT)
• Apache License, Version 2.0 (LICENSE-APACHE)

at your option. This means you can select the license you prefer!

Unless you explicitly state otherwise, any contribution intentionally submitted for inclusion in the work by you, as defined in the Apache-2.0 license, shall be dual licensed as above, without any additional terms or conditions.