OSC: Difference between revisions
From VRChat Wiki
Comfy Chloe (talk | contribs) m →OSCQuery: "editors who believe they may have even a minor COI should disclose the details in the edit summary": Additional implementation of OSC-Query using javascript. - I created it for my own project, It is public readable code with no-intent to promote, Explictly to grant access to users who may need a Javascript implementation of OSC-Query for their own needs. - Following full CoI and NPOV policys. |
m Fix typos and style |
||
| Line 1: | Line 1: | ||
{{Noticebox/Official}}{{Stub|Not much information here! You can [[VRCWiki:How to contribute|contribute]] by expanding, and proofreading this article, in accordance with the [[VRCWiki:Manual of Style|Manual of Style]].}} | {{Noticebox/Official}}{{Stub|Not much information here! You can [[VRCWiki:How to contribute|contribute]] by expanding, and proofreading this article, in accordance with the [[VRCWiki:Manual of Style|Manual of Style]].}} | ||
[[File:OSC_Keyart.png|thumb|300x300px]] | [[File:OSC_Keyart.png|thumb|300x300px]] | ||
[https://opensoundcontrol.stanford.edu/index.html OSC] is a way to get different devices and applications to talk to each other. VRChat announced on February 16th 2022 OSC for | [https://opensoundcontrol.stanford.edu/index.html '''OSC'''] is a way to get different devices and applications to talk to each other. VRChat announced on February 16th 2022 OSC for avatars<ref>https://hello.vrchat.com/blog/vrchat-osc-for-avatars</ref>. Most commonly used to have body-, eye- and face trackers communicate with [[Special:MyLanguage/VRChat|VRChat]]. | ||
==OSCQuery== | ==OSCQuery== | ||
[https://github.com/Vidvox/OSCQueryProposal OSCQuery] is a protocol to connect OSC applications together easier. Information on how to [https://github.com/vrchat-community/osc/wiki/OSCQuery | [https://github.com/Vidvox/OSCQueryProposal OSCQuery] is a protocol to connect OSC applications together easier. Information on how to connect with VRChat with OSCQuery is available on the [https://github.com/vrchat-community/osc/wiki/OSCQuery VRChat OSCQuery GitHub Wiki]. VRChat also provides [https://github.com/vrchat-community/vrc-oscquery-lib a C# library on GitHub]. | ||
Some of the community made OSCQuery libraries: | |||
* JavaScript implementation without example scripts on GitHub - [https://github.com/ComfyChloe/OSC-Query-JS OSC-Query-JS]. | |||
* TypeScript with example scripts on GitHub by [[User:Usr ddac2cc8-81dc-41c7-95c6-7aa7c81a783f|Jangxx]] - [https://github.com/jangxx/node-oscquery node-oscquery]. | |||
* Python with examples on the GitHub readme.md - [https://github.com/theepicsnail/vrchat_oscquery vrchat_oscquery]. An older variant also more descriptive - [https://github.com/cyberkitsune/tinyoscquery tinyoscquery]. | |||
* Rust implementation with baseline functionally - [https://lib.rs/crates/oscquery oscquery]. | |||
== OSC feature set == | |||
OSC Can control a multitude of things within VRChat, While primarily focused around avatars OSC has the ability to modify/control some features such as control of the [[Camera Dolly]] check out the implementation on the [[Camera Dolly#OSC integration|Dolly's OSC Integration]] page. | |||
Access to user parameters such as "avatar/parameter/voice" sending the value back as a float 1 will unmute your microphone, a float of 0 will mute you. | |||
Chatbox input can be accessed under "/chatbox/input". | |||
Chatbox input can be accessed under | |||
==Resources== | ==Resources== | ||
[https://github.com/Vidvox/OSCQueryProposal Full OSCQuery proposal] and how it functions while including example code | * [https://docs.vrchat.com/docs/osc-overview OSC Overview] on the VRChat Documentation | ||
* [https://github.com/Vidvox/OSCQueryProposal Full OSCQuery proposal] and how it functions while including example code | |||
==References== | ==References== | ||
{{reflist}} | {{reflist}} | ||
[[Category:Features]] | [[Category:Features]] | ||
Revision as of 20:09, 19 September 2025
It is reviewed and approved by the VRCWiki Team. Learn how to contribute to this page by reading the Contribution Guide.
You can help the VRChat Wiki by improving it.
[Reason: Not much information here! You can contribute by expanding, and proofreading this article, in accordance with the Manual of Style.]
[Reason: Not much information here! You can contribute by expanding, and proofreading this article, in accordance with the Manual of Style.]
OSC is a way to get different devices and applications to talk to each other. VRChat announced on February 16th 2022 OSC for avatars[1]. Most commonly used to have body-, eye- and face trackers communicate with VRChat.
OSCQuery
OSCQuery is a protocol to connect OSC applications together easier. Information on how to connect with VRChat with OSCQuery is available on the VRChat OSCQuery GitHub Wiki. VRChat also provides a C# library on GitHub.
Some of the community made OSCQuery libraries:
- JavaScript implementation without example scripts on GitHub - OSC-Query-JS.
- TypeScript with example scripts on GitHub by Jangxx - node-oscquery.
- Python with examples on the GitHub readme.md - vrchat_oscquery. An older variant also more descriptive - tinyoscquery.
- Rust implementation with baseline functionally - oscquery.
OSC feature set
OSC Can control a multitude of things within VRChat, While primarily focused around avatars OSC has the ability to modify/control some features such as control of the Camera Dolly check out the implementation on the Dolly's OSC Integration page.
Access to user parameters such as "avatar/parameter/voice" sending the value back as a float 1 will unmute your microphone, a float of 0 will mute you.
Chatbox input can be accessed under "/chatbox/input".
Resources
- OSC Overview on the VRChat Documentation
- Full OSCQuery proposal and how it functions while including example code
