slimevr / slimevr-docs-site

SlimeVR site with docs and guides

SlimeVR Docs Site

https://docs.slimevr.dev

Contributions

By contributing to this project you are placing all your code under MIT or less restricting licenses, and you certify that the code you have used is compatible with those licenses or is authored by you. If you're doing so on your work time, you certify that your employer is okay with this.

Building

The docs use mdBook, Comprehensive Rust's i18nhelpers, mdbook-admonish plugin, and the mdbook-toc plugin. Install both tools with:

$ cargo install mdbook mdbook-i18n-helpers mdbook-toc mdbook-admonish

Then run

$ mdbook serve -o

to start a web server with the docs. It will open a tab in your browser because of the -o flag

slimevr-docs-site's Issues

The terminal process "C:\Users\user\.platformio\penv\Scripts\platformio.exe 'run'" terminated with exit code: 1.

Hi, I have an issue where whenever I build the project it fails and gives me exit code 1. It then lists problems it found and I'm not sure if it is something I can fix on my own at this time, is this a wide spread issue or an individual one? I followed the guide:(https://docs.slimevr.dev/firmware/configuring-project.html) with the only things that I changed being the define.h and hardcoded WIFI (i uncommented and commented these to check and the issue happened no matter what). I have tried on macOS, windows, and linux if that helps anything. Sorry for the sparce amount of info I'm not sure why I'm having this issue now and any help is appreciated, thanks.

DIY Kit Page returns 404

The DIY Kit Page link at https://docs.slimevr.dev/diy/index.html returns a 404 error.

Few broken hyperlinks

https://docs.slimevr.dev/diy/diy-trackers-guide.html

and https://docs.slimevr.dev/

are linking to https://docs.slimevr.dev/firmware/upload-firmware-guide.md instead of https://docs.slimevr.dev/firmware/upload-firmware-guide.html

IMU Comparation details?

Well, as what I said in #177 , while I highly doubt why MPU+QMC5883L is considered worse than MPU6500, I'm not sure how the ratings of the IMUs are set. May there be detailed comparation between all the IMUs? E.g. a table

High DPI sidebar scaling

Scaling on high dpi screens extends the side bar into the centre of the screen, making the content section smaller by ratio.

Example of page at 4k resolution:

I recommend pack all Slime VR Server into a package

My internet is bad , when i disconnect and reconnect and all the process will not save . i need to redownload them again

Possibly confusing labeling on DIY wiring diagram

The wiring diagram on this page appears to indicate the voltage of the connection between the 5v pin on the D1 mini and the TP4056 is 5v.
The TP4056 does not have a voltage booster, so the largest voltage this will see is the max voltage for the battery (4.2v based on TP4056 specs. In my testing it's within about 100mV of VBAT) The voltage regulator on the D1 drops this to 3.3v for the rest of the system. (Many D1 boards label this VBUS instead of 5v.) This also means the battery sense wire could be spliced off the "5v" wire with only a small loss in accuracy.

My concern is that someone may treat this diagram like a schematic and try to substitute a true 5v logic part into the circuit and be disappointed when it fails to work correctly.

I suggest renaming this wire to VBUS or V+ to avoid confusion. This seems low priority to me, so I wouldn't expect someone to do it unless they are making new diagrams for some other reason

Implement translation by adding mdbook-i18n-helper modules or similar ones

https://github.com/google/mdbook-i18n-helpers
The docs are currently only in English, and I wanted to translate them.

Add Full-Body Set option to giude

Components guide doesn't include Full-Body Set (10 IMUs). I feel confused whether this set is available.
Could you please add Full-Body Set option to guide?

Optional components

Additional section in the components guide should be considered, as people have ordered all the parts from this page and not noticed the optional pieces on the schematics. Suggested formatting below:

Optional components:
There are several components that can be added when building a tracker that allow for additional features. A 'Battery sense' resistor can be added to allow the server to determine battery level, while a pair of diodes can be added to allow the tracker to be used while charging and as an added safety measure against accidental damage due to charging while powered on. While both these additions are extremely low cost, they are considered optional and can increase the complexity of the schematics.
Recommended resistor is: 180k Ohm 1/4W Metal Film Resistor
Recommended diodes are: 1N5817 SCHOTTKY Diode

Repo still links to slimevr.github.com

https://github.com/SlimeVR/SlimeVR-Docs-Site/settings

Common issues list

This issue to contribute issues for "common issues" documentation