Skip to content

Commit 5c70706

Browse files
author
Release Automat
committed
Release 5.1.0
1 parent dbf3ecf commit 5c70706

5 files changed

Lines changed: 149 additions & 11 deletions

File tree

‎Packages/tlp.udonvoiceutils/Editor/UdonVoiceUtilsDefinitions.cs‎

Lines changed: 13 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,13 @@
1+
using TLP.UdonUtils.Editor;
2+
using UnityEditor;
3+
4+
namespace TLP.UdonVoiceUtils.Editor
5+
{
6+
[InitializeOnLoad]
7+
public class UdonVoiceUtilsDefinitions
8+
{
9+
static UdonVoiceUtilsDefinitions() {
10+
CustomDefinitionUtils.EnsureDefinitionsExist(typeof(UdonVoiceUtilsDefinitions), "TLP_UDONVOICEUTILS");
11+
}
12+
}
13+
}

‎Packages/tlp.udonvoiceutils/Editor/UdonVoiceUtilsDefinitions.cs.meta‎

Lines changed: 3 additions & 0 deletions
Some generated files are not rendered by default. Learn more about customizing how changed files appear on GitHub.

‎Packages/tlp.udonvoiceutils/README.md‎

Lines changed: 66 additions & 5 deletions
Original file line numberDiff line numberDiff line change
@@ -12,6 +12,12 @@
1212
* [Versioning](#versioning)
1313
* [Installation](#installation)
1414
* [Minimal scene setup](#minimal-scene-setup)
15+
* [Uninstall](#uninstall)
16+
* [Via Tools (recommended)](#via-tools-recommended)
17+
* [Manually via Filesystem](#manually-via-filesystem)
18+
* [Enable Debug Mode](#enable-debug-mode)
19+
* [Disable Debug Mode](#disable-debug-mode)
20+
* [Test Mode](#test-mode)
1521
* [Troubleshooting](#troubleshooting)
1622
* [Errors after installation](#errors-after-installation)
1723
* [*Something* is not working in the world](#something-is-not-working-in-the-world)
@@ -127,6 +133,60 @@ into account when integrating UVU into a VRChat world.**
127133
controller to create what you need. In addition, you can also create your own custom solutions that rely on UVU's
128134
audio overriding capabilities.
129135

136+
### Uninstall
137+
138+
#### Via Tools (recommended)
139+
140+
1. Remove TLP UdonUtils from your project via VCC or [ALCOM](https://vrc-get.anatawa12.com/alcom/)
141+
2. Go to **Edit > Project Settings > Player > Script Compilation** and remove `TLP_UDONVOICEUTILS` from the list
142+
3. You may also remove anything else starting with `TLP_`
143+
1. Only applies if you used other TLP packages or enabled debug/test mode
144+
145+
#### Manually via Filesystem
146+
147+
1. Remove the `Packages/tlp.udonvoiceutils` folder from your project
148+
2. Remove the following lines from `Packages/packages-lock.json`:
149+
```json
150+
"tlp.udonvoiceutils": {
151+
"version": "file:tlp.udonvoiceutils",
152+
"depth": 0,
153+
"source": "embedded",
154+
"dependencies": {}
155+
},
156+
```
157+
3. Remove in a similar fassion from the `Packages/vpm-manifest.json` if present in there
158+
4. In the Unity project go to **Edit > Project Settings > Player > Script Compilation** and remove `TLP_UDONVOICEUTILS` from the list
159+
5. You may also remove anything else starting with `TLP_`
160+
1. Only applies if you used other TLP packages or enabled debug/test mode
161+
162+
### Enable Debug Mode
163+
164+
> Disclaimer: There is no negative performance impact when debug mode is disabled
165+
> as the logging code is not compiled into builds.
166+
167+
Debug mode is disabled by default. When enabled it will log additional information to the console.
168+
This logging is quite excessive and should only be enabled for debugging purposes.
169+
If you see no debug logs in the console/log files, ensure that the
170+
171+
1. Go to **Edit > Project Settings > Player > Script Compilation** and add `TLP_DEBUG` to the list
172+
2. Find the `TLP_Logger` prefab in your scene
173+
3. Set to logging severity `Debug`, be default it is set to `Info`.
174+
175+
### Disable Debug Mode
176+
177+
1. Go to **Edit > Project Settings > Player > Script Compilation** and remove `TLP_DEBUG` from the list
178+
2. Find the `TLP_Logger` prefab in your scene and set to logging severity `Info` or higher
179+
180+
### Test Mode
181+
182+
Similar to debug mode, test mode is disabled by default but can be enabled
183+
by adding `TLP_UNIT_TESTING` to the list of script compilation symbols.
184+
185+
Test mode is intended to be used for unit testing and should not be enabled in production builds.
186+
It will enable certain workarounds for parts of the VRChat SDK that can not easily be mocked.
187+
188+
> Note: Releases of UdonUtils don't contain the unit tests used for development as they are not relevant for 99% of users.
189+
130190
## Troubleshooting
131191

132192
### Errors after installation
@@ -175,16 +235,17 @@ into account when integrating UVU into a VRChat world.**
175235
* [UdonSharp](https://udonsharp.docs.vrchat.com/)
176236
* [VRChat player audio API docs](https://docs.vrchat.com/docs/player-audio)
177237

178-
### [5.0.3] - 2026-04-09
238+
### [5.1.0] - 2026-04-25
179239

180-
#### ⚙️ Miscellaneous Tasks
240+
#### 🚀 Features
181241

182-
- Change MicModel field to public in MicActivation (#43)
183-
### [5.0.2] - 2026-04-03
242+
- *(Editor)* Add TLP_UDONVOICETILS define whenever UdonUtils is added to a project
184243

185244
#### ⚙️ Miscellaneous Tasks
186245

187-
- Make PrivacyChannelIds public, bump version to 5.0.2, and update README installation steps
246+
- *(PlayerAudioOverride)* Make PrivacyChannelIds public
247+
- Change MicModel field to public in MicActivation (#43)
248+
- Improve release automation
188249
### [5.0.1] - 2025-11-15
189250

190251
#### 🐛 Bug Fixes

‎Packages/tlp.udonvoiceutils/package.json‎

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -1,7 +1,7 @@
11
{
22
"name": "tlp.udonvoiceutils",
33
"displayName": "TLP UdonVoiceUtils",
4-
"version": "5.0.3",
4+
"version": "5.1.0",
55
"description": "Contains a collection of player voice related scripts/components for VRChat worlds.",
66
"gitDependencies": {},
77
"legacyFolders": {

‎README.md‎

Lines changed: 66 additions & 5 deletions
Original file line numberDiff line numberDiff line change
@@ -12,6 +12,12 @@
1212
* [Versioning](#versioning)
1313
* [Installation](#installation)
1414
* [Minimal scene setup](#minimal-scene-setup)
15+
* [Uninstall](#uninstall)
16+
* [Via Tools (recommended)](#via-tools-recommended)
17+
* [Manually via Filesystem](#manually-via-filesystem)
18+
* [Enable Debug Mode](#enable-debug-mode)
19+
* [Disable Debug Mode](#disable-debug-mode)
20+
* [Test Mode](#test-mode)
1521
* [Troubleshooting](#troubleshooting)
1622
* [Errors after installation](#errors-after-installation)
1723
* [*Something* is not working in the world](#something-is-not-working-in-the-world)
@@ -127,6 +133,60 @@ into account when integrating UVU into a VRChat world.**
127133
controller to create what you need. In addition, you can also create your own custom solutions that rely on UVU's
128134
audio overriding capabilities.
129135

136+
### Uninstall
137+
138+
#### Via Tools (recommended)
139+
140+
1. Remove TLP UdonUtils from your project via VCC or [ALCOM](https://vrc-get.anatawa12.com/alcom/)
141+
2. Go to **Edit > Project Settings > Player > Script Compilation** and remove `TLP_UDONVOICEUTILS` from the list
142+
3. You may also remove anything else starting with `TLP_`
143+
1. Only applies if you used other TLP packages or enabled debug/test mode
144+
145+
#### Manually via Filesystem
146+
147+
1. Remove the `Packages/tlp.udonvoiceutils` folder from your project
148+
2. Remove the following lines from `Packages/packages-lock.json`:
149+
```json
150+
"tlp.udonvoiceutils": {
151+
"version": "file:tlp.udonvoiceutils",
152+
"depth": 0,
153+
"source": "embedded",
154+
"dependencies": {}
155+
},
156+
```
157+
3. Remove in a similar fassion from the `Packages/vpm-manifest.json` if present in there
158+
4. In the Unity project go to **Edit > Project Settings > Player > Script Compilation** and remove `TLP_UDONVOICEUTILS` from the list
159+
5. You may also remove anything else starting with `TLP_`
160+
1. Only applies if you used other TLP packages or enabled debug/test mode
161+
162+
### Enable Debug Mode
163+
164+
> Disclaimer: There is no negative performance impact when debug mode is disabled
165+
> as the logging code is not compiled into builds.
166+
167+
Debug mode is disabled by default. When enabled it will log additional information to the console.
168+
This logging is quite excessive and should only be enabled for debugging purposes.
169+
If you see no debug logs in the console/log files, ensure that the
170+
171+
1. Go to **Edit > Project Settings > Player > Script Compilation** and add `TLP_DEBUG` to the list
172+
2. Find the `TLP_Logger` prefab in your scene
173+
3. Set to logging severity `Debug`, be default it is set to `Info`.
174+
175+
### Disable Debug Mode
176+
177+
1. Go to **Edit > Project Settings > Player > Script Compilation** and remove `TLP_DEBUG` from the list
178+
2. Find the `TLP_Logger` prefab in your scene and set to logging severity `Info` or higher
179+
180+
### Test Mode
181+
182+
Similar to debug mode, test mode is disabled by default but can be enabled
183+
by adding `TLP_UNIT_TESTING` to the list of script compilation symbols.
184+
185+
Test mode is intended to be used for unit testing and should not be enabled in production builds.
186+
It will enable certain workarounds for parts of the VRChat SDK that can not easily be mocked.
187+
188+
> Note: Releases of UdonUtils don't contain the unit tests used for development as they are not relevant for 99% of users.
189+
130190
## Troubleshooting
131191

132192
### Errors after installation
@@ -175,16 +235,17 @@ into account when integrating UVU into a VRChat world.**
175235
* [UdonSharp](https://udonsharp.docs.vrchat.com/)
176236
* [VRChat player audio API docs](https://docs.vrchat.com/docs/player-audio)
177237

178-
### [5.0.3] - 2026-04-09
238+
### [5.1.0] - 2026-04-25
179239

180-
#### ⚙️ Miscellaneous Tasks
240+
#### 🚀 Features
181241

182-
- Change MicModel field to public in MicActivation (#43)
183-
### [5.0.2] - 2026-04-03
242+
- *(Editor)* Add TLP_UDONVOICETILS define whenever UdonUtils is added to a project
184243

185244
#### ⚙️ Miscellaneous Tasks
186245

187-
- Make PrivacyChannelIds public, bump version to 5.0.2, and update README installation steps
246+
- *(PlayerAudioOverride)* Make PrivacyChannelIds public
247+
- Change MicModel field to public in MicActivation (#43)
248+
- Improve release automation
188249
### [5.0.1] - 2025-11-15
189250

190251
#### 🐛 Bug Fixes

0 commit comments

Comments
 (0)