Skip to content

Commit 229c028

Browse files
Update ReadMe
* Updated and rewrote README.md Rewrote large portions of the introduction. - More consistent and professional tone - Clarified previously overly vague descriptions. - Includes information on smol slimes - Updated links to the slimevr store. When was this last updated? Slime no longer sells or recommends bno085. - Changed DIY description - Reformatted and moved sections for better flow between paragraphs. - Fixed various grammar errors. * added attribution added proper attribution; including the reformat. * docs: PR Clean-up --------- Co-authored-by: ShineBrightMeow <[email protected]>
1 parent 295c863 commit 229c028

File tree

1 file changed

+27
-26
lines changed

1 file changed

+27
-26
lines changed

src/README.md

Lines changed: 27 additions & 26 deletions
Original file line numberDiff line numberDiff line change
@@ -2,72 +2,74 @@
22

33
Welcome to the SlimeVR documentation. This site covers how to [build your own SlimeVR trackers](diy/index.html), [install or update an existing tracker's firmware](firmware/index.html), [install and configure the SlimeVR Server](server/index.html), and [provides a wide collection of community built tools](tools/index.html).
44

5-
65
## What is SlimeVR?
76

8-
SlimeVR is a set of open hardware sensors and open source software that facilitates full-body tracking (FBT) in virtual reality. The project is built around creating a system that is customisable, hackable and can be modified to suit the needs of the user. Due to this, this documentation provides the full breakdown of not just how to set up your environment, but also how you could build a set of trackers yourself. For a more detailed breakdown of how the system works, check [SlimeVR 101](slimevr101.html).
7+
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](slimevr101.html).
98

109
## I have prebuilt trackers, what do I do now?
1110

12-
Welcome new SlimeVR user, we are happy to have you here! For the simplest set up process we suggest you visit our [Quick Setup Guide](quick-setup.md).
11+
Welcome new SlimeVR user, we're happy to have you here! For the simplest setup process we suggest you visit our [Quick Setup Guide](quick-setup.md).
1312

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

16-
There are currently multiple ways to approach putting together your own FBT solution using SlimeVR.
17-
18-
15+
There are currently multiple ways to approach putting together your own SlimeVR FBT solution.
1916

2017
### 1. Buying trackers
2118

2219
#### Fully built trackers directly from SlimeVR
2320

24-
![Slime Trackers](assets/img/slimeVRTrackers.jpg)
21+
![SlimeVR Trackers](assets/img/slimeVRTrackers.jpg)
2522

