Skip to content

Commit

Permalink
Update README.md
Browse files Browse the repository at this point in the history
  • Loading branch information
Provismet authored Oct 3, 2023
1 parent 7dde633 commit 6da95da
Showing 1 changed file with 20 additions and 0 deletions.
20 changes: 20 additions & 0 deletions README.md
Original file line number Diff line number Diff line change
@@ -1,6 +1,13 @@
# Virtual Motion Capture for Minecraft
This mod uses (and bundles) the JavaOSC library to implement a VMC layer in Minecraft so vtuber models can be manipulated via in-game actions and events.

This mod is designed specifically for use with [Inochi Session](https://github.com/Inochi2D/inochi-session).
However, the VMC protocol (and by extension: Open Sound Control) is used almost universally by vtubing applications - this mod *should* in principle be compatible with most standard vtubing software.

## Setup
By default the mod will send data over `127.0.0.1:35404` (localhost, port 35404).
After the first launch, a config file will be created under `config/vmc-mc.json`. If you wish to change the IP or port (for example, if you use multiple PCs to stream/record) then change the IP and port as necessary in this file. The changes will be read on the next launch.

## Default Tracking
Almost all blendshapes sent by VMC-MC are bound to the range of 0 - 1. Some blendshapes are also boolean, only outputting 0 or 1, with no in-between.

Expand All @@ -14,6 +21,7 @@ By default, the mod sends the following tracking data:
- weather (clear/rain/thunder)
- health percentage
- food percentage
- air percentage
- water height (uncapped value, experimentation recommended)
- lava height (uncapped value, experimentation recommended)
- experience levels (uncapped value)
Expand All @@ -22,6 +30,18 @@ By default, the mod sends the following tracking data:
- alive/dead (boolean)
- is wet (boolean)
- on fire (boolean)
- water submerged (boolean)
- lava submerged (boolean)
- crawling (boolean)
- climbing (boolean)
- blocking (boolean)
- glowing (boolean)
- frozen (boolean)
- swimming (boolean)
- sprinting (boolean)
- riding living (boolean)
- riding nonliving (boolean)
- elytra flying (boolean)

## Dependency
If you want to use this mod as a dependency, it is available via [jitpack.io](https://jitpack.io/#Provismet/VMC-MC/).
Expand Down

0 comments on commit 6da95da

Please sign in to comment.