SlimeVR Documentation

Welcome to the SlimeVR documentation. This site covers how to build your own SlimeVR trackers, install or update an existing tracker's firmware, install and configure the SlimeVR Server, and provides a wide collection of community built tools.

What is SlimeVR?

SlimeVR is a set of open-source software and hardware sensors designed to facilitate full-body tracking (FBT) in virtual reality. The project is built around the core concept of creating a system that can be fully customized to suit each user’s needs. This documentation provides a full breakdown of how to set up prebuilt trackers, as well as guides on building compatible DIY SlimeVR Trackers. For a more detailed explanation of how SlimeVR works, check SlimeVR 101.

I have prebuilt trackers, what do I do now?

Welcome new SlimeVR user, we're happy to have you here! For the simplest setup process we suggest you visit our Quick Setup Guide.

How do I get my hands on those sweet sweet SlimeVR trackers?

There are currently multiple ways to approach putting together your own SlimeVR FBT solution.

1. Buying trackers

Fully built trackers directly from SlimeVR

You can buy fully built trackers for pre-order at Crowd Supply. These trackers are the passion project of dedicated core members of SlimeVR, and due to chip shortages, shipping delays and the like we cannot guarantee shipping dates or turnaround time.

This option is a preorder. Please check the product page for estimated shipping times for new orders. Actual shipping times might differ due to production delays and other circumstances.

2. Third-Party Sellers

Third-party sellers are common, with prebuilt trackers and custom commissions offered on the SlimeVR Discord marketplace forum. Designs and specifications vary from seller to seller, so make sure to check exactly what you’re getting.

As the two most important aspects of every SlimeVR Trackers are the IMU (used to measure movement) and the communication protocol (how the tracker communicates with your device), we suggest checking the IMU comparison page to get an idea of what to expect from any available tracker.

Caution: SlimeVR cannot ensure that third-party trackers meet any specific quality requirements. Please assume that purchasing from a third-party seller is comparable to buying from a small creator, and your own research into the quality of these trackers is important. We suggest checking reviews or speaking with others who have purchased from the seller. If any of your third-party trackers develop a fault, contact the seller for support. However, you may need some understanding of soldering and tracker assembly to perform repairs yourself.

Note: You need at least 5 trackers for proper full-body tracking (FBT). Alternatively, you may build or purchase a single tracker exclusively for chest tracking if you want to test partial tracking without investing in a full kit. Other options, such as using phones or Joy-Cons—do exist, but tracking quality is heavily restricted by the specific device, so expect significantly worse results.

3. Building trackers yourself

Entirely from scratch

Example build by NightyIceC00kie

Building trackers is currently the cheapest method of obtaining SlimeVR trackers at the time of writing. This documentation provides a full guide to building trackers from scratch, which provides lists of full components needed, where to buy them and schematics for most combinations of IMUs and Microcontrollers.

The most common way of assembling SlimeVR Trackers is by soldering multiple PCBs onto a carrier board.

• For Wi-Fi-based Trackers ("big" or "normal" Trackers), the component and assembly guide can be viewed here.
• For nRF (“Smol”) Trackers, the component and assembly guide can be viewed here.

PCB-based builds are also frequently used, which can be manufactured through JLCPCB or other suppliers at low cost. These boards can greatly simplify the process and reduce the amount of soldering required. Many popular options are available, with instructions and 3D printable files:community cases

DIY builds require time to assemble and may require self-repairs from time to time.

Please note: If you are looking for the ICM-45686 (the recommended IMU), the SlimeVR store has modules available.

Purchase the official DIY Kit on Crowd Supply

A prototype of DIY-Kit boards and wires.

You buy the official DIY Kit, which includes the boards, extensions, and cables. It does not include enclosures, straps, batteries, or other accessories, which must be sourced separately. See the DIY Kit Guide for more information.

This option requires little to no soldering, provides tested boards, uses the best available IMUs, allows for a compact design, and is a more affordable alternative to completed SlimeVR trackers. It also allows you to customize cases and straps.

Example: TinyOfficial-Case

However, while the cost is significantly lower, this option is still a preorder. We recommend buying batteries and other required parts at the same time to avoid delays.

Please check the product page and Discord for estimated shipping times. Actual shipping times may vary due to production delays and other circumstances.

4. Alternative tracking options

As SlimeVR is open source and has roots in the idea of experimentation and exploration, other options to replace custom built trackers have emerged. This includes:

• Using a phone in place of a tracker.
• Using Nintendo Joycons in place of trackers.
• Using Mocopi trackers with SlimeVR server
• Using HaritoraX trackers with SlimeVR server

Please note that these options may be subpar when compared to actual SlimeVR trackers, but are useful for experimenting and in some cases can work well. We suggest you do not invest heavily in buying old phones or joycons, as most users of these options only consider them stopgaps at best.

Note that these options vary depending on make and model (for example, third-party Joy-Cons almost never work). Users commonly experience issues with connection stability, application crashes, and other limitations. Phone or Joy-Con straps must also be sourced based on the object’s shape, size, and mounting location.

If you have any problems, feel free to reach out on the SlimeVR discord.

Written by adigyran and calliepepper, edited by Amebun, QuantumRed#0001, calliepepper, Spazzwan emojikage, nwbx01, and tomyum3dp, styled by calliepepper. Reformatted by Amebun.