Updated text for expressions, intro page, and settings

lunazera
2024-04-10 10:38:40 -04:00
parent 3a692f5e73
commit 30cb3686c4
3 changed files with 71 additions and 54 deletions

@@ -1,6 +1,12 @@
# Expressions, Colliders, Pendulums and Props
## Expressions
VNyan's Expression menu allows you to create Blendshape rulesets or conditions to trigger or control other blendshapes. For instance, if you want a "laughter" expression to activate when both your eyes are closed and your mouth is smiling and open, you could set an expression that does this.
VNyan's Expression menu allows you to create Blendshape rulesets or conditions to trigger or control other blendshapes. For instance, if you want a "laughter" expression to activate when both your eyes are closed and your mouth is smiling and open, you could set an expression that does this.
### Blendshape Conditions
You can set multiple blendshapes to control whether the expression is turned on or off. Enter the blendshape name and enter the minimum and maximum values for when the expression should be active.
### Output Values
Your expression can either set the value of different blendshapes and hold them there, or it can scale the blendshape by a multiplier. If using **Set Value**, you only need to enter a number in the Value field and how many seconds for the blendshape to smoothly transition. If using **Multiply**, enter in the multiplier value, the minimum and maximum range for that blendshape, and the smoothing transition time.
## Colliders
VNyan has a few built-in colliders that are mainly used for interactions within VNyan. Many physics effects like the water and slime nodes, or item interactions like for the drop node or food node rely on these colliders. You can adjust the size and placement of these colliders to your avatar in the Colliders etc menu.
@@ -40,31 +46,20 @@ These four sliders controls the physical motion of your pendulum chain. Here are
You can export your chain with the *Export Chain* button, and import chains with the *Import Chain* button. Chains are stored as a `.vnchain` file. Importing a new chain will not replace existing chains, and instead add to the list.
## Props
VNyan has a system for placing props on your model that you can access from the side menu.
There are a few types of props you can add: .png images, .gif animated images, vnyan props, Spout2 sources, Text, and browser sources.
VNyan has a system for placing props on your model that you can access from the side menu. There are a few types of props you can add: *.png* images, *.gif* animated images, *vnyan props*, *Spout2* sources, Text, and browser sources.
### VNyan Prop object
VNyan has it's own package bundle for props that can be made in unity using the VNyan SDK.
VNyan has it's own package bundle for props that can be made in unity using the VNyan SDK. These will have the extension `.vnprop`. Props can have different animators such as Dynamic Bones, particle effects, custom shaders and more.
#### Prop Parameters
VNyan Prop objects can be linked to different parameters to control or change them. These would be set in Unity when creating the prop object.
For example, you could link animations in the prop to different parameter values. In VNyan, by setting or changing the specified parameter value, this will effect the prop.
VNyan Prop objects can be linked to different parameters to control or change them. These would be set in Unity when creating the prop object. For example, you could link animations in the prop to different parameter values. In VNyan, by setting or changing the specified parameter value, this would effect the prop.
### Spout2 prop
You can load Spout2 sources as props, allowing you to bring in any source that can send Spout2. This could be other instances of VNyan, or a Live2D model from VTube Studio.
You could also use the [Spout2 Plugin for OBS](https://github.com/Off-World-Live/obs-spout2-plugin) to send sources in OBS to VNyan. For example, you could add the FugiTech Reactive discord app by first bringing it into OBS, and then sending it to VNyan as a Spout2 prop.
### Text
You can add simple text to your model or environment.
### Text prop
You can add simple text linked to your model or the environment. The Text field can be a text *<parameter>/*, allowing you to dynamically change the text displayed using graphs. The font cannot be changed; if you wish to use a different font, it would be better to create your own text vnyan prop in Unity.
### Browser prop
You can load a website or local html file as a browser prop. This could be used to bring twitch chat or different overlays into your VNyan environment.
There is no support for interacting with the prop, so you will not be able to click or navigate within the website itself. If a website requires login or authentication this won't work either.
## Prop Controls
### Toggle Prop Node
You can toggle the visibility of any prop by using the Toggle Prop node.
You can load a website or local html file as a browser prop. This could be used to bring twitch chat or different overlays into your VNyan environment. There is no support for interacting with the browser, so you will not be able to click or navigate within the website itself. If a website requires login or authentication this won't work either.

@@ -6,36 +6,32 @@ To install, download the latest version of [VNyan from itch.io](https://suvidrie
## Updating VNyan
To update VNyan, download the latest version, extract the archive and put it in your pre-existing install folder with replacement.
Note that VNyan updates are not meant to be backwards compatible, especially as the program is still in development. Thus you will not find previous versions available for download.
If you find that your graphs or items are missing after installing a new version, it is possible that you are running VNyan from a different folder as before. Try to find your previous install folder for VNyan and run `VNyan.exe` from there.
Graphs may break if you try to downgrade VNyan to previous versions. In particular, if a newer version has a new node that the older version does not, any graph that contains this new node will be broken along with every other graph after it. You should still be able to open VNyan with the latest version where you added these new nodes and remove them to maintain some compatibility.
As VNyan is in active development, updates are not backwards compatible. Graphs may break if you try to downgrade VNyan to previous versions. In particular, if a newer version has a new node that the older version does not, any graph that contains this new node will be broken along with every other graph after it. If you need to use a previous version, try removing the newer nodes in the latest version before downgrading.
### Using the itch.io app
You can use the [itch.io app](https://itch.io/app) to manage your VNyan installation. This will allow you to automatically download and install new updates. Make sure that the itch.io app updates VNyan into the same installation folder rather than making new folders, or you might find that some of your settings, props and objects get unset.
You can use the [itch.io app](https://itch.io/app) to manage your VNyan installation. This will allow you to automatically download and install new updates. Make sure that the itch.io app updates VNyan into the same installation folder rather than making new folders.
## Startup
When you first open VNyan, you will be greeted by a startup wizard.
# File system
VNyan saves most of it's settings in your AppData LocalLow folder.
Typical path: `C:\Users\USERNAME_HERE\AppData\LocalLow\Suvidriel\VNyan`
Here you can find your main profile's loaded graphs named `redeems*.json` (with `*` being the graph number starting from 1), settings named `settings.json`, various log files, a folder of backups for your graph and settings files, and a folder for additional profiles.
Here you can find your main profile's loaded graphs named `redeems*.json` (with `*` being the graph number starting from 1), settings named `settings.json`, various log files, a folder of backups for your graph and settings files, and a folder for additional profiles. Each profile itself is another folder with similar organization.
Each profile itself is another folder with similar organization.
## Backups
VNyan saves a backup of all your graphs and settings every time these are saved by VNyan once every day that VNyan is opened. You can find these under `C:\Users\USERNAME_HERE\AppData\LocalLow\Suvidriel\VNyan\backup`. If you lose your graphs or settings for whatever reason, you can check here and use the files from a previous date.
# Profiles
As of v1.1.2, VNyan supports having multiple launch profiles. Each profile has its own settings, node graphs, and environment, allowing for multiple instances of VNyan to run at the same time.
As of version 1.1.2, VNyan supports having multiple launch profiles. Each profile has its own settings, node graphs, and environment, allowing for multiple instances of VNyan to run at the same time.
Profiles work through command line arguments. You can open VNyan with a profile by passing a command line argument when starting it. For example: `VNyan.exe -p NyanNyan`. This would start VNyan with a profile called NyanNyan. If the profile doesn't exist then an empty one will be created. There is no profile limit, so you can create as many as you need.
Profiles work through command line arguments. All you have to do is pass a command line argument to VNyan when starting it.
For example: `VNyan.exe -p NyanNyan`
This would start VNyan with profile called NyanNyan. If the profile doesn't exist then an empty one will be created. There is no profile limit, so you can create as many as you need.
VNyan comes with a cmd-file called VNyan_Profile_Example.cmd. This file can be opened in notepad and you can change the profile name there making it super easy to just double click the cmd instead of having to type the argument every time.
VNyan comes with a cmd-file called `VNyan_Profile_Example.cmd`. This file can be opened in notepad and you can change the profile name there making it super easy to just double click the cmd instead of having to type the argument every time.
Example cmd-file:
```
@@ -45,7 +41,7 @@ echo Launching VNyan with different profile
VNyan.exe -p ExampleProfile
```
You can also set up shortcuts for VNyan.exe and put `-p ExampleProfile` at the end of the Target line.
You can also set up shortcuts for VNyan.exe and put `-p ExampleProfile` at the end of the target line to open VNyan with a profile.
## GPU Priority Mode
If you experience lag with VNyan, you can start it in GPU Priority mode. There is a cmd file `VNyan_GPUPriority.cmd` that you can run instead of VNyan.exe which will open using this setting. This will also run VNyan with Administrator privileges.

@@ -9,11 +9,21 @@ Unless otherwise specified, you should assume that all tracking layers are blend
Allows you to apply a default Arm Angle onto the base layer of your model to position your arms out of T-Pose. Root Rotation will turn the root of your model if you need to adjust your model's default angle.
### Web Camera Tracking
VNyan supports ARKit blendshape and head tracking using your Web Camera. Using this feature for expression trackig requires that your avatar has the 52 ARKit blendshape clips.
Select your camera device to turn tracking on. You can change the camera settings in case a different mode works better for you. These settings are provided from your device itself, so you will only have what is available to your device.
Note that *tongueOut* and *cheekPuff* blendshapes are currently not supported this way.
### ARKit Tracking
Takes in tracking from either VTube Studio, MeowFace or iFacialMocap
VNyan supports ARKit blendshape and head tracking from most popular phone trackers, such as VTube Studio, MeowFace or iFacialMocap. Using this feature for expression tracking requires that your avatar has the 52 ARKit blendshape clips.
Select your tracking method and enter the IP address of your device found within your tracking app. Tracking will start as soon as it is found by VNyan. Connection status is indicated by the coloured dot, which will show red when it is unavailable and green when connected successfully.
### Leap Motion Tracking
VNyan supports hand and arm tracking through Leap Motion. Make sure you have the latest firmware for your device as VNyan requires at least the Gemini version of the Leap Motion Service.
For the best results with Leap Motion, it's recommended that you turn on the Arm Angle Setting to have your arms fall to the sides when tracking is lost - even when using Arm Sway.
- Hand Speed sliders apply a smoothing transition between when tracking is lost and found.
- Mirror Hands reverses the tracking between your left and right arms. Note that this will not be reflected in the Leap Motion nodes nor the builtin hand gesture parameters.
@@ -45,7 +55,6 @@ Contains sliders for multipliers applied to the breathing Speed, Rotation, model
Based on graph originally developed by Hebi.
Contains sliders for the amount of sway produced by X or Y movement and the Breathing effect, and sliders for the amount of sway added onto the Shoulder bone, Upper and Lower Arm bones, Hand bone, and finger bones.
## Graphics
Various settings for VNyan display and performance
@@ -78,36 +87,53 @@ Audio device to use for lip syncing, with Gain and Smoothing sliders. VNyan supp
## Misc
### Camera Settings
Allows the adjustment of your camera settings. You can move your camera position around with hotkeys + mouse controls.
- **Focal Length** - Adjust the global camear Field of View. A smaller field of view will create greater perspective differences and a 'fish eye' effect. A larger field of view will create smaller perspective differences and a 'flatter' image.
- **Camera Slot** - Allows saving up to 70 different camera positions. First select the camera slot which you want to set and enter the name you wish to call it. *Save Current* will store the current position of the camera in that slot. You can swap between stored camera positions with the [[Camera|Action-Nodes#camera]] node in node graphs.
- **Load Pos** - Loads the currently selected camera position.
### Position Settings
Allows you to change and move your avatar's position independent from the camera.
- **Gizmo Mode** - Reveals either a move or rotate gizmo that you can use to position your avatar. This will be visible in video capture of VNyan, so be sure to turn this off afterwards.
- **Position Slot** - Allows saving up to 70 different avatar positions. First select the position slot you want to set and enter a name for it. Once your avatar is positioned how you like it, press *Save Current*.
- **Load Pos** - Loads the currently selected avatar position.
### Springbone Wind Settings
### Websockets
Allows use of websocket integration, which can be used for things like Stream Decks, Streamerbot or MixItUp. *Start Receiver* will need to be checked for this to work.
### OSC Receiver Port
VNyan can receive OSC parameters through this specified port. You can read more about OSC parameters [[here|Parameters#osc-parameters]].
### Additional Settings
- Accumulate Blendshapes with Add instead of Max
- Don't update avatar meshes when off screen
- Allow 3rd party Mods/Plugins
- Cache VSFAvatars for fast reload
- Hide NSFW Integrations
- **Accumulate Blendshapes with Add instead of Max**
- **Don't update avatar meshes when off screen**
- **Allow 3rd party Mods/Plugins**
- **Cache VSFAvatars for fast reload**
- **Hide NSFW Integrations** - Hides mention and display of Chaturbate and Lovense integration in VNyan.
## Integrations
Settings for the various service integrations available for VNyan. To connect to these services, you will first need to click the corresponding login buttons in the top left of VNyan's UI.
## Services
### Twitch
- **Settings** - Sets whether you want emotes used in chat to drop in your VNyan world around your avatar. You can specify if you'd like to whitelist/allow a selection of emotes to drop here.
- **Redeems** - Interface for creating Channel Point Redemptions right within VNyan. Creating your redemptions in VNyan allows for a bit more control over them within VNyan.
### Youtube
To use the Youtube integration, you'll need to specify the Channel ID (or your current live video's ID). The Channel ID is a cryptic looking number you can find by going to your Youtube channel. It'll show up in the URL. For example, `https://www.youtube.com/channel/channel_id_is_here`
Alternative, you can use a Video ID. This ID can also be found from the URL: `https://www.youtube.com/watch?v=video_id_is_here`.
### Kick
Set your Kick username here.
### Chaturbate
To use Chaturbate, you'll need to generate an authorization token for VNyan that has rights to the Events API. You can do this by clicking the *Generate Auth Token* found in VNyan or [here](https://chaturbate.com/auth/login/?next=/statsapi/authtoken/). Paste the whole Token URL into the respective field.
### Lovense
VNyan supports commanding your toy using Lovense Game Mode. For this you'll need to turn on Game Mode in the Lovense Remove app on your phone. Both your PC and the Lovense Remote need to be on the same LAN for this to work.
# Other Menu Settings
Lovense Remote Game Mode lists "Local IP" and "Port". Fill those into the respective fields in VNyan.
## Colliders
## Effects
## Lights
## Load Avatar
## Load World
## Monitor
## Help
Game Mode needs to be active in your Lovense Remote app so you will need to leave that screen on while using it.