VTI Function Overview - Revision history

Steeveeo: Fixed category marker.

2024-02-27T01:23:09Z

Fixed category marker.

← Older revision		Revision as of 01:23, 27 February 2024
Line 1:		Line 1:
	[Category:VTI]		[[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.		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.

Steeveeo: Added Category

2024-02-10T00:22:03Z

Added Category

← Older revision		Revision as of 00:22, 10 February 2024
Line 1:		Line 1:
			[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.		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.

Steeveeo at 02:24, 7 February 2024

2024-02-07T02:24:05Z

← Older revision		Revision as of 02:24, 7 February 2024
Line 12:		Line 12:

	== How VRChat Talks To The Companion ==		== 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 . For example:		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>		<syntaxhighlight lang="dmesg">2024.02.04 18:00:51 Log - [VAL] VTI_EVENT_RECEIVED\|7ed84988-73a9-4060-8b39-3752357f3025</syntaxhighlight>

Steeveeo at 02:23, 7 February 2024

2024-02-07T02:23:48Z

← Older revision		Revision as of 02:23, 7 February 2024
Line 14:		Line 14:
	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 . For example:		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 . 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.		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.

Steeveeo: /* How VRChat Talks To The Companion */

2024-02-07T02:23:27Z

How VRChat Talks To The Companion

← Older revision		Revision as of 02:23, 7 February 2024
Line 12:		Line 12:

	== How VRChat Talks To The Companion ==		== 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 inline>[VAL]</syntaxhighlight>~~. For example:		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 . 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.		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.

Steeveeo at 09:32, 6 February 2024

2024-02-06T09:32:57Z

← Older revision		Revision as of 09:32, 6 February 2024
Line 7:		Line 7:
	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.		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="C#" inline>localhost</syntaxhighlight> is not on the URL Whitelist.		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.		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.
Line 14:		Line 14:
	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 inline>[VAL]</syntaxhighlight>. For example:		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 inline>[VAL]</syntaxhighlight>. For example:

	<syntaxhighlight lang="C#">2024.02.04 18:00:51 Log - [VAL] VTI_EVENT_RECEIVED\|7ed84988-73a9-4060-8b39-3752357f3025</syntaxhighlight>		<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.		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.

Steeveeo at 09:32, 6 February 2024

2024-02-06T09:32:37Z

← Older revision		Revision as of 09:32, 6 February 2024
Line 7:		Line 7:
	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.		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.		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="C#" 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.		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.
Line 14:		Line 14:
	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 inline>[VAL]</syntaxhighlight>. For example:		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 inline>[VAL]</syntaxhighlight>. For example:

	<syntaxhighlight lang="~~kmsg~~">2024.02.04 18:00:51 Log - [VAL] VTI_EVENT_RECEIVED\|7ed84988-73a9-4060-8b39-3752357f3025</syntaxhighlight>		<syntaxhighlight lang="C#">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.		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.

Steeveeo at 09:32, 6 February 2024

2024-02-06T09:32:19Z

← Older revision		Revision as of 09:32, 6 February 2024
Line 7:		Line 7:
	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.		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 inline>localhost</syntaxhighlight> is not on the URL Whitelist.		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.		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.

Steeveeo at 09:31, 6 February 2024

2024-02-06T09:31:58Z

← Older revision		Revision as of 09:31, 6 February 2024
Line 14:		Line 14:
	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 inline>[VAL]</syntaxhighlight>. For example:		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 inline>[VAL]</syntaxhighlight>. For example:

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

Steeveeo: VRChat->VTI, and a note about RSL's delays.

2024-02-06T06:54:12Z

VRChat->VTI, and a note about RSL's delays.

← Older revision		Revision as of 06:54, 6 February 2024
Line 1:		Line 1:
	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.		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 ==		== Overview ==
Line 8:		Line 8:

	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 inline>localhost</syntaxhighlight> is not on the URL Whitelist.		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 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 ==		== 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 inline>[VAL]</syntaxhighlight>. For example:

			<syntaxhighlight>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 ==		== How VTI Connects with Twitch ==