Skip to content

Commit

Permalink
more docs
Browse files Browse the repository at this point in the history
  • Loading branch information
Futuremappermydud committed Nov 30, 2023
1 parent 7a2ef34 commit 085d13f
Show file tree
Hide file tree
Showing 6 changed files with 45 additions and 2 deletions.
6 changes: 5 additions & 1 deletion src/SUMMARY.md
Original file line number Diff line number Diff line change
Expand Up @@ -3,4 +3,8 @@
- [Installation](installation.md)
- [Finding VRMs](findvrms.md)
- [Configuration](configuration/configuration.md)
- [IK](configuration/IK.md)
- [IK](IK.md)
- [Locomotion](Locomotion.md)
- [Lighting](Lighting.md)
- [Expressions](Expressions.md)
- [Virtual Motion Capture](VMC.md)
11 changes: 11 additions & 0 deletions src/configuration/Locomotion.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,11 @@

# Locomotion


## What is Locomotion?

- Locomotion is the term used to describe how your avatar's legs move when no trackers are available. Allows your avatar to walk along with your headset.

## Available options

- Leg Swivel: This is an important one! Adjusting this value can fix issues where some avatars may bend their legs to the side. This value changes the angle which the knees go when crouching for example.
2 changes: 2 additions & 0 deletions src/configuration/VMC.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,2 @@

# Virtual Motion Capture
6 changes: 5 additions & 1 deletion src/configuration/configuration.md
Original file line number Diff line number Diff line change
Expand Up @@ -4,4 +4,8 @@

## The following subchapters can help you explore the different ways to configure your avatar.

- [IK](IK.md)
- [IK](IK.md)
- [Locomotion](Locomotion.md)
- [Lighting](Lighting.md)
- [Expressions](Expressions.md)
- [Virtual Motion Capture](VMC.md)
16 changes: 16 additions & 0 deletions src/configuration/lighting.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,16 @@
# Lighting
## Available options

- Global Color: This is the color used in the menus or in-game without beatmap lighting.
- Light Intensity: This is the brightness intensity of the lights used in the menus or in-game without beatmap lighting.
- Light Rotation X: The vertical angle of the light (Everywhere).
- Light Rotation Y: The horizontal angle of the light (Everywhere).
- Beatmap Lighting: This setting enables lighting to be controlled by lighting effects ingame.
- Beatmap Lighting Brightness: How bright the beatmap lights should be.
- Beatmap Lighting Saturation: How saturated the colors should be for beatmap lights.
- Beatmap Lighting Minimum Brightness: The minimum brightness that the beatmap lights should be at any moment.

## Recommended Settings

- For regular maps, I recommend a brightness of 0.7, saturation of 0.3, and a minimum brightness of 0.6
- For Lightshows, I recommend a brightness of 0.8, saturation of 0.7, and a minimum brightness of 0.3
6 changes: 6 additions & 0 deletions src/findvrms.md
Original file line number Diff line number Diff line change
@@ -1 +1,7 @@
# Where to Find VRMS


## [Booth.PM](https://booth.pm/en/browse/3D%20Characters)
- This is a very good spot to find VRMs as lots of them are very high quality. All of them can be downloaded, but many are not free. You can filter by max price to find free ones.
## [VRoid Hub](https://hub.vroid.com/en)
- This is a decent spot to find VRMs. Not all files here are downloadable, though the ones that are can be downloaded for free.

0 comments on commit 085d13f

Please sign in to comment.