26-
You buy fully built trackers for pre-order at [Crowd Supply](https://www.crowdsupply.com/slimevr/slimevr-full-body-tracker). 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.
23+
You can buy fully built trackers for pre-order at [Crowd Supply](https://www.crowdsupply.com/slimevr/slimevr-full-body-tracker). 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.
2724

2825
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.
2926

30-
#### 3rd Party sellers
27+
### 2. Third-Party Sellers
28+
29+
Third-party sellers are common, with prebuilt trackers and custom commissions offered on the [SlimeVR Discord](https://discord.gg/SlimeVR) marketplace forum. Designs and specifications vary from seller to seller, so make sure to check exactly what you’re getting.
3130

32-
3rd Party sellers are becoming common, with commissions being offered on the [SlimeVR discord](https://discord.gg/SlimeVR) marketplace forum. Designs and specifications vary from offering to offering, so make sure to check exactly what you are getting! As one of the most important aspects of the tracker is the IMU (used to measure your movement), we suggest you check the [IMU comparison page](diy/imu-comparison.html) to get an idea of what to expect from any available tracker.
31+
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](diy/imu-comparison.html) to get an idea of what to expect from any available tracker.
3332

34-
> **Caution:** SlimeVR cannot ensure 3rd party trackers meet any requirements of quality, please assume that purchasing from a 3rd party seller is the equivalent of buying from a small creator, and your own research into the quality of these trackers is important. We suggest you check reviews or talk to others that have purchased from the seller in order to get an idea of what to expect. If any of your purchased 3rd party trackers develop a fault, contact the seller for help. However, you may need some understanding of soldering in order to repair them yourself.
33+
> **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.
3534
36-
### 2. Building them yourself
35+
> **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.
3736
38-
> **Note:** You need at least 5 trackers for proper full body tracking (FBT). Alternatively, you can build a single tracker for just waist tracking if you wish to test the tracking without investing in a full kit. Other options do exist (such as using phones or joycons), but these options will be restricted by the device you use, and as such you will see much worse results.
37+
### 3. Building trackers yourself
3938

4039
#### Entirely from scratch
4140

4241
![Example DIY build](assets/img/exampleBuild.jpg)<br>
4342
*Example build by NightyIceC00kie*
4443

45-
Building trackers is the most common way users have trackers at the time of writing. This documentation provides a full [guide to building trackers from scratch](diy/index.html), which provides lists of full components needed, where to buy them and schematics for many combinations of IMUs and Microcontrollers.
44+
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.
4645

47-
PCB based builds are common, which can be gotten from JLPCB or other manufacturers inexpensively. These boards can greatly simplify the process and amount of soldering needed for reliable trackers. Many popular options are available, with instructions and 3D printable files. [community cases](diy/cases.md)
46+
The most common way of assembling SlimeVR Trackers is by soldering multiple PCBs onto a carrier board.
4847

49-
This is the cheapest and fastest way to obtain trackers, assuming you have a soldering iron on hand a single tracker can be put together for under $20.
48+
- For Wi-Fi-based Trackers ("big" or "normal" Trackers), the component and assembly guide can be viewed [here](diy/index.html).
49+
- For nRF (“Smol”) Trackers, the component and assembly guide can be viewed [here](smol-slimes/index.html).
50+
51+
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/cases.md)
5052

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

53-
> Please note, if you are looking for BNO085s (the suggested IMU), the SlimeVR store has [modules for sale](https://shop.slimevr.dev/products/slimevr-imu-module-bno085).
55+
> Please note: If you are looking for the ICM-45686 (the recommended IMU), the SlimeVR store has [modules available](https://shop.slimevr.dev/products/slimevr-mumo-breakout-module-v1-icm-45686-qmc6309).
5456
55-
#### Pre-order the official DIY Kit on Crowd Supply
57+
#### Purchase the official DIY Kit on Crowd Supply
5658

5759
![DIY kit](assets/img/DIY_KIT_box-contents.jpg)<br>
5860
*A prototype of DIY-Kit boards and wires.*
5961

60-
You buy the [**official DIY Kit**](https://www.crowdsupply.com/slimevr/slimevr-full-body-tracker) which includes only the boards and connecting wires for the Tracker Extensions. It does not come with enclosures, straps, batteries, or other accessories. These parts will need to be sourced by you. See [DIY Kit Guide](diy/diy_kit_guide.html) for more information on how to build it.
62+
You buy the [**official DIY Kit**](https://www.crowdsupply.com/slimevr/slimevr-full-body-tracker#products), 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](diy/diy_kit_guide.html) for more information.
6163

62-
This option requires no or little soldering, provides tested boards, best available IMUs, allows for a small design, and is a cheaper alternative to buying completed SlimeVR trackers. It also allows you to customize cases and straps.
64+
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.
6365

6466
Example: [TinyOfficial-Case](https://github.com/ZRock35/TinyOfficial-Case)
6567

66-
However, at this point you could just buy completed SlimeVR trackers, as the shipping times of batteries and other components can still affect this option.
68+
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.
6769

68-
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.
70+
Please check the product page and Discord for estimated shipping times. Actual shipping times may vary due to production delays and other circumstances.
6971

70-
### 3. Alternative tracking options
72+
### 4. Alternative tracking options
7173

7274
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:
7375

@@ -78,9 +80,8 @@ As SlimeVR is open source and has roots in the idea of experimentation and explo
7880

7981
**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.**
8082

81-
Note that these options vary depending on make and model (3rd party joycons almost never work for example), there have been issues with connections, the application being suspended, and a handful of others. Phone or Joycon straps are also required to be sourced based on the objects shape, size, and mount location.
82-
83+
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.
8384

8485
If you have any problems, feel free to reach out on the [SlimeVR discord](https://discord.gg/SlimeVR).
8586

86-
*Written by adigyran and calliepepper, edited by QuantumRed#0001, calliepepper, Spazzwan emojikage, nwbx01, and tomyum3dp, styled by calliepepper*
87+
*Written by adigyran and calliepepper, edited by Amebun, QuantumRed#0001, calliepepper, Spazzwan emojikage, nwbx01, and tomyum3dp, styled by calliepepper. Reformatted by Amebun.*

0 commit comments

Comments
 (0)