WaffleSlapper's Project Wiki - User contributions [en]

VTI Troubleshooting

2024-03-27T22:58:17Z

Steeveeo: Rewrote Browser Tab issue to match new behavior. Added Access Token Revocation instructions.

[[Category:VTI]]

To steal a phrase from a friend of mine, VTI is an imperfect application created by an imperfect being. Not only this, but it also relies on an imperfect communication method (until OSC comes to VRChat Worlds) to work. Because of all this, there are some known issues and caveats that you will probably run into while using [[VRChat Twitch Integration|VTI]]. Below is a list of said common issues and how they may be dealt with.

== VTI Occasionally Opens a Browser Tab That Says "Logged In" ==
This is because VTI uses Twitch’s Implicit Grant Flow to authenticate with your Twitch account (see [[VTI Function Overview]] for more details). This method generates an "Access Token" that the Companion uses to connect to Twitch securely. This token is only valid for a limited amount of time and must occasionally be reacquired from Twitch (most documentation says once every 60 days, though this may differ).

== I Want To Revoke My Access Tokens! ==
Whether by way of a security leak or just healthy security paranoia, you might find yourself wanting to remove Twitch access from VTI. This can be done at any time by disconnecting VTI from your Twitch Connections page.

==== FIX: Disconnect "VTI - Stream Integration For VRChat Worlds" On Your [https://www.twitch.tv/settings/connections Twitch Connections Page] ====

== When Trying To Connect, The Panel In VRC Immediately Fails To Connect And Shows A Red Status ==
VTI will connect to the [[VTI Companion App|Companion]] using Remote String Loading (see [[VTI Function Overview]] for more details). To do this, it needs to be able to connect to "localhost:12011", and "localhost" is not a whitelisted URL by default.

==== FIX: Enable "Allow Untrusted URLs" in your Comfort & Safety Settings menu. ====

== The VRChat Link Light Just Keeps Blinking Yellow And Never Connects ==
The [[VTI Companion App]] relies on VRChat’s Debug Log file to hear anything the VRC side is saying. If VRChat is not currently writing out its Debug Output, VTI has nothing to listen to, and the connection will never be able to complete. See [[VTI Function Overview]] for more details.

==== FIX: Enable Logging in VRChat’s Debug options, and remove -nolog from VRChat’s Launch Options if present. ====
[[File:VTI Logging Option Example.png|300px]]

== New Events Take Several Seconds To Trigger ==
This is an unfortunate downside of Remote String Loading, as it is globally capped to only work once every 5 seconds, and while on cooldown new requests will be queued and cleared “at random”. If any other Udon script is also trying to use Remote String Loading, VTI will have to wait an additional 5 seconds for the next open “time slot” that it can attempt a read. VTI will only read once every 6 seconds by default, and hard-cap itself to 5.1 seconds at the fastest so as not to completely hog the Remote String Loading queue.

==== FIX: Petition VRChat to add OSC support for Worlds or something. ====

== The Companion App Keeps Throwing Errors About Permissions And Such ==
Unfortunately, due to how the VTI Companion works, it needs to read from VRChat’s AppData directory. If you are running the [[VTI Companion App|Companion]] with insufficient privileges to read that file, it will fail to connect. Likewise, if you have somehow downloaded the [[VTI Companion App]] without ever running VRChat on the machine, you will see an error that the Log directory cannot be found.

==== FIX: Run the Companion App as Administrator, and run VRChat at least once before launching VTI. ====

== How Do I Run This on Quest/Android? ==
Due to how the [[VTI Companion App]] functions (see [[VTI Function Overview]] for more details), VTI cannot be supported on standalone Quest or Android devices at this time.

==== FIX: Tether your HMD to a PC. ====

VTI Troubleshooting

2024-03-27T02:19:19Z

Steeveeo: Added Allow Untrusted URLs step and some slight reorg.

[[Category:VTI]]

To steal a phrase from a friend of mine, VTI is an imperfect application created by an imperfect being. Not only this, but it also relies on an imperfect communication method (until OSC comes to VRChat Worlds) to work. Because of all this, there are some known issues and caveats that you will probably run into while using [[VRChat Twitch Integration|VTI]]. Below is a list of said common issues and how they may be dealt with.

== Every Time I Open VTI, It Opens A Browser Tab ==
This is because VTI uses Twitch’s Implicit Grant Flow to authenticate with your Twitch account (see [[VTI Function Overview]] for more details). This is the most secure method for both you and myself as the auth tokens only work for that session, are not stored either locally nor on any of my servers, and do not require that I bake VTI’s “Client Secret” into the Companion App’s code or run an external authentication webservice. Put simply: VTI does not collect your login information, and any session information is trashed once VTI is closed.

== When Trying To Connect, The Panel In VRC Immediately Fails To Connect And Shows A Red Status ==
VTI will connect to the [[VTI Companion App|Companion]] using Remote String Loading (see [[VTI Function Overview]] for more details). To do this, it needs to be able to connect to "localhost:12011", and "localhost" is not a whitelisted URL by default.

==== FIX: Enable "Allow Untrusted URLs" in your Comfort & Safety Settings menu. ====

== The VRChat Link Light Just Keeps Blinking Yellow And Never Connects ==
The [[VTI Companion App]] relies on VRChat’s Debug Log file to hear anything the VRC side is saying. If VRChat is not currently writing out its Debug Output, VTI has nothing to listen to, and the connection will never be able to complete. See [[VTI Function Overview]] for more details.

==== FIX: Enable Logging in VRChat’s Debug options, and remove -nolog from VRChat’s Launch Options if present. ====
[[File:VTI Logging Option Example.png|300px]]

== New Events Take Several Seconds To Trigger ==
This is an unfortunate downside of Remote String Loading, as it is globally capped to only work once every 5 seconds, and while on cooldown new requests will be queued and cleared “at random”. If any other Udon script is also trying to use Remote String Loading, VTI will have to wait an additional 5 seconds for the next open “time slot” that it can attempt a read. VTI will only read once every 6 seconds by default, and hard-cap itself to 5.1 seconds at the fastest so as not to completely hog the Remote String Loading queue.

==== FIX: Petition VRChat to add OSC support for Worlds or something. ====

== The Companion App Keeps Throwing Errors About Permissions And Such ==
Unfortunately, due to how the VTI Companion works, it needs to read from VRChat’s AppData directory. If you are running the [[VTI Companion App|Companion]] with insufficient privileges to read that file, it will fail to connect. Likewise, if you have somehow downloaded the [[VTI Companion App]] without ever running VRChat on the machine, you will see an error that the Log directory cannot be found.

==== FIX: Run the Companion App as Administrator, and run VRChat at least once before launching VTI. ====

== How Do I Run This on Quest/Android? ==
Due to how the [[VTI Companion App]] functions (see [[VTI Function Overview]] for more details), VTI cannot be supported on standalone Quest or Android devices at this time.

==== FIX: Tether your HMD to a PC. ====

VTIObjectInstantiate

2024-03-26T04:34:25Z

Steeveeo: Initial writeup.

[[Category:VTI]]
[[Category:VTI Drivers]]

VTIObjectInstantiate is a [[VTI Drivers|VTI Driver]] that will instantiate copies of a Prefab GameObject when fired within a (zero-able) range of either the Streamer or the [[VTI Targets|Target]]. When choosing a Prefab, note that its saved Transform will be used as an offset to its spawned position. For example, if your spawned object should always spawn above the head of a player, make sure the Position in the saved Prefab is set have a Y greater than 0.

'''NOTE''': These spawned items are ''not'' syncable, do not use this Driver for persistent objects!

{| class="wikitable"
|+ Driver Capabilities
|-
| '''Supports User Messaging''' || No (This may change in the future)
|-
| '''Supports Dynamic Rebinding''' || Yes
|-
| '''Network Sync''' || Triggers on all Clients. Spawned objects '''WILL NOT SYNC''' to new joiners!
|-
|}

{| class="wikitable"
|+ Inputs
|-
! Name !! Type !! Usage
|-
| Prefab || GameObject || The GameObject to copy when spawning objects. This can either be an object in the scene, or a Prefab from your Assets.
|-
| Item Container || GameObject || The GameObject to store spawned objects within. This is used to determine how many objects have been spawned when checking against MaxCount, so choose an object without pre-existing children. Defaults to this script's GameObject.
|-
| SpawnAtPlayer || bool || Whether or not to spawn the new object at the Streamer's feet or around the Target.
|-
| RandomSpawnOffsetAxes || Vector3 || How much to randomize the spawn position by in each axis. For instance, setting X to 10.0f will vary the spawn position's X axis by plus-or-minus 10 meters.
|-
| MaxCount || int || How many items can be spawned before this Driver stops spawning new ones. Set to -1 to not limit. '''Exercise caution when turning off limits when the spawned Prefab does not clean itself up!'''
|-
| SpawnDelay || float || How long to wait between setting the randomized spawn position and actually spawning the object. Use to ensure networking has a second to propagate the correct position before spawning.
|-
| SpawnCountRecheckDelay || float || How long in seconds to wait before updating the number of spawned items. Lower values will clear the buffer faster, but incur more load on the CPU.
|-
|}

VTI Drivers

2024-03-26T04:20:28Z

Steeveeo: Added VTIObjectInstantiate line. Also updated to new behavior on VTIObjectToggle.

[[Category:VTI]]

[[File:VTIDriver Inspector.png|thumb]]

In the [[VTI World Kit]], a Driver is a script that acts as an "Endpoint" for when an [[VTI Events|Event]] is received and fired. When attached to the same GameObject as a [[VTI Targets|VTITarget]] component, it will receive Event data when said target is Fired by [[VRChat Twitch Integration|VTI]].

Multiple Drivers can exist under the same [[VTI Targets|Target]], allowing multiple actions to be taken upon firing without needing a bespoke custom Driver.

All Drivers are, and must be, derived from the <syntaxhighlight lang="csharp" inline>VTIDriverBase</syntaxhighlight> base class. The base class includes all the below properties and methods when inherited.

== Properties ==
{| class="wikitable"
|+ Properties
|-
! Property !! Type !! Usage
|-
| UserName || string || The Twitch User Name of the user who triggered this [[VTI Events|Event]].
|-
| Message || string || The User Message, if applicable, that was sent with this [[VTI Events|Event]].
|-
| TriggerCause || string || The reason why this was triggered. Use this when Allow Event Type Rebinding is enabled on the [[VTI Targets|VTITarget]] to dynamically handle user-changed bindings.
|-
| TriggerAmount || int || What "value" is associated with this Event, i.e. how many bits cheered, subs gifted, tier subscribed, etc.
|-
| IsReady || bool || A helper variable to easily mark a Driver as "busy" and unable to refire. Unless overridden in the derived Driver, <syntaxhighlight lang="csharp" inline>VTICheckReady()</syntaxhighlight> will default to just returning this value.
|}

== Methods ==
{| class="wikitable"
|+ Methods
|-
! Method !! Return !! Usage
|-
| VTICheckReady() || bool || This method will be called by VTI just before attempting to fire the parent [[VTI Targets|VTITarget]]. Return <syntaxhighlight lang="csharp" inline>true</syntaxhighlight> if this is ready to be fired.
|-
| VTIEventPlay() || void || This method will be called by VTI when its parent [[VTI Targets|VTITarget]] is Fired.
|}

== Packaged Drivers ==

{| class="wikitable"
|+ Drivers Included With VTI
|-
! Driver !! Usage
|-
| [[VTIAnimTrigger]] || Sets an Animator's Trigger input when Fired.
|-
| [[VTIObjectToggle]] || When Fired, this Driver will enable the target GameObject, wait for <syntaxhighlight lang="csharp" inline>ResetTime</syntaxhighlight> seconds, and then optionally disable it again.
|-
| [[VTIObjectInstantiate]] || Will instantiate a prefab copy when fired within a certain (zero-able) range of either the Streamer or the Target. These copies are not syncable, so do not use them for persistent items.
|-
| [[VTIRadialTripObjectToggle]] || A version of [[VTIObjectToggle]] that will "arm" when Fired, and then wait for a Player to get within a set radius before enabling the target GameObject. Will report unready while Armed and not tripped.
|-
| [[VTIRunMethod]] || Utilizes <syntaxhighlight lang="csharp" inline>SendCustomEvent()</syntaxhighlight> to trigger a named method on the target UdonBehaviour when Fired. When User Messaging is enabled, this Driver will attempt to set the string variables <syntaxhighlight lang="csharp" inline>UserName</syntaxhighlight> and <syntaxhighlight lang="csharp" inline>Message</syntaxhighlight> on the target UdonBehaviour.
|}

== Custom Drivers ==
The [[VTI World Kit]] is designed to be easily extensible by both world designers and programmers alike. To this end, custom Drivers are highly recommended and are built to be fairly simple to create. A custom Driver need only implement one method, <syntaxhighlight lang="csharp" inline>VTIEventPlay()</syntaxhighlight>. All other functionality can be added around that, or is already handled by the VTIDriverBase base class.

For an in-depth tutorial on creating a custom Driver, see [[Creating Custom VTI Drivers]].

VTI Demo World

2024-03-24T00:41:05Z

Steeveeo: Initial Writeup.

[[Category:VTI]]

[[File:VTI-Demo-World main.png|600px]]

The VTI Demo World is an example Unity scene packaged with the [[VTI World Kit]] and is built to demonstrate the capabilities and construction of [[VRChat Twitch Integration]]. As of VTI version 1.0.0, the demo world is laid out on a flat plane with yellow guidelines leading to all the available [[VTI Example Prefabs]] as well as "Explainer Panels" describing the usage and construction of each.

Next to the spawn, there is a main introductory panel describing [[VRChat Twitch Integration|VTI]], how to get the [[VTI Companion App]], and how to connect the Companion to the World. To its left are the [[VTI Control Panel]], [[VTI About Panel]], and the [[VTI Advert Panel]].

This scene serves as both a tutorial for how to use [[VRChat Twitch Integration]] as a User as well as how a VTI-Capable VRChat World is constructed on the Developer side.

File:VTI-Demo-World main.png

2024-03-23T23:47:45Z

Steeveeo:

A screenshot depicting the [[VRChat Twitch Integration|VTI]] Demo World for the [[VTI Demo World]] documentation.

VTIObjectToggle

2024-03-23T21:37:45Z

Steeveeo: Added StayOn and updated Network Sync.

[[Category:VTI]]
[[Category:VTI Drivers]]

VTIObjectToggle is a [[VTI Drivers|VTI Driver]] that will enable a target GameObject when fired, wait for a given amount of time, and then disable the target.

{| class="wikitable"
|+ Driver Capabilities
|-
| '''Supports User Messaging''' || Yes - Uses two TextMeshPro objects for Username and Message Inputs
|-
| '''Supports Dynamic Rebinding''' || Yes - Appends Trigger Verb to UserName String
|-
| '''Network Sync''' || Triggers on all Clients, object toggle state syncs to new joiners
|-
|}

{| class="wikitable"
|+ Inputs
|-
! Name !! Type !! Usage
|-
| Target || GameObject || The GameObject to toggle on/off when Firing.
|-
| UserNameText || TextMeshPro || The TMP object to populate with UserName and Verb text.
|-
| MessageText || TextMeshPro || The TMP object to populate with User Message text.
|-
| StayOn || bool || Whether or not to leave Target enabled after triggering (true), or to turn it back off after ResetTime (false).
|-
| ResetTime || float || How long to keep Target enabled for before disabling.
|}

VTI Function Overview

2024-02-27T01:23:09Z

Steeveeo: Fixed category marker.

[[Category:VTI]]

This page details how the [[VRChat Twitch Integration]] prefab pack (known as the [[VTI World Kit]]) works in tandem with the [[VTI Companion App]] in order to transmit Twitch events to the VRChat Client.

== Overview ==
The first and probably most important thing to note is that VTI is ''not'' a modification of the VRChat client, and therefore does not break the VRChat Terms of Service, nor does it cause issues with Easy Anti-Cheat. Instead, VTI utilizes [https://creators.vrchat.com/worlds/udon/string-loading/ Remote String Loading] and watches VRChat's Debug Log. Read on for more details.

== How VTI Talks to VRChat ==
As previously mentioned, VTI uses [https://creators.vrchat.com/worlds/udon/string-loading/ Remote String Loading] in UdonSharp in order to send data to the VRChat Client. The [[VTI Companion App]] will bundle up all the events that have been triggered through Twitch into it's Event Queue, and then compile said Queue into JSON.

The [[VTI Companion App]] runs a non-internet-facing websocket on port 12011 and listens for VRChat to query for the next update, at which time it will respond with the above JSON, allowing the VRChat side to load the latest Events. This is why the [[VTI Troubleshooting]] article says that turning on ''Allow Untrusted URLs'' is required, as <syntaxhighlight lang="dmesg" inline>localhost</syntaxhighlight> is not on the URL Whitelist.

Because of the reliance on Remote String Loading, VTI can only update the Event Queue once every 5 seconds at the fastest due to how VRChat rate-limits its usage. As this rate-limit is global, VTI will intentionally clamp the fastest update speed to 5.1 seconds to allow any other prefab that uses Remote String Loading to function.

== How VRChat Talks To The Companion ==
At the time of writing, VRChat does not yet support OSC for anything other than Avatars. Because of this, there is only one way to send info outside of the VRChat client, and that is through its Debug Log. If one reads through their VRChat Debug Logs after using VTI, they might come across quite a few lines with the prefix <syntaxhighlight lang="dmesg" inline>[VAL]</syntaxhighlight>. For example:

<syntaxhighlight lang="dmesg">2024.02.04 18:00:51 Log - [VAL] VTI_EVENT_RECEIVED|7ed84988-73a9-4060-8b39-3752357f3025</syntaxhighlight>

In this example, VTI has sent the Companion a message saying that it's acknowledged a specific event, and it will take it from here. The several other signal types can be noted by reading the logs further, but will not be discussed in this article as it is supposed to be a general overview rather than a deep dive.

To note about the prefix, "VAL" stands for "VRChat App Link", and is the moniker for the internal library that handles the intercommunication between VRChat and an application discussed in this article. At this time of writing, this library has not yet been made public, but plans are in place to do so in the future.

== How VTI Connects with Twitch ==
The [[VTI Companion App]] connects with the Twitch through its [https://dev.twitch.tv/docs/ API]. Specifically, it utilizes the [https://dev.twitch.tv/docs/authentication/getting-tokens-oauth/ Implicit Grant Flow] method of authentication, which has been determined to be the safest method for both the developer and the end user. Unfortunately, this means that VTI will always pop up a browser window when beginning the Twitch connection as the credentials '''''are not stored''''' in the VTI Companion nor any of [[WaffleSlapper]]'s or [[Poetica Mechanica]]'s servers. This method also does not require the developer to use a Client Secret (required by other authentication methods) which can be used to cause harm if leaked through the [[VTI Companion App]]'s source code or any external service.

The [[VTI Companion App]] utilizes a customized version of the [https://github.com/SaviorXTanren/StreamingClientLibrary StreamingClientLibrary] by SaviorXTanren, which has been modified to enable the above [https://dev.twitch.tv/docs/authentication/getting-tokens-oauth/ Implicit Grant Flow]. You can view the source code for the fork [https://github.com/Steeveeo/StreamingClientLibrary here].

VTI World Kit Setup

2024-02-20T04:10:23Z

Steeveeo: Initial tutorial writeup.

[[Category:VTI]]
[[Category:VTI Tutorials]]

This tutorial will cover the installation and setup of the [[VTI World Kit]] for usage in creating VRChat Worlds that support [[VRChat Twitch Integration]]. It is the first tutorial in the developer series, and will include the process to get a World to connect to the [[VTI Companion App]]. This tutorial will assume basic knowledge on setting up VRChat Worlds and will not cover that topic.

The VTI World Kit can be found here: https://stevegreendesign.com/project/vti/

== Step 1: Installing VTI ==
[[File:VTI Setup Part1.png|250px]]

Once you have the [[VTI World Kit]] downloaded, install the <syntaxhighlight lang="csharp" inline>.unitypackage</syntaxhighlight> file like you would any other package. Navigate to '''Assets > Import Package > Custom Package...''' and select the [[VTI World Kit]] package. This will add all the VTI assets under <syntaxhighlight lang="csharp" inline>Assets/Poetica Mechanica/</syntaxhighlight>.

Open the folder <syntaxhighlight lang="csharp" inline>Poetica Mechanica/VRC Twitch Integration/Prefabs/</syntaxhighlight>, and drag the <syntaxhighlight lang="csharp" inline>VRChat Twitch Integration.prefab</syntaxhighlight> prefab into the scene. This is the "Core" of the [[VTI World Kit]] and has all the components necessary to run VTI.

== Step 2: Configure World Settings ==
[[File:VTI Setup Part2.png|thumb]]

We now need to configure some settings in order to get things working. Select the GameObject <syntaxhighlight lang="csharp" inline>VRChat Twitch Integration/VRC App Link</syntaxhighlight>. Change the ''VAL World Name'' and ''VAL World Author'' to what you want your World to display when connecting the [[VTI Companion App]] to it.

Note: ''VAL World Name'' is used when saving and loading World Settings for a VTI-Capable World. If this name matches another VTI-Capable World, the [[VTI Companion App]] will consider it to be the same world and attempt to load settings accordingly. This can be handy if you have multiple versions of your World (like a Beta/Release setup, or A/B Channel builds), but it is also worth ensuring the world name is unique enough to not trip up the user. TL;DR, don't name your world "World".

==== Connection Settings ====
Below the ''World Settings'', you can see the ''Connection Settings'' section. For the most part '''it is safe to leave these all default'''. However, for completeness, here are what each of these settings do:

{| class="wikitable"
|-
! Setting !! Usage
|-
| Enable Autostart || When Enabled, VTI will attempt to connect to the [[VTI Companion App]] immediately rather than waiting for the user to connect.
|-
| Companion Sync Delay || How often, in seconds, to attempt to get updates from the [[VTI Companion App]]. This is defaulted to 6 seconds, and clamps itself to 5.1 seconds at a minimum, due to how [https://creators.vrchat.com/worlds/udon/string-loading/ Remote String Loading] is rate-limited.
|-
| Reconnect Delay || In the event of a connection failure, how many seconds to wait before attempting to reconnect to the [[VTI Companion App]]
|-
| Reconnect Attempt Limit || How many attempts are made to connect before giving up.
|-
| Log Ping Delay || If the [[VTI Companion App]] is left in <syntaxhighlight lang="csharp" inline>WAIT_LOG</syntaxhighlight> for this many seconds, this will write a bunch of data to the Debug Log to try to wake it up. Repeats. Best to just leave this at 10 seconds.
|-
| Think Rate || How often the [[VTI World Kit]] will "think" and process inputs. Lower numbers "think" more often, which is more responsive but less efficient.
|}

==== VTI Core Settings ====
[[File:VTI Setup Part2-2.png|thumb]]

Neighboring the <syntaxhighlight lang="csharp" inline>VRC App Link</syntaxhighlight> GameObject is the <syntaxhighlight lang="csharp" inline>VTI Core</syntaxhighlight> object. Select this and note the settings in the Inspector. Like the previous section, '''these are fine to leave as default'''. But for your information, here is what each setting does:

{| class="wikitable"
|-
! Setting !! Usage
|-
| Allow Force Queue || Whether or not to allow the [[VTI Companion App]] to force an event to trigger. Useful for debugging, but can break Game worlds.
|-
| Think Rate || Much like above, how fast this component will "think". Lower numbers are more responsive, but incur a heavier performance cost.
|-
| Event Fire Think Rate || Similar to the above, but an extra kick to the processing speed when VTI is attempting to fire off an [[VTI Events|Event]]. Useful for reducing delay when multiple VTI users are in the same world together and VTI is waiting on [https://creators.vrchat.com/worlds/udon/networking/#ownership Ownership].
|-
| Global Event Cooldown || If you wish to rate-limit the number of [[VTI Events|Events]] cooking off, you can put in an extra delay in seconds here.
|}

== Step 3: Place Control Panel(s) ==
[[File:VTI Setup Part3.png|600px]]

The final thing we need to do to get this world to connect to the [[VTI Companion App]] is to place down one of the Control Panel prefabs. Navigate to the asset folder <syntaxhighlight lang="csharp" inline>Poetica Mechanica/VRC Twitch Integration/Prefabs/UI/</syntaxhighlight> and drag the <syntaxhighlight lang="csharp" inline>English VTI Panels.prefab</syntaxhighlight> prefab into the scene.

''Note: More languages are planned to be supported in the future. When they are, choose the VTI Panels prefab matching the language you wish to use.''

This prefab contains three panels: the main Control Panel, a Download VTI panel, and a "What Is VTI?" panel. The Control Panel has the actual functionality we need, namely the Connect button. The other two are useful to let your users know about VTI and how to get it and are best placed in the Spawn Area of your World. If you wish to place more Control Panels around your world without the other two auxiliary panels, head into the <syntaxhighlight lang="csharp" inline>English/</syntaxhighlight> (or whichever language) asset folder and drag another Control Panel prefab into the scene.

The [[VTI World Kit]] '''supports any number of Control Panels''', and there are '''no extra links to manually make'''. Drop as many Control Panels into the World as you wish!

== Closing ==
And that's it! You can test if everything is setup correctly by building your World, launching the [[VTI Companion App|Companion]], and clicking the Connect button on any Control Panel. If the [[VTI Companion App|Companion]] connects and all the lights on the Control Panel are green, you're done!

However, this World doesn't really ''do anything'' yet. To make it do stuff, continue onto the next tutorial and read [[Creating VTI Targets]].

File:VTI Setup Part3.png

2024-02-20T03:58:02Z

Steeveeo:

A screencap showing the English [[VTI World Kit]] Control Panels for Step 3 of [[VTI World Kit Setup]].

File:VTI Setup Part2-2.png

2024-02-20T03:52:03Z

Steeveeo: Steeveeo uploaded a new version of File:VTI Setup Part2-2.png

A screencap depicting the VTI Core settings for Step 2 of the [[VTI World Kit Setup]] tutorial.

File:VTI Setup Part2-2.png

2024-02-20T03:46:00Z

Steeveeo:

A screencap depicting the VTI Core settings for Step 2 of the [[VTI World Kit Setup]] tutorial.

File:VTI Setup Part2.png

2024-02-20T03:23:11Z

Steeveeo:

A screencap depicting the VAL Core settings to change when setting up the [[VTI World Kit]] in a world. From Step 2 of [[VTI World Kit Setup]].

File:VTI Setup Part1.png

2024-02-20T01:43:40Z

Steeveeo:

A screencap depicting the menu needed to install the [[VTI World Kit]] into a VRChat World. From Step 1 of [[VTI World Kit Setup]].

Creating VTI Targets

2024-02-18T04:12:47Z

Steeveeo: Initial tutorial writeup.

[[Category:VTI]]
[[Category:VTI Tutorials]]

This article is a tutorial on how to use the [[VTI World Kit]] portion of [[VRChat Twitch Integration]] in order to create your own triggerable [[VTI Targets]]. This will be a '''codeless tutorial''', as most basic Targets can be handled by the built-in [[VTI Drivers|Driver Scripts]] included with the World Kit.

This tutorial assumes that you already have the [[VTI World Kit]] setup in your scene. If you have not, please see [[VTI World Kit Setup]].

== Step 1: Design and Driver Selection ==
[[File:VTI Target Tutorial Step1.png|600px]]

The first step of every new [[VTI Targets|Target]] that you want to make is, of course, figuring out what you want it to do. In the case of this tutorial, we have ourselves an object that we'd like to have appear in the scene: a Spooky Cube that will most certainly jumpscare the Streamer. We want it to show up, wait a short while, and then vanish once again.

With all that in mind, we can now go and select ourselves the most fitting [[VTI Drivers|Driver]] for this application. Knowing that this cube doesn't have any special animations or interactions that we need to deal with, we can see that all we have to do is toggle the object's Active state. The [[VTI Drivers|Driver]] that is best for this job would be [[VTIObjectToggle]].

== Step 2: Setting Up The Target ==
[[File:VTI Target Tutorial Step2.png|600px]]

Now that we have our design ideas done, we can start creating the actual [[VTI Targets|Target]]. To do this, we first need to actually '''''make the Target'''''. Create a new Empty in the scene, and name it something easy to find, perhaps something with the word "Target" in it. Next, attach the ''VTI Target'' component onto this Empty.

To make this nice and modular, so we can move this around or turn it into a prefab and not have to worry about external bindings, go ahead and put the SpookyCube underneath the Target object in the hierarchy.

In the inspector for the ''VTI Target'' script, you can see several fields that are either empty or have placeholder values in them. Here are what each of the items on the Inspector represent and how they are used:

* '''ID''': How [[VRChat Twitch Integration|VTI]] will keep track of this Target, and '''''must be unique to any other Target in the scene'''''. Think of it like the home address of your Target.
* '''Display Name''': How the users will see this Target. It '''''does not need to be unique''''' (though it may still be a good idea so as not to be confusing), and is used in the [[VTI Companion App]] and when creating Channel Point Rewards.
* '''Description''': A short sentence describing your Target's behavior and usage. It will show up on the [[VTI Companion App]]'s editor, and on any Channel Point Rewards.
* '''Cooldown''': How often, in seconds, that this Target can be fired. If this Target has been queued up multiple times, this is how long to wait in between each [[VTI Events|Event]]. Use this to make sure whatever your Target is doing is not interrupted or overlapped.
* '''Allow Message Input''': Some [[VTI Drivers|Drivers]] support User Messaging, allowing Twitch viewers to send a message with their trigger. We will handle that later on in this tutorial.
* '''Allow Event Type Rebinding''': Whether or not to allow users of the [[VTI Companion App]] to change how this Target is triggered. Most of the time, you can leave this on. However, if you have a very specific effect that '''''needs''''' to stay on a specific trigger, this is how you prevent changing the binding.

Go ahead and fill out all of that section. Next, note the ''Default Twitch Binding Settings'' below that. This is how you define what specific type of action on Twitch will cause this Target to go off. Every currently-supported event type is available in the ''Default Event Type'' drop down. When selecting an Event Type, the settings form below it will automatically change to match the Event's values.

For instance, let's say we want to have this trigger whenever someone donates more than 100 bits. To do that, we'd set the Event Type to ''CHEER'' and the Numeric Compare to ''GREATER_THAN'' (or ''GREATER_OR_EQUAL'' if you want 100 bits to work as well). If we wanted to change that to triggering whenever anyone cheers any amount, change the Numeric Compare to ''ANY''. To note: When ''Allow Event Type Rebinding'' is enabled, these are your "Recommended" settings for the Target, and the [[VTI Companion App]] will use them until overwritten.

For now, though, we're going to put this onto ''CHANNEL_POINT_REDEEM'' so we can test this without spending money. Set that and then set the Channel Point Cost to 100.

== Step 3: Adding Functionality ==
[[File:VTI Target Tutorial Step3.png|600px]]

Finally, it's time to add in the [[VTI Drivers|Driver]] we picked out in Step 1. Simply add a new component and select the [[VTIObjectToggle]] script. Note that it has a few inputs of its own. The ones we care about for the moment are ''Target'' and ''Reset Time''. Drag the "SpookyCube" GameObject into the ''Target'' input.

For ''Reset Time'', we need to determine how long to keep the jumpscare visible for. For this tutorial, 5 seconds is perfectly fine. However, note how in the ''VTI Target'' component, the Cooldown is still set to 1. This can cause our Target to get double-triggered and can make it look weird. To fix this, just match the ''Cooldown'' input to the ''Reset Time'' input, though you may want to add in an extra second or two to ''Cooldown'' to allow for a little bit of a rest between scares. Don't want to give the Streamer a heart attack or anything.

And that's all that's required for a very basic [[VTI Targets|Target]]! At this point, the SpookyCube Target is all ready to go, and you can build your World and give it a test.

== Step 4: User Messaging ==
[[File:VTI Target Tutorial Step4.png|600px]]

We may have a working Target at this point, but there is one feature we're not yet utilizing: User Messaging. This was mentioned and glossed over earlier in the tutorial, but now it's time that we add it on in. Looking at the documentation for [[VTIObjectToggle]], we can see the [[VTI Drivers|Driver]] supports User Messaging by way of two TextMeshPro objects; one for UserName and one for Message.

To add these in, we're first going to need to do a little adjustment to our hierarchy so we can turn everything on and off, rather than just our jumpscare cube. Create a new Empty with a name of your choice. I went with "Event Object", as this is the GameObject that we're going to make [[VTIObjectToggle]] turn on and off rather than SpookyCube itself. Move SpookyCube underneath that in the hierarchy.

Next, we need two TextMeshPro objects to contain our User Messaging. I have cheated here slightly and just copied the TextMeshPro objects out of the [[VTI Target - Event Firework]] example prefab. You can do that too, or go through the effort of setting everything up yourself if you so choose. I choose cheats. Put both of those under the new Empty we just made as well.

Now, go to the [[VTIObjectToggle]] component in Spooky Target and rebind ''Target'' to look at Event Object instead of SpookyCube. While we're here, also bind the UserText object to the ''User Name Text'' input, and MessageText to ''Message Text''. Finally, in the ''VTI Target'' component, enabled ''Allow Message Input''.

And we're done! When you go into Build and Test mode and link the [[VTI Companion App]] up to the World, the "Cube Jumpscare" redeem will now have a message input added to it automatically. And when activated, the SpookyCube will cause the Streamer to need a change of pants as well as showing who triggered the [[VTI Events|Event]] and a little message to rub salt in the wound.

As an final note, ''Allow Message Input'' is not required to show the UserName of the person who triggered this Target. If ''User Name Text'' is bound and ''Allow Message Input'' is disabled, just the UserName (and [[VTIObjectToggle]]'s "Event Verb") will be displayed!

== Closing ==
That's about all there is to creating your own [[VTI Targets]]. The [[VTI World Kit]] has been created in a way that should allow World Creators to easily create with it with only minimal fuss. As mentioned at the start, the majority of custom [[VTI Targets]] should be able to be created using the [[VTI Drivers|Drivers]] supplied by the [[VTI World Kit]].

However, if you would like to dig a little deeper and learn how to create more complex functionality using code, read the next tutorial: [[Creating Custom VTI Drivers]].

File:VTI Target Tutorial Step4.png

2024-02-18T03:47:43Z

Steeveeo:

A screencap of the Unity Editor showing the addition of two TextMeshPro objects, a hierarchy change, and linking said TMP objects to the [[VTIObjectToggle]] [[VTI Drivers|Driver]] in step 4 of [[Creating VTI Targets]].

VTIRadialTripObjectToggle

2024-02-18T03:43:44Z

Steeveeo:

[[Category:VTI]]
[[Category:VTI Drivers]]

VTIRadialTripObjectToggle is a [[VTI Drivers|VTI Driver]] that operates similarly to [[VTIObjectToggle]]. However, Firing this Driver will set it to be "Armed" and wait until a Player enters a given Radius to trigger.

Useful for jumpscares.

{| class="wikitable"
|+ Driver Capabilities
|-
| '''Supports User Messaging''' || Yes - Uses two TextMeshPro objects for Username and Message Inputs
|-
| '''Supports Dynamic Rebinding''' || Yes - Appends Trigger Verb to UserName String
|-
| '''Network Sync''' || Triggers on all Clients, does not sync to new joiners
|-
|}

{| class="wikitable"
|+ Inputs
|-
! Name !! Type !! Usage
|-
| Target || GameObject || The GameObject to toggle on/off when Firing.
|-
| UserNameText || TextMeshPro || The TMP object to populate with UserName and Verb text.
|-
| MessageText || TextMeshPro || The TMP object to populate with User Message text.
|-
| ResetTime || float || How long to keep Target enabled for before disabling.
|-
| OnlyPOVTrigger || bool || When enabled, only the Streamer's client can trip the radius check. Else, any Player can trip.
|-
| CheckRadius || float || The distance (in meters) a Player has to be within before this Driver "Detonates".
|-
| CheckRate || float || How long (in seconds) to wait between checking for nearby Players. Lower numbers are more responsive and less likely to "miss" if players are moving at speed; higher numbers are more performant.
|}

VTIRadialTripObjectToggle

2024-02-18T03:43:38Z

Steeveeo:

[[Category:VTI]]
[[Category:VTI Drivers]]

VTIRadialTripObjectToggle is a [[VTI Drivers|VTI Driver]] that operates similarly to [[VTIObjectToggle]]. However, Firing this Driver will set it to be "Armed" and wait until a Player enters a given Radius to trigger.

Useful for jumpscares.

{| class="wikitable"
|+ Driver Capabilities
|-
| '''Supports User Messaging''' || Yess - Uses two TextMeshPro objects for Username and Message Inputs
|-
| '''Supports Dynamic Rebinding''' || Yes - Appends Trigger Verb to UserName String
|-
| '''Network Sync''' || Triggers on all Clients, does not sync to new joiners
|-
|}

{| class="wikitable"
|+ Inputs
|-
! Name !! Type !! Usage
|-
| Target || GameObject || The GameObject to toggle on/off when Firing.
|-
| UserNameText || TextMeshPro || The TMP object to populate with UserName and Verb text.
|-
| MessageText || TextMeshPro || The TMP object to populate with User Message text.
|-
| ResetTime || float || How long to keep Target enabled for before disabling.
|-
| OnlyPOVTrigger || bool || When enabled, only the Streamer's client can trip the radius check. Else, any Player can trip.
|-
| CheckRadius || float || The distance (in meters) a Player has to be within before this Driver "Detonates".
|-
| CheckRate || float || How long (in seconds) to wait between checking for nearby Players. Lower numbers are more responsive and less likely to "miss" if players are moving at speed; higher numbers are more performant.
|}

VTIObjectToggle

2024-02-18T03:43:26Z

Steeveeo: Clarified User Messaging support style.

[[Category:VTI]]
[[Category:VTI Drivers]]

VTIObjectToggle is a [[VTI Drivers|VTI Driver]] that will enable a target GameObject when fired, wait for a given amount of time, and then disable the target.

{| class="wikitable"
|+ Driver Capabilities
|-
| '''Supports User Messaging''' || Yes - Uses two TextMeshPro objects for Username and Message Inputs
|-
| '''Supports Dynamic Rebinding''' || Yes - Appends Trigger Verb to UserName String
|-
| '''Network Sync''' || Triggers on all Clients, does not sync to new joiners
|-
|}

{| class="wikitable"
|+ Inputs
|-
! Name !! Type !! Usage
|-
| Target || GameObject || The GameObject to toggle on/off when Firing.
|-
| UserNameText || TextMeshPro || The TMP object to populate with UserName and Verb text.
|-
| MessageText || TextMeshPro || The TMP object to populate with User Message text.
|-
| ResetTime || float || How long to keep Target enabled for before disabling.
|}

File:VTI Target Tutorial Step3.png

2024-02-18T02:44:40Z

Steeveeo:

A screencap depicting the addition of the [[VTIObjectToggle]] [[VTI Drivers|Driver]] to the [[VTI Targets|Target]] in the [[Creating VTI Targets]] tutorial.

File:VTI Target Tutorial Step2.png

2024-02-18T02:09:30Z

Steeveeo:

A screencap showing the hierarchy changes and the added VTI Target component for step 2 of [[Creating VTI Targets]].

File:VTI Target Tutorial Step1.png

2024-02-18T02:00:14Z

Steeveeo:

A screencap depicting the initial state of the [[Creating VTI Targets]] tutorial.

VRChat Twitch Integration

2024-02-18T01:41:46Z

Steeveeo: /* Documentation */

[[Category:VTI]]
{{DISPLAYTITLE:VRChat Twitch Integration (For Worlds!)}}

[[File:VTI Media Banner.png|thumb|250px]]
VRChat Twitch Integration (For Worlds!), or VTI for short, is a tool that enables interactions from Twitch viewers to have a tangible effect on VRChat Worlds. This tool has two major components: the VTI World Kit, and the VTI Companion App, which work in conjunction with the VRChat client to trigger in-world events without requiring modifications to the client.

This article serves as the landing page and lookup directory for VTI Documentation. Please use the sections below to find what you need.

[https://stevegreendesign.com/project/vti/ View The VTI Project Page]

== FAQ ==
* [[VTI Troubleshooting|Troubleshooting and Known Issues]]
* [[VTI Function Overview|How Does VTI Work?]]
* [[VTI Compatibility|How Does VTI Handle Backwards Compatibility?]]
* [[Sentry|What Is Sentry?]]

== VTI Companion App ==
* [[VTI Companion App|About The Companion App]]
* [[VTI Companion Setup|Getting Started]]
* [[VTI Companion Walkthrough|How To Use the Companion]]
* [[VTI Demo World|The VTI Demo World]]

== VTI World Kit ==

==== Documentation ====
* [[VTI World Kit|About the VTI World Kit]]
* [[VTI Targets|Targets]]
* [[VTI Drivers|Drivers]]
* [[VTI Example Prefabs|Example Prefabs]]

==== Tutorials ====
* [[VTI World Kit Setup]]
* [[Creating VTI Targets]]
* [[Creating Custom VTI Drivers]]

VRChat Twitch Integration

2024-02-18T01:41:23Z

Steeveeo: VTI World Kit list restructure

[[Category:VTI]]
{{DISPLAYTITLE:VRChat Twitch Integration (For Worlds!)}}

[[File:VTI Media Banner.png|thumb|250px]]
VRChat Twitch Integration (For Worlds!), or VTI for short, is a tool that enables interactions from Twitch viewers to have a tangible effect on VRChat Worlds. This tool has two major components: the VTI World Kit, and the VTI Companion App, which work in conjunction with the VRChat client to trigger in-world events without requiring modifications to the client.

This article serves as the landing page and lookup directory for VTI Documentation. Please use the sections below to find what you need.

[https://stevegreendesign.com/project/vti/ View The VTI Project Page]

== FAQ ==
* [[VTI Troubleshooting|Troubleshooting and Known Issues]]
* [[VTI Function Overview|How Does VTI Work?]]
* [[VTI Compatibility|How Does VTI Handle Backwards Compatibility?]]
* [[Sentry|What Is Sentry?]]

== VTI Companion App ==
* [[VTI Companion App|About The Companion App]]
* [[VTI Companion Setup|Getting Started]]
* [[VTI Companion Walkthrough|How To Use the Companion]]
* [[VTI Demo World|The VTI Demo World]]

== VTI World Kit ==

==== Documentation ====
* [[VTI World Kit|About the VTI World Kit]]
* [[VTI Targets|Targets]]
* [[VTI Drivers|Drivers]]
* [[VTI Example Prefabs|Examples]]

==== Tutorials ====
* [[VTI World Kit Setup]]
* [[Creating VTI Targets]]
* [[Creating Custom VTI Drivers]]

VTI Targets

2024-02-16T10:47:13Z

Steeveeo: Added section about network ownership.

[[Category:VTI]]

[[File:VTITarget Inspector.png|thumb|400px|VTITarget's Inspector]]

The VTITarget component is one of the core scripts for the [[VTI World Kit]]. It is used to identify a GameObject as something that can be interacted with by Twitch viewers when running [[VRChat Twitch Integration]].

== Properties ==
{| class="wikitable"
|+ Properties
|-
! Property !! Usage
|-
| ID || The Unique Identifier for this Target. Used internally to dispatch [[VTI Events|Events]]. Must not match any other VTITargets in the scene or a warning will be thrown.
|-
| Display Name || The User-Friendly name for this Target. Used in the [[VTI Companion App]]'s Target editor and when generating Channel Point Rewards. Does not need to be unique.
|-
| Description || A short sentence describing the usage of this Target. Used in the [[VTI Companion App]]'s Target editor and when generating Channel Point Rewards.
|-
| Cooldown || The number of seconds to wait before this Target can be fired again. Set this to at least as long as the events run by any attached [[VTI Drivers]] unless they are capable of being interrupted or overlapped.
|-
| Allow Message Input || Enable this when any attached [[VTI Drivers]] expect User Messaging in order to function.
|-
| Allow Event Type Rebinding || If any attached [[VTI Drivers]] are specifically tailored to one specific event, disable this. For example: a Driver that expects a chat command with a specific argument will likely not work when set to SUBCRIBE_GIFT.
|-
| Default Event Type || What Twitch Event this Target should be fired on. This presents as a dropdown for all [https://dev.twitch.tv/docs/eventsub/eventsub-subscription-types EventSub Subscription Types] currently supported by [[VRChat Twitch Integration|VTI]].
|-
| Default Twitch Binding Settings || This section is dynamically displayed based on which Event Type is selected. Use this area to tune exactly what parameters are required to fire this Target.
|}

== Methods ==
{| class="wikitable"
|+ Methods
|-
! Method !! Return !! Usage
|-
| VTICheckCanFire() || bool || Check whether or not this Target is off cooldown and all attached [[VTI Drivers|Drivers]] are reporting Ready.
|-
| VTIFire() || void || Trigger this Target. Forwards [[VTI Events|Event]] data to all attached [[VTI Drivers|Drivers]] and calls <syntaxhighlight lang="csharp" inline>Driver.VTIEventPlay()</syntaxhighlight> on each.
|}

== Event Firing ==
When the [[VTI Event Handler]] receives an [[VTI Events|Event]] from the [[VTI Companion App]], it will enqueue it under the ID of the triggered Target. Once that Event is at the top of the Queue, the Event Handler will attempt to dispatch the Event data to the Target and then call <syntaxhighlight lang="csharp" inline>VTIFire()</syntaxhighlight>.

Once Fired, the VTITarget will forward the Event data to each [[VTI Drivers|Driver]] component within the same GameObject as the VTITarget component, and then call <syntaxhighlight lang="csharp" inline>VTIEventPlay()</syntaxhighlight> on each Driver.

==== Readiness Validation ====
Before firing, the [[VTI Event Handler]] will call <syntaxhighlight lang="csharp" inline>VTICheckCanFire()</syntaxhighlight> against the queued VTITarget. This will first check the current time against the Cooldown property, and then will loop through all attached [[VTI Drivers|Driver]] component and call <syntaxhighlight lang="csharp" inline>VTICheckReady()</syntaxhighlight> on each. If any Driver returns <syntaxhighlight lang="csharp" inline>false</syntaxhighlight>, or the Cooldown has not yet elapsed, the Event is skipped and the process repeats for the next in line.

==== Network Ownership ====
As a final step before firing, the [[VTI World Kit]] will attempt to take [https://creators.vrchat.com/worlds/udon/networking/ Ownership] of the GameObject. In order to prevent desynced cooldowns from double-firing or overriding another Streamer's [[VTI Events|Events]], the VTITarget script will also refuse ownership transfer if it is still in use. Objects that the [[VTI World Kit]] cannot take Ownership of will stay on the queue until Ownership can be obtained. If this results in an [[VTI Events|Event]] that never fires, check to make sure you don't have other things trying to keep Ownership of that object, e.g. scripts on a Pickup with the VRCObjectSync component attached.

== User Messaging ==
[[VRChat Twitch Integration|VTI]] supports Twitch viewers sending messages into the VRChat World through [[VTI Events]]. When the Allow Message Input property is enabled, [[VRChat Twitch Integration|VTI]] will automatically handle several aspects on the backend (see below), and VTITarget will ingest these messages to be passed onto any attached [[VTI Drivers|Drivers]].

==== Bits ====
In CHEER mode, the user's entire message with the cheered Bits is transmitted in the Message value.

==== Subscriptions ====
'''ISSUE''': Resubscription User Messaging is not yet supported. This is due to some strangeness in how the Twitch API handles returning Subscriber messages. The <syntaxhighlight lang="csharp" inline>channel.subscribe</syntaxhighlight> event doesn't contain message data, and the <syntaxhighlight lang="csharp" inline>channel.subscribe.message</syntaxhighlight> event fires alongside the former, duplicating triggers. Update 1 is slated to correct this and implement Subscription messages properly.

==== Channel Point Rewards ====
In CHANNEL_POINT_REDEEM mode, [[VRChat Twitch Integration|VTI]] will automatically set the Channel Point Reward to require the user to input a message with the redemption.

==== Chat Commands ====
When the Event Type is bound to <syntaxhighlight lang="csharp" inline>CHAT_COMMAND</syntaxhighlight>, the Message value will be set in one of two ways.

===== Exact =====
In EXACT mode, the first word of the user's string is treated as the Command (ex: <syntaxhighlight lang="csharp" inline>!fire</syntaxhighlight>). When Messaging is allowed, everything after the first word is transmitted as the Message value.

===== CONTAINS =====
In CONTAINS mode, or partial string matching, the [[VTI Events|Event]] is fired whenever the trigger string is found in a user's chat message. In this mode, when Messaging is allowed, the entire chat string is transmitted as the Message value, including the trigger string.

== Target Prefabs ==
The [[VTI World Kit]] comes with several pre-made Targets to both demonstrate the capabilities of [[VRChat Twitch Integration|VTI]] as well as speed up World integration by handling some common events.

{| class="wikitable"
|+ Prefabs
|-
! Prefab Name !! Usage
|-
| [[VTI Target - Event Firework]] || A firework fountain that lights when the specified Event Type is triggered. Handles User Messaging and Event Type Rebinding dynamically.
|-
| [[VTI Target - Rocket Command]] || Adds a Chat Command to launch the Streamer into the air. User Messaging is used to determine the "power" of the launch.
|-
| [[VTI Target - Anim Trigger]] || Demonstrates how animations can be triggered by VTI.
|-
| [[VTI Target - Tripmine]] || A mine that explodes when the Streamer gets near. Demonstrates how Events can be used to "Arm" an effect and play it later. Handles User Messaging and Event Type Rebinding dynamically.
|-
| [[VTI Target - Hydrate]] || Plays a shower of water particles and shows a message reminding the Streamer to drink some water. Mimics the incredibly common Channel Point Reward in use by many streamers.
|-
| [[VTI Target - Chat Panel]] || A "Q&A" style panel that accepts User Messaging, queuing up any sent messages to be manually displayed by the Streamer. Demonstrates VTI's usefulness in Panel-style talk shows.
|}

VTI Events

2024-02-16T10:41:16Z

Steeveeo: Initial writeup.

[[Category:VTI]]

An Event in [[VRChat Twitch Integration|VTI]] refers to an instance of a Twitch user triggering a [[VTI Targets|Target]] in a VRChat World with the [[VTI World Kit]] installed. When a Twitch performs an action that matches the Binding Settings for one or more [[VTI Targets|Targets]], the [[VTI Companion App]] will process the action, then create and enqueue an Event with any pertinent data. Then, when the [[VTI World Kit]] queries for a queue update, all queued Events will be serialized into JSON and sent to the VRChat client.

Once processed by the [[VTI World Kit]], this Event will be queued up for firing once it reaches the front of the queue and its [[VTI Targets|Target Object]] becomes available.

== Event Data ==
All Events are serialized as JSON upon transmission, and contain the following data:

{| class="wikitable"
|+ Event Data
|-
! Property !! Type !! Usage
|-
| ID || Guid || [https://learn.microsoft.com/en-us/dotnet/api/system.guid?view=net-8.0 Globally Unique Identifier] for this Event.
|-
| TargetID || string || The Unique ID of the [[VTI Targets|Target Object]].
|-
| UserName || string || The Twitch User Name of the user who triggered this Event.
|-
| Message || string || The User Message, if applicable, that was sent with this Event.
|-
| TriggerCause || string || The reason/event type that caused this Event to be created.
|-
| TriggerAmount || int || What "value" is associated with this Event, i.e. how many bits cheered, subs gifted, tier subscribed, etc.
|-
| Canceled || bool || Marked <syntaxhighlight lang="csharp" inline>true</syntaxhighlight> when the [[VTI Companion App]] user selects the Cancel button on this Event.
|}

== Cancellation of Events ==
Events can be canceled at any time before they are fired. However, they may still fire after the Cancel button is clicked if the [[VTI World Kit]] does not receive the cancellation update in time before firing. This is due to the long delay imposed by Remote String Loading (see: [[VTI Function Overview]]).

In a future update, Events will be auto-canceled if their triggering action (chat message, channel point redeem, etc) is deleted by moderator action.

VTIRunMethod

2024-02-14T05:02:39Z

Steeveeo: Initial driver page.

[[Category:VTI]]
[[Category:VTI Drivers]]

VTIRunMethod is a [[VTI Drivers|VTI Driver]] that will run a named method on a target UdonBehaviour using <syntaxhighlight lang="csharp" inline>SendCustomEvent()</syntaxhighlight>. This method must be a <syntaxhighlight lang="csharp" inline>public void</syntaxhighlight> method with no arguments.

User Messaging is supported by using <syntaxhighlight lang="csharp" inline>SetProgramVariable()</syntaxhighlight> to attempt to set the string members <syntaxhighlight lang="csharp" inline>UserName</syntaxhighlight> and <syntaxhighlight lang="csharp" inline>Message</syntaxhighlight> on the target UdonBehaviour. If these members exist, they will be set and be available when the method is called.

{| class="wikitable"
|+ Driver Capabilities
|-
| '''Supports User Messaging''' || Yes - Message Data is sent to Target UdonBehaviour as Program Variables
|-
| '''Supports Dynamic Rebinding''' || No special support added, but should not break when rebinding
|-
| '''Network Sync''' || Triggers on all Clients, does not sync to new joiners
|-
|}

{| class="wikitable"
|+ Inputs
|-
! Name !! Type !! Usage
|-
| Target || UdonBehaviour || The UdonBehaviour to call Method on.
|-
| Method || string || The name of the Method to run on Target.
|}

VTIObjectToggle

2024-02-14T04:52:51Z

Steeveeo:

[[Category:VTI]]
[[Category:VTI Drivers]]

VTIObjectToggle is a [[VTI Drivers|VTI Driver]] that will enable a target GameObject when fired, wait for a given amount of time, and then disable the target.

{| class="wikitable"
|+ Driver Capabilities
|-
| '''Supports User Messaging''' || Yes
|-
| '''Supports Dynamic Rebinding''' || Yes - Appends Trigger Verb to UserName String
|-
| '''Network Sync''' || Triggers on all Clients, does not sync to new joiners
|-
|}

{| class="wikitable"
|+ Inputs
|-
! Name !! Type !! Usage
|-
| Target || GameObject || The GameObject to toggle on/off when Firing.
|-
| UserNameText || TextMeshPro || The TMP object to populate with UserName and Verb text.
|-
| MessageText || TextMeshPro || The TMP object to populate with User Message text.
|-
| ResetTime || float || How long to keep Target enabled for before disabling.
|}

VTIAnimTrigger

2024-02-14T04:52:40Z

Steeveeo:

[[Category:VTI]]
[[Category:VTI Drivers]]

VTIAnimTrigger is a [[VTI Drivers|VTI Driver]] that will call <syntaxhighlight lang="csharp" inline>Animator.SetTrigger(TriggerName)</syntaxhighlight> when fired.

{| class="wikitable"
|+ Driver Capabilities
|-
| '''Supports User Messaging''' || No
|-
| '''Supports Dynamic Rebinding''' || Yes
|-
| '''Network Sync''' || Triggers on all Clients, does not sync to new joiners
|-
|}

{| class="wikitable"
|+ Inputs
|-
! Name !! Type !! Usage
|-
| Anim || Animator || The Animator to target when Firing.
|-
| TriggerName || string || The name of the Trigger to activate on Anim.
|-
| ResetTime || float || How long to wait before this Driver can be fired again.
|}

VTIRadialTripObjectToggle

2024-02-14T04:52:28Z

Steeveeo: Initial driver page.

[[Category:VTI]]
[[Category:VTI Drivers]]

VTIRadialTripObjectToggle is a [[VTI Drivers|VTI Driver]] that operates similarly to [[VTIObjectToggle]]. However, Firing this Driver will set it to be "Armed" and wait until a Player enters a given Radius to trigger.

Useful for jumpscares.

{| class="wikitable"
|+ Driver Capabilities
|-
| '''Supports User Messaging''' || Yes
|-
| '''Supports Dynamic Rebinding''' || Yes - Appends Trigger Verb to UserName String
|-
| '''Network Sync''' || Triggers on all Clients, does not sync to new joiners
|-
|}

{| class="wikitable"
|+ Inputs
|-
! Name !! Type !! Usage
|-
| Target || GameObject || The GameObject to toggle on/off when Firing.
|-
| UserNameText || TextMeshPro || The TMP object to populate with UserName and Verb text.
|-
| MessageText || TextMeshPro || The TMP object to populate with User Message text.
|-
| ResetTime || float || How long to keep Target enabled for before disabling.
|-
| OnlyPOVTrigger || bool || When enabled, only the Streamer's client can trip the radius check. Else, any Player can trip.
|-
| CheckRadius || float || The distance (in meters) a Player has to be within before this Driver "Detonates".
|-
| CheckRate || float || How long (in seconds) to wait between checking for nearby Players. Lower numbers are more responsive and less likely to "miss" if players are moving at speed; higher numbers are more performant.
|}

VTIAnimTrigger

2024-02-14T04:45:27Z

Steeveeo:

[[Category:VTI]]
[[Category:VTI Drivers]]

VTIAnimTrigger is a [[VTI Drivers|VTI Driver]] that will call <syntaxhighlight lang="csharp" inline>Animator.SetTrigger(TriggerName)</syntaxhighlight> when fired.

{| class="wikitable"
|+ Driver Capabilities
|-
| '''Supports User Messaging''' || No
|-
| '''Supports Dynamic Rebinding''' || Yes
|-
| '''Network Sync''' || Triggers on all Clients, does not sync to new joiners
|-
|}

{| class="wikitable"
|+ Inputs
|-
! Name !! Type !! Usage
|-
| Anim || Animator || The Animator to target when Firing
|-
| TriggerName || string || The name of the Trigger to activate on Anim
|-
| ResetTime || float || How long to wait before this Driver can be fired again
|}

VTIObjectToggle

2024-02-14T04:45:16Z

Steeveeo: Initial driver page.

[[Category:VTI]]
[[Category:VTI Drivers]]

VTIObjectToggle is a [[VTI Drivers|VTI Driver]] that will enable a target GameObject when fired, wait for a given amount of time, and then disable the target.

{| class="wikitable"
|+ Driver Capabilities
|-
| '''Supports User Messaging''' || Yes
|-
| '''Supports Dynamic Rebinding''' || Yes - Appends Trigger Verb to UserName String
|-
| '''Network Sync''' || Triggers on all Clients, does not sync to new joiners
|-
|}

{| class="wikitable"
|+ Inputs
|-
! Name !! Type !! Usage
|-
| Target || GameObject || The GameObject to toggle on/off when Firing
|-
| UserNameText || TextMeshPro || The TMP object to populate with UserName and Verb text
|-
| MessageText || TextMeshPro || The TMP object to populate with User Message text
|-
| ResetTime || float || How long to keep Target enabled for before disabling
|}

VTIAnimTrigger

2024-02-14T04:40:20Z

Steeveeo: Initial driver page.

[[Category:VTI]]
[[Category:VTI Drivers]]

VTIAnimTrigger is a [[VTI Drivers|VTI Driver]] that will call <syntaxhighlight lang="csharp" inline>Animator.SetTrigger(TriggerName)</syntaxhighlight> when fired.

{| class="wikitable"
|+ Driver Capabilities
|-
| '''Supports User Messaging''' || No
|-
| '''Supports Dynamic Rebinding''' || Yes
|-
| '''Network Sync''' || Does not sync for new joiners
|-
|}

{| class="wikitable"
|+ Inputs
|-
! Name !! Type !! Usage
|-
| Anim || Animator || The Animator to target when Firing
|-
| TriggerName || string || The name of the Trigger to activate on Anim
|-
| ResetTime || float || How long to wait before this Driver can be fired again
|}

Creating Custom VTI Drivers

2024-02-14T01:06:48Z

Steeveeo: Added "Next Steps" section and some minor cleanup and code highlighting to previous commits.

[[Category:VTI]]
[[Category:VTI Tutorials]]

The [[VTI World Kit]] is designed to be easily extensible by both world designers and programmers alike. To this end, custom Drivers are highly recommended and are built to be fairly simple to create. This article serves as a tutorial on how to create a custom Driver. It will assume basic knowledge of UdonSharp, and will not cover Udon Graph at all (as I think quite poorly of the interface and believe it takes several orders of magnitude more effort and time to do something you can do in just a few lines of C#).

In this tutorial, we will be replicating the [[VTIObjectToggle]] Driver as it demonstrates all the core tenets of how [[VTI Drivers]] function.

== Create the Script ==
Create a new U# script and open it in your IDE of choice. Change the inherited class from UdonSharpBehaviour to VTIDriverBase. This will let it work with the [[VTI World Kit]] and includes a bunch of necessary methods and members to simplify our Driver setup.

<syntaxhighlight lang="csharp">
public class CustomDriver : VTIDriverBase
</syntaxhighlight>

Next, we need our control variables so the script can function. As we are turning a GameObject on for a period of time, and then off after it, add a public property for a GameObject a float for the time it will take to reset. For sanity's sake, also add a call in the Start() method to turn the Target off, to make sure it won't fire when the level loads.

<syntaxhighlight lang="csharp" highlight="3,4,8">
public class CustomDriver : VTIDriverBase
{
public GameObject Target;
public float ResetTime = 5.0f;

void Start()
{
Target.SetActive(false);
}
}
</syntaxhighlight>

== Add Core Functionality ==
The simplest possible [[VTI Drivers|Driver]] only needs to implement the <syntaxhighlight lang="csharp" inline>VTIEventPlay()</syntaxhighlight> method. This is what is called when an [[VTI Events|Event]] is received, all checks have passed, and [[VRChat Twitch Integration|VTI]] is attempting to Fire this Driver's [[VTI Targets|Target]].

Add a public override void method called VTIEventPlay(). Clear out the <syntaxhighlight lang="csharp" inline>base.VTIEventPlay();</syntaxhighlight> line if your IDE added it automatically.

<syntaxhighlight lang="csharp">
public override void VTIEventPlay()
{

}
</syntaxhighlight>

Next, we need to make the Driver actually do the thing we want it to do, which is to turn on a GameObject, wait, and then turn it off. The first thing we'll need is to call <syntaxhighlight lang="csharp" inline>Target.SetActive(true)</syntaxhighlight> in our new method. Then, create another method that will do the exact opposite and call <syntaxhighlight lang="csharp" inline>Target.SetActive(false)</syntaxhighlight>.

<syntaxhighlight lang="csharp" highlight="3,6-9">
public override void VTIEventPlay()
{
Target.SetActive(true);
}

public void ResetTarget()
{
Target.SetActive(false);
}
</syntaxhighlight>

For the core of our functionality, we only need to do one more thing: make <syntaxhighlight lang="csharp" inline>VTIEventPlay()</syntaxhighlight> call <syntaxhighlight lang="csharp" inline>ResetTarget()</syntaxhighlight> after a delay. We can do this simply by utilizing the built-in <syntaxhighlight lang="csharp" inline>SendCustomEventDelayedSeconds()</syntaxhighlight> method. Add that into <syntaxhighlight lang="csharp" inline>VTIEventPlay()</syntaxhighlight> and have it wait for <syntaxhighlight lang="csharp" inline>ResetTime</syntaxhighlight> seconds.

<syntaxhighlight lang="csharp">
SendCustomEventDelayedSeconds(nameof(ResetTarget), ResetTime);
</syntaxhighlight>

As an aside, note the usage of <syntaxhighlight lang="csharp" inline>nameof</syntaxhighlight> instead of just putting <syntaxhighlight lang="csharp" inline>"ResetTarget"</syntaxhighlight> in the first argument. This allows for a measure of safety when maintaining projects later on, as if you need to rename <syntaxhighlight lang="csharp" inline>ResetTarget()</syntaxhighlight> for whatever reason, you can utilize something like Visual Studio's Rename function and not have to worry about manually typing the name change into all the Custom Event calls.

At this end of this section, this is how our script looks:

<syntaxhighlight lang="csharp">
using UnityEngine;

public class CustomDriver : VTIDriverBase
{
public GameObject Target;
public float ResetTime = 5.0f;

void Start()
{
Target.SetActive(false);
}

public override void VTIEventPlay()
{
Target.SetActive(true);
SendCustomEventDelayedSeconds(nameof(ResetTarget), ResetTime);
}

public void ResetTarget()
{
Target.SetActive(false);
}
}
</syntaxhighlight>

== Dealing With Readiness ==
For the most basic of Drivers, the Cooldown timer is automatically handled by [[VTI Targets|VTITarget]]. However, in this case, we're turning an object on and telling VRChat to turn it back off after an arbitrary delay. In some circumstances, you may want your Drivers to be able to overlap themselves when triggered multiple times. But in this case, we have a Custom Event running on a timer, which can cause some level of havoc if we don't tell VTI that we're not ready to Fire again.

There are two ways to do this: The <syntaxhighlight lang="csharp" inline>IsReady</syntaxhighlight> variable, and adding in a custom <syntaxhighlight lang="csharp" inline>VTICheckReady()</syntaxhighlight> method. The former method is exceptionally simple, and all we really need for this tutorial, so we'll cover that first.

==== The IsReady Boolean ====
The <syntaxhighlight lang="csharp" inline>IsReady</syntaxhighlight> boolean serves as a bit of a "Green Light" to signal the [[VTI World Kit]] that this [[VTI Drivers|Driver]] is ready to go or not. Right now, we need to turn that light "red" while we wait for the Custom Event timer to elapse, and then turn it back to "green" when we're done. To do this, simply set <syntaxhighlight lang="csharp" inline>IsReady = false;</syntaxhighlight> in <syntaxhighlight lang="csharp" inline>VTIEventPlay()</syntaxhighlight>, and set it back to <syntaxhighlight lang="csharp" inline>true</syntaxhighlight> in <syntaxhighlight lang="csharp" inline>ResetTarget()</syntaxhighlight>.

<syntaxhighlight lang="csharp" highlight="3,11">
public override void VTIEventPlay()
{
IsReady = false;

Target.SetActive(true);
SendCustomEventDelayedSeconds(nameof(ResetTarget), ResetTime);
}

public void ResetTarget()
{
IsReady = true;

Target.SetActive(false);
}
</syntaxhighlight>

And that's it! By default, <syntaxhighlight lang="csharp" inline>VTICheckReady()</syntaxhighlight> will simply return the value of <syntaxhighlight lang="csharp" inline>IsReady</syntaxhighlight> unless overridden, so for the purposes of this script, we don't even need to do anything more than this!

==== VTICheckReady() ====
However, what if we need to be more complex in our checks to see if we can Fire again or not? In this case, a simple boolean may not be enough. For the purposes of this tutorial, this step is optional, and will only serve as an example of how this can be done another way.

There's not really much we need to check in a Driver as simple as this, so let's just be super paranoid about the state of the Target GameObject and ensure that it got turned off before allowing [[VRChat Twitch Integration|VTI]] to Fire this again. To do this, first add in an override for <syntaxhighlight lang="csharp" inline>VTICheckReady()</syntaxhighlight>.

Next, replace the auto-generated "base" call (if your IDE made one) with a simple expression to return <syntaxhighlight lang="csharp" inline>true</syntaxhighlight> if both <syntaxhighlight lang="csharp" inline>IsReady</syntaxhighlight> is <syntaxhighlight lang="csharp" inline>true</syntaxhighlight> and Target is not currently active. This can look like the below:

<syntaxhighlight lang="csharp">
public override bool VTICheckReady()
{
return IsReady && !Target.activeSelf;
}
</syntaxhighlight>

== Basic Driver Complete ==
And that's basically it! This Driver can now be attached to a [[VTI Targets|VTITarget]] like any of the base Drivers that came with the [[VTI World Kit]]. Our simple Driver code should now look like this:

<syntaxhighlight lang="csharp">
using UnityEngine;

public class CustomDriver : VTIDriverBase
{
public GameObject Target;
public float ResetTime = 5.0f;

void Start()
{
Target.SetActive(false);
}

public override void VTIEventPlay()
{
IsReady = false;

Target.SetActive(true);
SendCustomEventDelayedSeconds(nameof(ResetTarget), ResetTime);
}

public void ResetTarget()
{
IsReady = true;

Target.SetActive(false);
}
}
</syntaxhighlight>

= Next Steps =
Now while we have a completed Driver that does what it needs to do, there are still more things that can be done to improve it. Read on to learn how to handle User Messaging and Dynamic Rebinding.

== User Messaging ==
With the VTIDriverBase base class, User Messaging is already available for any custom [[VTI Drivers|Driver]], it needs only to be tapped into. The base class includes the following four members that are used to handle [[VTI Events|Event]] data:

* <syntaxhighlight lang="csharp" inline>public string UserName</syntaxhighlight>
* <syntaxhighlight lang="csharp" inline>public string Message</syntaxhighlight>
* <syntaxhighlight lang="csharp" inline>public string TriggerCause</syntaxhighlight>
* <syntaxhighlight lang="csharp" inline>public int TriggerAmount</syntaxhighlight>

The latter two variables are for dynamically handling different Triggers and will be covered in the next section. This section concerns the first two strings, UserName and Message. These will automatically be populated by the [[VTI World Kit]] when <syntaxhighlight lang="csharp" inline>VTIEventPlay()</syntaxhighlight> is called, and can be used at that point to populate any effect you wish your Driver to handle.

For the purposes of this tutorial, we are simply going to put the User Messaging contents into a couple TextMeshPro elements and call it a day. Because the Message can be a lot longer than the UserName, we're going to use two TMP elements here instead of one, so we can make the two elements different sizes.

Add in two public properties for TextMeshPro elements:

<syntaxhighlight lang="csharp">
public TextMeshPro UserNameText;
public TextMeshPro MessageText;
</syntaxhighlight>

Next, we will need to expand our <syntaxhighlight lang="csharp" inline>VTIEventPlay()</syntaxhighlight> a little bit to actually print out the User Messaging. We can do that simply by setting the <syntaxhighlight lang="csharp" inline>TextMeshPro.text</syntaxhighlight> property, but on top of that, we generally want Drivers to be flexible, so we'll wrap them in validity checks as well just in case this is used on a [[VTI Targets|Target]] that doesn't utilize User Messaging:

<syntaxhighlight lang="csharp" highlight="5-8,10-13">
public override void VTIEventPlay()
{
IsReady = false;

if (Utilities.IsValid(UserNameText))
{
UserNameText.text = UserName;
}

if (Utilities.IsValid(MessageText))
{
MessageText.text = Message;
}

Target.SetActive(true);
SendCustomEventDelayedSeconds(nameof(ResetTarget), ResetTime);
}
</syntaxhighlight>

And once again, that's as simple as it needs to be!

== Dynamic Rebinding ==
For the final section of this tutorial, we'll be handling the most complicated (and optional) part of making a custom Driver: dealing with a [[VTI Targets|Target]] that has been rebound by the user when Allow Event Type Rebinding is enabled. Now, I say complicated, but purely because this part requires just a modicum of thought put into how to handle the different modes.

For our purposes, we're simply going to change up the UserName line to say what the user did to trigger the [[VTI Events|Event]]. That is, if the Streamer changed the binding from CHANNEL_POINT_REDEEM to CHEER, we want to put "[username] cheered [x] bits" in the UserNameText element. The way you would detect the type of binding used is with the <syntaxhighlight lang="csharp" inline>TriggerCause</syntaxhighlight> string from VTIDriverBase.

From there, we can use the <syntaxhighlight lang="csharp" inline>TriggerAmount</syntaxhighlight> value to show how "much" the user did whatever they did to trigger the [[VTI Events|Event]], i.e. how many bits, what tier they subscribed at, how many gifted subs, etc.

==== An Important Note About TriggerCause ====
Now, I must make a note about how <syntaxhighlight lang="csharp" inline>TriggerCause</syntaxhighlight> works: due to an attempt at future proofing, the <syntaxhighlight lang="csharp" inline>TriggerCause</syntaxhighlight> includes the origin service name at the front of the string, as I would '''like to''' support other Streaming platforms like YouTube or TikTok at some point in the future, and these services all have different methods of interacting with the stream. For instance, if the [[VTI Targets|Target]] is bound to the FOLLOW event type, the <syntaxhighlight lang="csharp" inline>TriggerCause</syntaxhighlight> will be set to <syntaxhighlight lang="csharp" inline>"TWITCH_FOLLOW"</syntaxhighlight>.

The way I handled it in [[VTIObjectToggle]] was to simply have a method with a Switch-Case statement that returns a suffix string for each supported event type. This is not the only way to do this, but it worked for my purposes and so we'll do it here. Add in the following method:

<syntaxhighlight lang="csharp">
private string GetEventVerb(int amount = 0)
{
switch (TriggerCause)
{
case "TWITCH_FOLLOW":
return " followed";
case "TWITCH_SUBSCRIBE":
return " subscribed (Tier " + amount + ")";
case "TWITCH_SUBSCRIBE_GIFT":
return " gifted " + amount + " subs";
case "TWITCH_CHEER":
return " cheered " + amount + " bits";
default:
return "";
}
}
</syntaxhighlight>

This method will take in <syntaxhighlight lang="csharp" inline>TriggerAmount</syntaxhighlight> as an argument, look at <syntaxhighlight lang="csharp" inline>TriggerCause</syntaxhighlight>, and branch to what suffix it needs to append to match the bound event type. With the <syntaxhighlight lang="csharp" inline>default</syntaxhighlight> case, we're simply returning an empty string since we don't care to add anything for something like CHAT_COMMAND or CHANNEL_POINT_REDEEM.

Finally, we just need to adjust our <syntaxhighlight lang="csharp" inline>VTIEventPlay()</syntaxhighlight> method to apply this new method to the string, like so:

<syntaxhighlight lang="csharp" highlight="3">
if (Utilities.IsValid(UserNameText))
{
UserNameText.text = UserName + GetEventVerb(TriggerAmount);
}
</syntaxhighlight>

== Closing ==
And that's about all there is to making a custom [[VTI Drivers|Driver]]. This may have been a bit of a long-winded article, but I wanted to explain all the steps along the way to making a custom Driver, rather than just throwing the final code at the screen and making you look at it. This tutorial Driver should now be able to be used near-identically to [[VTIObjectToggle]], and the steps we took to get here should be nearly the same for any new applications you wish to add on top of the [[VTI World Kit]].

Here is what our Driver looks like at the end of the tutorial:

<syntaxhighlight lang="csharp">
using TMPro;
using UnityEngine;
using VRC.SDKBase;

public class CustomDriver : VTIDriverBase
{
public GameObject Target;
public float ResetTime = 5.0f;

public TextMeshPro UserNameText;
public TextMeshPro MessageText;

void Start()
{
Target.SetActive(false);
}

public override void VTIEventPlay()
{
IsReady = false;

if (Utilities.IsValid(UserNameText))
{
UserNameText.text = UserName + GetEventVerb(TriggerAmount);
}

if (Utilities.IsValid(MessageText))
{
MessageText.text = Message;
}

Target.SetActive(true);
SendCustomEventDelayedSeconds(nameof(ResetTarget), ResetTime);
}

public void ResetTarget()
{
IsReady = true;

Target.SetActive(false);
}

private string GetEventVerb(int amount = 0)
{
switch (TriggerCause)
{
case "TWITCH_FOLLOW":
return " followed";
case "TWITCH_SUBSCRIBE":
return " subscribed (Tier " + amount + ")";
case "TWITCH_SUBSCRIBE_GIFT":
return " gifted " + amount + " subs";
case "TWITCH_CHEER":
return " cheered " + amount + " bits";
default:
return "";
}
}
}
</syntaxhighlight>

Creating Custom VTI Drivers

2024-02-13T08:39:40Z

Steeveeo: Initial tutorial writeup.

VRChat Twitch Integration

2024-02-13T07:44:13Z

Steeveeo: Added Custom Driver tutorial link.

[[Category:VTI]]
{{DISPLAYTITLE:VRChat Twitch Integration (For Worlds!)}}

[[File:VTI Media Banner.png|thumb|250px]]
VRChat Twitch Integration (For Worlds!), or VTI for short, is a tool that enables interactions from Twitch viewers to have a tangible effect on VRChat Worlds. This tool has two major components: the VTI World Kit, and the VTI Companion App, which work in conjunction with the VRChat client to trigger in-world events without requiring modifications to the client.

This article serves as the landing page and lookup directory for VTI Documentation. Please use the sections below to find what you need.

[https://stevegreendesign.com/project/vti/ View The VTI Project Page]

== FAQ ==
* [[VTI Troubleshooting|Troubleshooting and Known Issues]]
* [[VTI Function Overview|How Does VTI Work?]]
* [[VTI Compatibility|How Does VTI Handle Backwards Compatibility?]]
* [[Sentry|What Is Sentry?]]

== VTI Companion App ==
* [[VTI Companion App|About The Companion App]]
* [[VTI Companion Setup|Getting Started]]
* [[VTI Companion Walkthrough|How To Use the Companion]]
* [[VTI Demo World|The VTI Demo World]]

== VTI World Kit ==
* [[VTI World Kit|About the VTI World Kit]]
* [[VTI World Kit Setup|Setting Up VTI]]
* [[VTI Targets|Targets]]
* [[VTI Drivers|Drivers]]
* [[Creating Custom VTI Drivers]]
* [[VTI Example Prefabs|Examples]]

VTI Drivers

2024-02-13T07:43:16Z

Steeveeo: Initial writeup.

[[Category:VTI]]

[[File:VTIDriver Inspector.png|thumb]]

In the [[VTI World Kit]], a Driver is a script that acts as an "Endpoint" for when an [[VTI Events|Event]] is received and fired. When attached to the same GameObject as a [[VTI Targets|VTITarget]] component, it will receive Event data when said target is Fired by [[VRChat Twitch Integration|VTI]].

Multiple Drivers can exist under the same [[VTI Targets|Target]], allowing multiple actions to be taken upon firing without needing a bespoke custom Driver.

All Drivers are, and must be, derived from the <syntaxhighlight lang="csharp" inline>VTIDriverBase</syntaxhighlight> base class. The base class includes all the below properties and methods when inherited.

== Properties ==
{| class="wikitable"
|+ Properties
|-
! Property !! Type !! Usage
|-
| UserName || string || The Twitch User Name of the user who triggered this [[VTI Events|Event]].
|-
| Message || string || The User Message, if applicable, that was sent with this [[VTI Events|Event]].
|-
| TriggerCause || string || The reason why this was triggered. Use this when Allow Event Type Rebinding is enabled on the [[VTI Targets|VTITarget]] to dynamically handle user-changed bindings.
|-
| TriggerAmount || int || What "value" is associated with this Event, i.e. how many bits cheered, subs gifted, tier subscribed, etc.
|-
| IsReady || bool || A helper variable to easily mark a Driver as "busy" and unable to refire. Unless overridden in the derived Driver, <syntaxhighlight lang="csharp" inline>VTICheckReady()</syntaxhighlight> will default to just returning this value.
|}

== Methods ==
{| class="wikitable"
|+ Methods
|-
! Method !! Return !! Usage
|-
| VTICheckReady() || bool || This method will be called by VTI just before attempting to fire the parent [[VTI Targets|VTITarget]]. Return <syntaxhighlight lang="csharp" inline>true</syntaxhighlight> if this is ready to be fired.
|-
| VTIEventPlay() || void || This method will be called by VTI when its parent [[VTI Targets|VTITarget]] is Fired.
|}

== Packaged Drivers ==

{| class="wikitable"
|+ Drivers Included With VTI
|-
! Driver !! Usage
|-
| [[VTIAnimTrigger]] || Sets an Animator's Trigger input when Fired.
|-
| [[VTIObjectToggle]] || When Fired, this Driver will enable the target GameObject, wait for <syntaxhighlight lang="csharp" inline>ResetTime</syntaxhighlight> seconds, and then disable it again.
|-
| [[VTIRadialTripObjectToggle]] || A version of [[VTIObjectToggle]] that will "arm" when Fired, and then wait for a Player to get within a set radius before enabling the target GameObject. Will report unready while Armed and not tripped.
|-
| [[VTIRunMethod]] || Utilizes <syntaxhighlight lang="csharp" inline>SendCustomEvent()</syntaxhighlight> to trigger a named method on the target UdonBehaviour when Fired. When User Messaging is enabled, this Driver will attempt to set the string variables <syntaxhighlight lang="csharp" inline>UserName</syntaxhighlight> and <syntaxhighlight lang="csharp" inline>Message</syntaxhighlight> on the target UdonBehaviour.
|}

== Custom Drivers ==
The [[VTI World Kit]] is designed to be easily extensible by both world designers and programmers alike. To this end, custom Drivers are highly recommended and are built to be fairly simple to create. A custom Driver need only implement one method, <syntaxhighlight lang="csharp" inline>VTIEventPlay()</syntaxhighlight>. All other functionality can be added around that, or is already handled by the VTIDriverBase base class.

For an in-depth tutorial on creating a custom Driver, see [[Creating Custom VTI Drivers]].

File:VTIDriver Inspector.png

2024-02-13T07:01:58Z

Steeveeo:

A screencap showing an example of a VTI Driver and its parent VTITarget.

VTI Targets

2024-02-13T06:57:11Z

Steeveeo: Lots more info for VTITarget.

[[Category:VTI]]

[[File:VTITarget Inspector.png|thumb|400px|VTITarget's Inspector]]

The VTITarget component is one of the core scripts for the [[VTI World Kit]]. It is used to identify a GameObject as something that can be interacted with by Twitch viewers when running [[VRChat Twitch Integration]].

== Properties ==
{| class="wikitable"
|+ Properties
|-
! Property !! Usage
|-
| ID || The Unique Identifier for this Target. Used internally to dispatch [[VTI Events|Events]]. Must not match any other VTITargets in the scene or a warning will be thrown.
|-
| Display Name || The User-Friendly name for this Target. Used in the [[VTI Companion App]]'s Target editor and when generating Channel Point Rewards. Does not need to be unique.
|-
| Description || A short sentence describing the usage of this Target. Used in the [[VTI Companion App]]'s Target editor and when generating Channel Point Rewards.
|-
| Cooldown || The number of seconds to wait before this Target can be fired again. Set this to at least as long as the events run by any attached [[VTI Drivers]] unless they are capable of being interrupted or overlapped.
|-
| Allow Message Input || Enable this when any attached [[VTI Drivers]] expect User Messaging in order to function.
|-
| Allow Event Type Rebinding || If any attached [[VTI Drivers]] are specifically tailored to one specific event, disable this. For example: a Driver that expects a chat command with a specific argument will likely not work when set to SUBCRIBE_GIFT.
|-
| Default Event Type || What Twitch Event this Target should be fired on. This presents as a dropdown for all [https://dev.twitch.tv/docs/eventsub/eventsub-subscription-types EventSub Subscription Types] currently supported by [[VRChat Twitch Integration|VTI]].
|-
| Default Twitch Binding Settings || This section is dynamically displayed based on which Event Type is selected. Use this area to tune exactly what parameters are required to fire this Target.
|}

== Methods ==
{| class="wikitable"
|+ Methods
|-
! Method !! Return !! Usage
|-
| VTICheckCanFire() || bool || Check whether or not this Target is off cooldown and all attached [[VTI Drivers|Drivers]] are reporting Ready.
|-
| VTIFire() || void || Trigger this Target. Forwards [[VTI Events|Event]] data to all attached [[VTI Drivers|Drivers]] and calls <syntaxhighlight lang="csharp" inline>Driver.VTIEventPlay()</syntaxhighlight> on each.
|}

== Event Firing ==
When the [[VTI Event Handler]] receives an [[VTI Events|Event]] from the [[VTI Companion App]], it will enqueue it under the ID of the triggered Target. Once that Event is at the top of the Queue, the Event Handler will attempt to dispatch the Event data to the Target and then call <syntaxhighlight lang="csharp" inline>VTIFire()</syntaxhighlight>.

Once Fired, the VTITarget will forward the Event data to each [[VTI Drivers|Driver]] component within the same GameObject as the VTITarget component, and then call <syntaxhighlight lang="csharp" inline>VTIEventPlay()</syntaxhighlight> on each Driver.

==== Readiness Validation ====
Before firing, the [[VTI Event Handler]] will call <syntaxhighlight lang="csharp" inline>VTICheckCanFire()</syntaxhighlight> against the queued VTITarget. This will first check the current time against the Cooldown property, and then will loop through all attached [[VTI Drivers|Driver]] component and call <syntaxhighlight lang="csharp" inline>VTICheckReady()</syntaxhighlight> on each. If any Driver returns <syntaxhighlight lang="csharp" inline>false</syntaxhighlight>, or the Cooldown has not yet elapsed, the Event is skipped and the process repeats for the next in line.

== User Messaging ==
[[VRChat Twitch Integration|VTI]] supports Twitch viewers sending messages into the VRChat World through [[VTI Events]]. When the Allow Message Input property is enabled, [[VRChat Twitch Integration|VTI]] will automatically handle several aspects on the backend (see below), and VTITarget will ingest these messages to be passed onto any attached [[VTI Drivers|Drivers]].

==== Bits ====
In CHEER mode, the user's entire message with the cheered Bits is transmitted in the Message value.

==== Subscriptions ====
'''ISSUE''': Resubscription User Messaging is not yet supported. This is due to some strangeness in how the Twitch API handles returning Subscriber messages. The <syntaxhighlight lang="csharp" inline>channel.subscribe</syntaxhighlight> event doesn't contain message data, and the <syntaxhighlight lang="csharp" inline>channel.subscribe.message</syntaxhighlight> event fires alongside the former, duplicating triggers. Update 1 is slated to correct this and implement Subscription messages properly.

==== Channel Point Rewards ====
In CHANNEL_POINT_REDEEM mode, [[VRChat Twitch Integration|VTI]] will automatically set the Channel Point Reward to require the user to input a message with the redemption.

==== Chat Commands ====
When the Event Type is bound to <syntaxhighlight lang="csharp" inline>CHAT_COMMAND</syntaxhighlight>, the Message value will be set in one of two ways.

===== Exact =====
In EXACT mode, the first word of the user's string is treated as the Command (ex: <syntaxhighlight lang="csharp" inline>!fire</syntaxhighlight>). When Messaging is allowed, everything after the first word is transmitted as the Message value.

===== CONTAINS =====
In CONTAINS mode, or partial string matching, the [[VTI Events|Event]] is fired whenever the trigger string is found in a user's chat message. In this mode, when Messaging is allowed, the entire chat string is transmitted as the Message value, including the trigger string.

== Target Prefabs ==
The [[VTI World Kit]] comes with several pre-made Targets to both demonstrate the capabilities of [[VRChat Twitch Integration|VTI]] as well as speed up World integration by handling some common events.

{| class="wikitable"
|+ Prefabs
|-
! Prefab Name !! Usage
|-
| [[VTI Target - Event Firework]] || A firework fountain that lights when the specified Event Type is triggered. Handles User Messaging and Event Type Rebinding dynamically.
|-
| [[VTI Target - Rocket Command]] || Adds a Chat Command to launch the Streamer into the air. User Messaging is used to determine the "power" of the launch.
|-
| [[VTI Target - Anim Trigger]] || Demonstrates how animations can be triggered by VTI.
|-
| [[VTI Target - Tripmine]] || A mine that explodes when the Streamer gets near. Demonstrates how Events can be used to "Arm" an effect and play it later. Handles User Messaging and Event Type Rebinding dynamically.
|-
| [[VTI Target - Hydrate]] || Plays a shower of water particles and shows a message reminding the Streamer to drink some water. Mimics the incredibly common Channel Point Reward in use by many streamers.
|-
| [[VTI Target - Chat Panel]] || A "Q&A" style panel that accepts User Messaging, queuing up any sent messages to be manually displayed by the Streamer. Demonstrates VTI's usefulness in Panel-style talk shows.
|}

VTI Targets

2024-02-13T06:27:16Z

Steeveeo: More fleshing out of VTITarget.

VTI Targets

2024-02-13T05:26:41Z

Steeveeo: Initial setup save.

File:VTITarget Inspector.png

2024-02-13T04:45:36Z

Steeveeo:

A screencap displaying the standard Inspector layout for the VTITarget component.

VTI World Kit

2024-02-10T02:26:31Z

Steeveeo: VTI World Kit stub.

[[Category:VTI]]

[[File:VTI Media Banner.png|thumb|200px|link=VRChat Twitch Integration]]
The VTI World Kit is the VRChat-side component of [[VRChat Twitch Integration]]. It consists of numerous scripts and prefabs in order to enable the [[VTI Companion App]] to communicate with the VRChat World. The VTI spec is also rather flexible, and is set up to allow for easy extensibility for world creators looking to make their own custom events.

Purchase the VTI World Kit: https://stevegreendesign.com/project/vti/

== Related Articles ==
* [[VTI World Kit Setup|Setting Up VTI]]
* [[VTI Targets|Targets]]
* [[VTI Drivers|Drivers]]
* [[VTI Example Prefabs|Examples]]
* [[VTI Compatibility|How Does VTI Handle Backwards Compatibility?]]

VTI Companion App

2024-02-10T02:11:03Z

Steeveeo: Resized VTI Logo

[[Category:VTI]]

[[File:VTI Media Banner.png|thumb|200px|link=VRChat Twitch Integration]]
The VTI Companion App is a third-party application for [[VRChat Twitch Integration]]. It acts as a go-between and allows a VRChat World with the [[VTI World Kit]] installed to connect with Twitch and allow a streamer's chat to trigger special effects. As VRChat itself has no way to connect to web services or APIs like REST on its own, the Companion uses native VRChat functionality to bridge the gap and allow [[VRChat Twitch Integration|VTI]] to function. For more detailed information on how the Companion achieves this, please see [[VTI Function Overview]].

Download the Companion App: https://stevegreendesign.com/project/vti/

== Related Articles ==
* [[VTI Troubleshooting|Troubleshooting and Known Issues]]
* [[VTI Function Overview|How Does VTI Work?]]
* [[VTI Companion Setup|Getting Started]]
* [[VTI Companion Walkthrough|How To Use the Companion]]
* [[VTI Demo World|The VTI Demo World]]

VTI Compatibility

2024-02-10T01:07:28Z

Steeveeo: Expanded on "short answer" line.

[[Category:VTI]]

If you are reading this article, you may be wondering something along the lines of, "If I implement [[VRChat Twitch Integration|VTI]] in my World, will I have to constantly fix it every time the [[VTI Companion App]] gets updated?"

The short answer is "No". The longer answer is "No, as long as VRChat updates don't break anything and there are no blocking issues that prevent everything written below."

== General Approach ==
When it comes to backwards compatibility, [[VRChat Twitch Integration|VTI]] will follow a simple premise: '''Old Worlds will be Supported by New Apps, but Old Apps will not Support New Worlds.'''

Specifically, this means that the goal of the VTI project is to allow any World built on any version of the [[VTI World Kit]] to work in the latest version of the [[VTI Companion App]], but that no effort will be made to have any sort of "underclocking" or "feature lockout" if it detects a user using an older version of the application than that world was built for. This is because the [[VTI World Kit]] is a premium, for-purchase asset, but the [[VTI Companion App]] will always be free.

== Versioning ==
There are two versions that are checked when the [[VRChat Twitch Integration|VTI]] connection is made in a VTI-capable VRChat world: <syntaxhighlight lang="dmesg" inline>VTIVersion</syntaxhighlight> and <syntaxhighlight lang="dmesg" inline>APIVersion</syntaxhighlight>.

<syntaxhighlight lang="dmesg" inline>VTIVersion</syntaxhighlight> is the specific interconnect version number between the [[VTI World Kit]] and the [[VTI Companion App]]. This version number will increment if a feature is added that requires more communication between the two sides. It will '''not''' increment if a World Kit or Companion update is made that only adds features to that specific side. For example: the [[VTI World Kit]] updates to add more [[VTI Drivers|Driver Types]], which the [[VTI Companion App]] doesn't need any new info to deal with. In this case, the <syntaxhighlight lang="dmesg" inline>VTIVersion</syntaxhighlight> is '''not''' incremented.

<syntaxhighlight lang="dmesg" inline>APIVersion</syntaxhighlight> refers to the backend communication library that VTI uses, called VRChat App Link (VAL). This will only ever increment if the way that the [[VTI World Kit]] and the [[VTI Companion App]] communicate needs to change. For example: VRChat implements OSC for Worlds, and VTI updates to utilize that rather than the current method detailed in [[VTI Function Overview]]. In this hypothetical update, <syntaxhighlight lang="dmesg" inline>APIVersion</syntaxhighlight> '''will''' increment.

VTI Compatibility

2024-02-10T01:06:13Z

Steeveeo: Fixed typo in Category tag.

[[Category:VTI]]

If you are reading this article, you may be wondering something along the lines of, "If I implement [[VRChat Twitch Integration|VTI]] in my World, will I have to constantly fix it every time the [[VTI Companion App]] gets updated?"

The short answer is "no".

== General Approach ==
When it comes to backwards compatibility, [[VRChat Twitch Integration|VTI]] will follow a simple premise: '''Old Worlds will be Supported by New Apps, but Old Apps will not Support New Worlds.'''

Specifically, this means that the goal of the VTI project is to allow any World built on any version of the [[VTI World Kit]] to work in the latest version of the [[VTI Companion App]], but that no effort will be made to have any sort of "underclocking" or "feature lockout" if it detects a user using an older version of the application than that world was built for. This is because the [[VTI World Kit]] is a premium, for-purchase asset, but the [[VTI Companion App]] will always be free.

== Versioning ==
There are two versions that are checked when the [[VRChat Twitch Integration|VTI]] connection is made in a VTI-capable VRChat world: <syntaxhighlight lang="dmesg" inline>VTIVersion</syntaxhighlight> and <syntaxhighlight lang="dmesg" inline>APIVersion</syntaxhighlight>.

<syntaxhighlight lang="dmesg" inline>VTIVersion</syntaxhighlight> is the specific interconnect version number between the [[VTI World Kit]] and the [[VTI Companion App]]. This version number will increment if a feature is added that requires more communication between the two sides. It will '''not''' increment if a World Kit or Companion update is made that only adds features to that specific side. For example: the [[VTI World Kit]] updates to add more [[VTI Drivers|Driver Types]], which the [[VTI Companion App]] doesn't need any new info to deal with. In this case, the <syntaxhighlight lang="dmesg" inline>VTIVersion</syntaxhighlight> is '''not''' incremented.

<syntaxhighlight lang="dmesg" inline>APIVersion</syntaxhighlight> refers to the backend communication library that VTI uses, called VRChat App Link (VAL). This will only ever increment if the way that the [[VTI World Kit]] and the [[VTI Companion App]] communicate needs to change. For example: VRChat implements OSC for Worlds, and VTI updates to utilize that rather than the current method detailed in [[VTI Function Overview]]. In this hypothetical update, <syntaxhighlight lang="dmesg" inline>APIVersion</syntaxhighlight> '''will''' increment.

VTI Compatibility

2024-02-10T01:05:52Z

Steeveeo: Initial writeup.

[Category:VTI]

If you are reading this article, you may be wondering something along the lines of, "If I implement [[VRChat Twitch Integration|VTI]] in my World, will I have to constantly fix it every time the [[VTI Companion App]] gets updated?"

The short answer is "no".

== General Approach ==
When it comes to backwards compatibility, [[VRChat Twitch Integration|VTI]] will follow a simple premise: '''Old Worlds will be Supported by New Apps, but Old Apps will not Support New Worlds.'''

Specifically, this means that the goal of the VTI project is to allow any World built on any version of the [[VTI World Kit]] to work in the latest version of the [[VTI Companion App]], but that no effort will be made to have any sort of "underclocking" or "feature lockout" if it detects a user using an older version of the application than that world was built for. This is because the [[VTI World Kit]] is a premium, for-purchase asset, but the [[VTI Companion App]] will always be free.

== Versioning ==
There are two versions that are checked when the [[VRChat Twitch Integration|VTI]] connection is made in a VTI-capable VRChat world: <syntaxhighlight lang="dmesg" inline>VTIVersion</syntaxhighlight> and <syntaxhighlight lang="dmesg" inline>APIVersion</syntaxhighlight>.

<syntaxhighlight lang="dmesg" inline>VTIVersion</syntaxhighlight> is the specific interconnect version number between the [[VTI World Kit]] and the [[VTI Companion App]]. This version number will increment if a feature is added that requires more communication between the two sides. It will '''not''' increment if a World Kit or Companion update is made that only adds features to that specific side. For example: the [[VTI World Kit]] updates to add more [[VTI Drivers|Driver Types]], which the [[VTI Companion App]] doesn't need any new info to deal with. In this case, the <syntaxhighlight lang="dmesg" inline>VTIVersion</syntaxhighlight> is '''not''' incremented.

<syntaxhighlight lang="dmesg" inline>APIVersion</syntaxhighlight> refers to the backend communication library that VTI uses, called VRChat App Link (VAL). This will only ever increment if the way that the [[VTI World Kit]] and the [[VTI Companion App]] communicate needs to change. For example: VRChat implements OSC for Worlds, and VTI updates to utilize that rather than the current method detailed in [[VTI Function Overview]]. In this hypothetical update, <syntaxhighlight lang="dmesg" inline>APIVersion</syntaxhighlight> '''will''' increment.

VRChat Twitch Integration

2024-02-10T00:48:09Z

Steeveeo: Added Backwards Compat. entry.

[[Category:VTI]]
{{DISPLAYTITLE:VRChat Twitch Integration (For Worlds!)}}

[[File:VTI Media Banner.png|thumb|250px]]
VRChat Twitch Integration (For Worlds!), or VTI for short, is a tool that enables interactions from Twitch viewers to have a tangible effect on VRChat Worlds. This tool has two major components: the VTI World Kit, and the VTI Companion App, which work in conjunction with the VRChat client to trigger in-world events without requiring modifications to the client.

This article serves as the landing page and lookup directory for VTI Documentation. Please use the sections below to find what you need.

[https://stevegreendesign.com/project/vti/ View The VTI Project Page]

== FAQ ==
* [[VTI Troubleshooting|Troubleshooting and Known Issues]]
* [[VTI Function Overview|How Does VTI Work?]]
* [[VTI Compatibility|How Does VTI Handle Backwards Compatibility?]]
* [[Sentry|What Is Sentry?]]

== VTI Companion App ==
* [[VTI Companion App|About The Companion App]]
* [[VTI Companion Setup|Getting Started]]
* [[VTI Companion Walkthrough|How To Use the Companion]]
* [[VTI Demo World|The VTI Demo World]]

== VTI World Kit ==
* [[VTI World Kit|About the VTI World Kit]]
* [[VTI World Kit Setup|Setting Up VTI]]
* [[VTI Targets|Targets]]
* [[VTI Drivers|Drivers]]
* [[VTI Example Prefabs|Examples]]

Category:VTI

2024-02-10T00:24:05Z

Steeveeo: Created page with "VTI, or VRChat Twitch Integration (For Worlds!) is a pairing of VRChat Prefabs and a third party application that allows VRChat streamers to let their viewers interact with Worlds and trigger special events."

VTI, or VRChat Twitch Integration (For Worlds!) is a pairing of VRChat Prefabs and a third party application that allows VRChat streamers to let their viewers interact with Worlds and trigger special events.

VTI Function Overview

2024-02-10T00:22:03Z

Steeveeo: Added Category

[Category:VTI]

This page details how the [[VRChat Twitch Integration]] prefab pack (known as the [[VTI World Kit]]) works in tandem with the [[VTI Companion App]] in order to transmit Twitch events to the VRChat Client.

== Overview ==
The first and probably most important thing to note is that VTI is ''not'' a modification of the VRChat client, and therefore does not break the VRChat Terms of Service, nor does it cause issues with Easy Anti-Cheat. Instead, VTI utilizes [https://creators.vrchat.com/worlds/udon/string-loading/ Remote String Loading] and watches VRChat's Debug Log. Read on for more details.

== How VTI Talks to VRChat ==
As previously mentioned, VTI uses [https://creators.vrchat.com/worlds/udon/string-loading/ Remote String Loading] in UdonSharp in order to send data to the VRChat Client. The [[VTI Companion App]] will bundle up all the events that have been triggered through Twitch into it's Event Queue, and then compile said Queue into JSON.

The [[VTI Companion App]] runs a non-internet-facing websocket on port 12011 and listens for VRChat to query for the next update, at which time it will respond with the above JSON, allowing the VRChat side to load the latest Events. This is why the [[VTI Troubleshooting]] article says that turning on ''Allow Untrusted URLs'' is required, as <syntaxhighlight lang="dmesg" inline>localhost</syntaxhighlight> is not on the URL Whitelist.

Because of the reliance on Remote String Loading, VTI can only update the Event Queue once every 5 seconds at the fastest due to how VRChat rate-limits its usage. As this rate-limit is global, VTI will intentionally clamp the fastest update speed to 5.1 seconds to allow any other prefab that uses Remote String Loading to function.

== How VRChat Talks To The Companion ==
At the time of writing, VRChat does not yet support OSC for anything other than Avatars. Because of this, there is only one way to send info outside of the VRChat client, and that is through its Debug Log. If one reads through their VRChat Debug Logs after using VTI, they might come across quite a few lines with the prefix <syntaxhighlight lang="dmesg" inline>[VAL]</syntaxhighlight>. For example:

<syntaxhighlight lang="dmesg">2024.02.04 18:00:51 Log - [VAL] VTI_EVENT_RECEIVED|7ed84988-73a9-4060-8b39-3752357f3025</syntaxhighlight>

In this example, VTI has sent the Companion a message saying that it's acknowledged a specific event, and it will take it from here. The several other signal types can be noted by reading the logs further, but will not be discussed in this article as it is supposed to be a general overview rather than a deep dive.

To note about the prefix, "VAL" stands for "VRChat App Link", and is the moniker for the internal library that handles the intercommunication between VRChat and an application discussed in this article. At this time of writing, this library has not yet been made public, but plans are in place to do so in the future.

== How VTI Connects with Twitch ==
The [[VTI Companion App]] connects with the Twitch through its [https://dev.twitch.tv/docs/ API]. Specifically, it utilizes the [https://dev.twitch.tv/docs/authentication/getting-tokens-oauth/ Implicit Grant Flow] method of authentication, which has been determined to be the safest method for both the developer and the end user. Unfortunately, this means that VTI will always pop up a browser window when beginning the Twitch connection as the credentials '''''are not stored''''' in the VTI Companion nor any of [[WaffleSlapper]]'s or [[Poetica Mechanica]]'s servers. This method also does not require the developer to use a Client Secret (required by other authentication methods) which can be used to cause harm if leaked through the [[VTI Companion App]]'s source code or any external service.

The [[VTI Companion App]] utilizes a customized version of the [https://github.com/SaviorXTanren/StreamingClientLibrary StreamingClientLibrary] by SaviorXTanren, which has been modified to enable the above [https://dev.twitch.tv/docs/authentication/getting-tokens-oauth/ Implicit Grant Flow]. You can view the source code for the fork [https://github.com/Steeveeo/StreamingClientLibrary here].