https://github.com/provismet/lilypanel
Simple VMC application that gives a control panel for vtuber toggles.
https://github.com/provismet/lilypanel
inochi2d virtual-motion-capture vmc
Last synced: 19 days ago
JSON representation
Simple VMC application that gives a control panel for vtuber toggles.
- Host: GitHub
- URL: https://github.com/provismet/lilypanel
- Owner: Provismet
- License: bsd-2-clause
- Created: 2023-10-11T01:06:36.000Z (over 2 years ago)
- Default Branch: main
- Last Pushed: 2024-02-07T01:15:23.000Z (over 2 years ago)
- Last Synced: 2025-02-23T16:51:48.441Z (over 1 year ago)
- Topics: inochi2d, virtual-motion-capture, vmc
- Language: Python
- Homepage:
- Size: 45.9 KB
- Stars: 1
- Watchers: 1
- Forks: 0
- Open Issues: 0
-
Metadata Files:
- Readme: README.md
- License: LICENSE
Awesome Lists containing this project
README
# LilyPanel
A simple Python GUI that sends VMC data to make toggles easier in [Inochi Session](https://github.com/Inochi2D/inochi-session). Should be compatible with any VMC application, but this program is tailored for Inochi Session.
## License
All *source-code* (does not include assets) is licensed BSD-2.
## Executing from Source
If you want to execute the program from the Python source, you will need to install the `pythonosc` library. This can be done through the console command:
```
pip install pythonosc
```
## Setup
All settings are set via editing the file `lilypanel.json`.
### Connection
The IP defaults to 127.0.0.1 (localhost).
The port defaults to 39540.
To change either of these, find the `ip` and `port` fields at the top of the settings file.
```json
{
"ip": "127.0.0.1",
"port": 39540
}
```
The ip must be enclosed in "quotes" or 'apostrophes'.
The port must be an integer.
#### Inochi Session
Do not change the IP address, Inochi Session expects to receive data via localhost.
If your Virtual Space does not already have one, add a VMC receiver to it with the corresponding port. (Multiple VMC applications may share the same port, as such you may skip this step if already using PuppetString.)
### Layout
To change how the control panel is layed out, modify the layout object.
Default:
```json
"layout": {
"buttons": {
"columns": 2,
"xPadding": 3,
"yPadding": 1
},
"sliders": {
"columns": 2,
"xPadding": 3,
"yPadding": 1,
"orientation": "vertical"
},
"xPadding": 20,
"yPadding": 5
}
```
- Columns refers to the number of columns per button/slider. When no columns are left, a new row is created on the user interface.
- xPadding refers to have much space should be between individual elements along the x-axis.
- yPadding refers to have much space should be between individual elements along the y-axis.
- Slider orientation accepts either `"vertical"` or `"horizontal"`.
- The overall padding affects the distance between the button side and the slider side. (Also affects distance between them and the borders of the program.)
### BlendShapes
An unlimited number of blendshapes can be registered to the program. All blendshapes should be given unique names and not clash with those of other programs.
By default, 6 example blendshape are provided. These serve as a guide on how to add your own and should be removed.
All blendshapes should be a json object added to the `"blends"` array.
#### Toggles
Toggles require 4 fields. The button will default to the off state.
Values may be integers or contain decimals.
To add a toggle:
```json
{
"name": "Name of your blendshape",
"type": "toggle",
"offValue": 0,
"onValue": 1
}
```
#### Sliders
Sliders require 5 fields, the slider will default to `"minValue"` value and it will only move in multiples of `"step"`.
`"minValue"` is only the default value, it *can* be smaller than `"maxValue"`.
To add a slider:
```json
{
"name": "Name of your blendshape",
"type": "slider",
"step": 0.5,
"minValue": 0,
"maxValue": 1
}
```
This example will create a slider that starts at 0, ends at 1, and only accepts the values: 0, 0.5, 1.
#### Durations
Durations take up the same section as toggle buttons, they send a sequence of BlendShapes then deactivate. This can be used to play an animation once without looping or to create specialised toggle with a custom speed.
To add a duration:
```json
{
"name": "Name of your blendshape",
"type": "duration",
"defaultValue": 0,
"interval": 50,
"sticky": false,
"checkpoints": {
"5": 0.2,
"15": 0.5,
"20": 1
}
}
```
The default value is the value emitted when the duration is inactive. For sticky durations, this is instead the initial value; the start and end checkpoints become the default values in this case.
Durations output a single value each step, the duration of a step (in milliseconds) is the interval.
The `sticky` parameter controls how the duration works on repeated use. A sticky duration will play in reverse every other activation. This allows for a "slow toggle" ability.
The checkpoints are the values that must be sent at certain steps. The values fpr steps in-between checkpoints are scaled between the previous checkpoint and the next one.
In this example:
- Output starts at 0.
- Increases every step, reaching 0.2 at step 5.
- Slowly increases each step, reaching 0.5 at step 15.
- Quickly increases, reaching 1 at step 20.
- Duration ends, instantly resetting back to 0 (the default value).
The example executes 20 steps, each with a duration of 50ms (1 second in total).
Durations are not overly intuitive, and I do recommend experimenting with the examples as well as visualising them in Inochi Session.