From ee3ac1b313135358ae587556d5f7bccf38a41715 Mon Sep 17 00:00:00 2001 From: Kyobinoyo Date: Tue, 16 Jul 2024 14:45:03 +0200 Subject: [PATCH] Created a Full list of ShockOsc Parameters (#68) - Deleted the parameter list from the avatar setup guides + Created a complete list of parameters in a new file and linked it in mkdocs.yml --- docs/guides/shockosc-avatar-setup-cvr.md | 74 ------------------------ docs/guides/shockosc-avatar-setup-vrc.md | 74 ------------------------ docs/guides/shockosc-parameters.md | 48 +++++++++++++++ mkdocs.yml | 1 + 4 files changed, 49 insertions(+), 148 deletions(-) create mode 100644 docs/guides/shockosc-parameters.md diff --git a/docs/guides/shockosc-avatar-setup-cvr.md b/docs/guides/shockosc-avatar-setup-cvr.md index 10e091b..4f3f3ab 100644 --- a/docs/guides/shockosc-avatar-setup-cvr.md +++ b/docs/guides/shockosc-avatar-setup-cvr.md @@ -25,77 +25,3 @@ 4. Add the Parameter to your Menu as a bool. ![Menu](../static/guides/shockosc/CVR/Menu.png) 5. That's it. 🎉 - -## List of available parameters - -=== "Avatar Dynamic Parameters " - !!! Info "``ShockOsc/{GroupName}`` (bool)" - when set to ``true`` and held, will trigger a normal shock in ShockOSC - - !!! Info "``ShockOsc/{GroupName}_Stretch`` (float)" - can be used to control the shock intensity - (ex. stretch a bone to 50% and let go to get shocked for 50% intensity) - - !!! Info "``ShockOsc/{GroupName}_IsGrabbed`` (bool)" - mainly used to indicate that a Physbone is grabbed - - !!! Info "``ShockOsc/{GroupName}_IShock`` (bool)" - if set to ``true`` will shock immediately ignoring the configured ``HoldTime``. - -=== "Visual Parameters" - !!! Info "``ShockOsc/{GroupName}_Active`` (bool)" - can be used to display an active shock on your avatar (when the shocker is active, ShockOSC will set this to ``true`` if not it will be ``false``) - - !!! Info "``ShockOsc/{GroupName}_Cooldown`` (bool)" - can be used to read out if the shocker is on cooldown - - !!! Info "``ShockOsc/{GroupName}_CooldownPercentage`` (float)" - Reads out the shocker cooldown, 1 means cooldown and 0 means no cooldown. - can be used to make a cooldown timer for example. - - !!! Info "``ShockOsc/{GroupName}_Intensity`` (float)" - represents how close the shock was to your configured max intensity. - -=== "Dummy Shockers" - !!! Info "``_All``" - can be used in place of a group name, **represents all** shockers on your account. - (ex: if **ShockOsc/_All** is set to ``true`` on you Avatar, all of your shockers will be triggered at the same time) - - !!! Info "``_Any``" - can be used in place of a group name, **represents any** shocker on your account. - (ex: if at least one of your shockers are currently shocking **ShockOsc/_Any_Active** will be ``true``) - -=== "Config Parameters" - !!! Info "``ShockOsc/_Config/_All/Paused`` (bool)" - It's a kind of kill switch, pausing ShockOSC. - - !!! Info "``ShockOsc/_Config/_All/MinIntensity`` (Float)" - Sets Minimum Intensity for the Random Mode. - - !!! Info "``ShockOsc/_Config/_All/MaxIntensity`` (Float)" - Sets Maximum Intensity for the Random Mode. - - !!! Info "``ShockOsc/_Config/_All/MinDuration`` (Float)" - Sets Minimum Duration for the Random Mode. - - !!! Info "``ShockOsc/_Config/_All/MaxDuration`` (Float)" - Sets Maximum Duration for the Random Mode. - - !!! Info "``ShockOsc/_Config/_All/Duration`` (Float)" - Sets Duration Time for the Fixed Mode (100% = 10 Sec.) - - !!! Info "``ShockOsc/_Config/_All/Intensity`` (Float)" - Sets Intensity for the Fixed Mode. - - !!! Info "``ShockOsc/_Config/_All/ModeIntensity`` (Float)" - Toggles between Fixed and Random Intensity Mode (True = Random) - - !!! Info "``ShockOsc/_Config/_All/ModeDuration`` (Float)" - Toggles between Fixed and Random Duration Mode (True = Random) - - !!! Info "``ShockOsc/_Config/_All/CooldownTime`` (Float)" - Sets the desired cooldown time. (0 - 100 sec.) - - !!! Info "``ShockOsc/_Config/_All/HoldTime`` (Float)" - Sets the time needed to hold the trigger to activate a shock. - diff --git a/docs/guides/shockosc-avatar-setup-vrc.md b/docs/guides/shockosc-avatar-setup-vrc.md index 0d75328..ca30744 100644 --- a/docs/guides/shockosc-avatar-setup-vrc.md +++ b/docs/guides/shockosc-avatar-setup-vrc.md @@ -114,77 +114,3 @@ This will utilize the Contact Sender and Receiver components of the VRChatSDK to !!! info "Still brewing!" Sorry, we haven't *quite* gotten around to writing this set of articles just yet. **In the meantime, feel free to hit us up on [Discord](https://discord.gg/OpenShock).** - -## List of available parameters - -=== "Avatar Dynamic Parameters " - !!! Info "``ShockOsc/{GroupName}`` (bool)" - when set to ``true`` and held, will trigger a normal shock in ShockOSC - - !!! Info "``ShockOsc/{GroupName}_Stretch`` (float)" - can be used to control the shock intensity - (ex. stretch a bone to 50% and let go to get shocked for 50% intensity) - - !!! Info "``ShockOsc/{GroupName}_IsGrabbed`` (bool)" - mainly used to indicate that a Physbone is grabbed - - !!! Info "``ShockOsc/{GroupName}_IShock`` (bool)" - if set to ``true`` will shock immediately ignoring the configured ``HoldTime``. - -=== "Visual Parameters" - !!! Info "``ShockOsc/{GroupName}_Active`` (bool)" - can be used to display an active shock on your avatar (when the shocker is active, ShockOSC will set this to ``true`` if not it will be ``false``) - - !!! Info "``ShockOsc/{GroupName}_Cooldown`` (bool)" - can be used to read out if the shocker is on cooldown - - !!! Info "``ShockOsc/{GroupName}_CooldownPercentage`` (float)" - Reads out the shocker cooldown, 1 means cooldown and 0 means no cooldown. - can be used to make a cooldown timer for example. - - !!! Info "``ShockOsc/{GroupName}_Intensity`` (float)" - represents how close the shock was to your configured max intensity. - -=== "Dummy Shockers" - !!! Info "``_All``" - can be used in place of a group name, **represents all** shockers on your account. - (ex: if **ShockOsc/_All** is set to ``true`` on you Avatar, all of your shockers will be triggered at the same time) - - !!! Info "``_Any``" - can be used in place of a group name, **represents any** shocker on your account. - (ex: if at least one of your shockers are currently shocking **ShockOsc/_Any_Active** will be ``true``) - -=== "Config Parameters" - !!! Info "``ShockOsc/_Config/_All/Paused`` (bool)" - It's a kill switch, pausing ShockOSC. - - !!! Info "``ShockOsc/_Config/_All/MinIntensity`` (Float)" - Sets Minimum Intensity for the Random Mode. - - !!! Info "``ShockOsc/_Config/_All/MaxIntensity`` (Float)" - Sets Maximum Intensity for the Random Mode. - - !!! Info "``ShockOsc/_Config/_All/MinDuration`` (Float)" - Sets Minimum Duration for the Random Mode. - - !!! Info "``ShockOsc/_Config/_All/MaxDuration`` (Float)" - Sets Maximum Duration for the Random Mode. - - !!! Info "``ShockOsc/_Config/_All/Duration`` (Float)" - Sets Duration Time for the Fixed Mode (100% = 10 Sec.) - - !!! Info "``ShockOsc/_Config/_All/Intensity`` (Float)" - Sets Intensity for the Fixed Mode. - - !!! Info "``ShockOsc/_Config/_All/ModeIntensity`` (Float)" - Toggles between Fixed and Random Intensity Mode (True = Random) - - !!! Info "``ShockOsc/_Config/_All/ModeDuration`` (Float)" - Toggles between Fixed and Random Duration Mode (True = Random) - - !!! Info "``ShockOsc/_Config/_All/CooldownTime`` (Float)" - Sets the desired cooldown time. (0 - 100 sec.) - - !!! Info "``ShockOsc/_Config/_All/HoldTime`` (Float)" - Sets the time needed to hold the trigger to activate a shock. - diff --git a/docs/guides/shockosc-parameters.md b/docs/guides/shockosc-parameters.md new file mode 100644 index 0000000..b429577 --- /dev/null +++ b/docs/guides/shockosc-parameters.md @@ -0,0 +1,48 @@ +# List of ShockOsc Parameters +!!! Warning "Important!" + The syntax of the parameters is important, if it's not correct, ShockOsc will NOT recognize the parameter. + Replace "Groupname" with the name of your group defined in ShockOsc WITHOUT the brackets (ex. ShockOsc/{Groupname} -> ShockOsc/LeftLeg) + +!!! Tip "Avatar Update" + If you updated your avatar with a NEW parameter, delete the files in ``C:\Users\%USERPROFILE%\AppData\LocalLow\VRChat\VRChat\OSC`` to refresh the OSC index. + + +## Avatar Dynamic Parameters +|Parameter | Type |Description | +|:---------------------------------|:----:|:-----------------------------------------------------------------------------------------------------------------| +|**ShockOsc/{GroupName}** |bool |When set to ``true`` and held, will trigger a normal shock in ShockOSC | +|**ShockOsc/{GroupName}_Stretch** |float |Can be used to control the shock intensity (ex. stretch a bone to 50% and let go to get shocked for 50% intensity)| +|**ShockOsc/{GroupName}_IsGrabbed**|bool |Mainly used to indicate that a Physbone is grabbed | +|**ShockOsc/{GroupName}_IShock** |bool |If set to ``true`` will shock immediately ignoring the configured ``HoldTime`` | +|**ShockOsc/{Groupname}_ISound** |bool |If set to ``true`` will trigger a Sound ignoring the configurated ``HoldTime`` | +|**ShockOsc/{Groupname}_IVibrate** |bool |If set to ``true`` will trigger the vibration of the shocker ignoring the configurated ``HoldTime`` | + +## Visual Parameters +|Parameter | Type |Description | +|:------------------------------------------|:----:|:----------------------------------------------------------------------------------------------------------------------------| +|**ShockOsc/{GroupName}_Active** |bool |Is set to ``true`` if the defined group is active, otherwise it's ``false`` | +|**ShockOsc/{GroupName}_Cooldown** |bool |If the defined group is on cooldown this will be ``true`` otherwise it is ``false`` | +|**ShockOsc/{GroupName}_CooldownPercentage**|float |Gives back the shocker cooldown, 1 means cooldown and 0 means no cooldown. (can be used to make a cooldown timer for example)| +|**ShockOsc/{GroupName}_Intensity** |float |Represents how close the shock was to your configured max intensity | + +## Dummy Shockers +|Name |Description | +|:-------|:---------------------------------------------------------------------------------------------------------------------------------------------------------| +|**_All**|Can be used in place of a group name, **represents all** shockers on your account. (ex: if **ShockOsc/_All** is set to ``true`` on you Avatar, all of your shockers will be triggered at the same time)| +|**_Any**|Can be used in place of a group name, **represents any** shocker on your account. (ex: if at least one of your shockers are currently shocking **ShockOsc/_Any_Active** will be ``true``)| + +## Config Parameters +|Parameter | Type |Description | +|:--------------------------------------|:----:|:----------------------------------------------------------------| +|**ShockOsc/_Config/_All/Paused** |bool |It's a kill switch, if set to ``true`` it will pause ShockOSC. | +|**ShockOsc/_Config/_All/MinIntensity** |float |Defines minimum intensity for the random mode. | +|**ShockOsc/_Config/_All/MaxIntensity** |float |Defines maximum intensity for the random mode. | +|**ShockOsc/_Config/_All/MinDuration** |float |Defines minimum dfuration for the random mode. | +|**ShockOsc/_Config/_All/MaxDuration** |float |Defines maximum duration for the random mode. | +|**ShockOsc/_Config/_All/Duration** |float |Defines duration time for the fixed mode (100% = 10 Sec.) | +|**ShockOsc/_Config/_All/Intensity** |float |Defines intensity for the fixed mode. | +|**ShockOsc/_Config/_All/ModeIntensity**|float |Toggles between fixed and random intensity mode (True = Random) | +|**ShockOsc/_Config/_All/ModeDuration** |float |Toggles between fixed and random duration mode (True = Random) | +|**ShockOsc/_Config/_All/CooldownTime** |float |Defines the desired cooldown time. (0 - 100 sec.) | +|**ShockOsc/_Config/_All/HoldTime** |float |Defines the time needed to hold the trigger to activate ShockOsc.| + \ No newline at end of file diff --git a/mkdocs.yml b/mkdocs.yml index 739b431..39690fe 100644 --- a/mkdocs.yml +++ b/mkdocs.yml @@ -23,6 +23,7 @@ nav: - guides/shockosc-basic.md - guides/shockosc-avatar-setup-vrc.md - guides/shockosc-avatar-setup-cvr.md + - guides/shockosc-parameters.md - Hardware: - Shockers: