v2.3.0

Additions:

• GetPostProcessingEffectStateList method.
• SetPostProcessingEffectValues method.
• SubscribeToPostProcessingEvent method.

The above methods all have async variants, as well.

Updates:

• Updated Hotkey definitions.

v2.2.1

Additions:

• RequestPermission method.

• PinItemToCenter method.

• PinItemToRandom method;

• PinItemToPoint method;

• UnpinItem method.

• SubscribeToItemEvent method.

• SubscribeToModelClickedEvent method.

The above methods all have async variants, as well.

Updates:

• Added support for loading Custom Data items via LoadCustomDataItem method.
• Added a suite of pure-C# examples courtesy of @HugoVG!

Also available via NuGet package manager!

v2.1.0

Additions:

• Full support for async and await on all API and Event methods (as well as Initialize) graciously contributed by @yutamago. This adheres more closely to modern C# standards.
• A "Non-Unity"/Core example plugin.
• The ability to generate NuGet packages, which have been asked for quite a bit (also contributed by @yutamago).
• SubscribeToHotkeyTriggeredEvent method.
• SubscribeToModelAnimationEvent method.

Updates:

• Updated Hotkey Action definitions.

Also available via NuGet package manager!

v2.0.1

This patch fixes:

• Unity Color conversion helper method being present in Core library (this method now exists in the UnityVTSPlugin class).
• PluginAuthor accessor mistakenly pointing to the PluginName string in the CoreVTSPlugin class.

Thank you to @Ryokune for catching both of these mistakes!

v2.0.0

This release is a major version increment. From here on out, this library not only supports Unity development, but general C# development out-of-the-box.

To accomplish this, several minor but breaking changes needed to occur in order to decouple the library from Unity-specific code. As such, please be sure to read the guide on how to migrate from a 1.x.x version to a 2.x.x version! Thank you!

Updates:

• Splitting of the plugin class into a pure C# implementation and a Unity-specific wrapper. This change will allow for plugins to be built in any C# runtime environment from .NET 2.0 onward, while preserving Unity functionality as developers have come to expect.
• Adds the Newtonsoft JSON library for enhanced/non-Unity JSON operations. The previous implementation was dependent on a Unity class.

v1.8.0

Updates:

• Intelligent port selection on connect. If the plugin cannot connect to the specified port, it will attempt to connect to the first port discovered by UDP. If that times out, then it will finally attempt to connect to the VTube Studio default port, 8001.
• Fixed several message type typos.

v1.7.1

Additions:

• SetIPAddress method on the VTSPlugin class. Takes in an IPv4 string.

Updates:

• Updated Error ID definitions.
• Updated Hotkey Action definitions.
• Fixed typo in the ModelConfigChanged Event and ModelMoved Event subscription methods.

v1.7.0

This update adds support for the new VTube Studio Events API, available in Vtube Studio Version 1.22.0 and onward.

New additions:

• RequestArtMeshSelection method.
• SubscribeTo and UnsubscribeFrom methods for all Events in the new VTube Studio Event API.

Updates:

• Stability of WebSocketSharp with latest version of the depencency.
• Disconnect method on the VSTPlugin class.
• Updated Error ID definitions.
• Updated Hotkey Action definitions.
• Example scene/plugin now has a demo for several Event Subscription functions.

For detailed information about all the new functions, please consult the official VTube Studio API and Event API.

v1.7.0-beta

This version of the library adds support for the VTube Studio Event Subscription API, which is available in VTube Studio version 1.21.26 and onward.

New additions:

• SubscribeToTestEvent method.
• UnsubscribeFromTestEvent method.
• SubscribeToModelLoadEvent method.
• UnsubscribeFromModelLoadEvent method.
• UnsubscribeFromAllEvents method.

For detailed information about all the new functions, please consult the official VTube Studio Event API.

v1.6.1

This version of the library adds support for the VTube Studio Item API, which is available in VTube Studio version 1.21.5 and onward.

New additions:

• GetItemList method.
• LoadItem method.
• UnloadItem method.
• AnimateItem method.
• MoveItem method.
• GetHotkeysInLive2DItem method.
• TriggerHotkeyForLive2DItem method.

Updates:

• InjectParameterValues function now supports an optional VTSInjectParameterMode mode value to make the injected values either apply additively or to set absolutely. Default behavior is to set absolutely.
• InjectParameterValues function now supports an optional bool faceFound value (for real this time) which can manually be set to true to tell VTube Studio to consider the user face as found, no matter what. This allows you to control when the "tracking lost" animation is or isn't played. Default behavior of false defers the assessment to VTube Studio.
• Updated Error ID definitions.
• Updated Hotkey Action definitions.
• Example scene/plugin now has a demo for several Item functions.

For detailed information about all the new functions, please consult the official VTube Studio API.