Minor wording changes to website how to use section
This commit is contained in:
parent
f808564b1f
commit
421c3ae99f
|
@ -28,15 +28,34 @@
|
||||||
<h3>How do I use it?</h3>
|
<h3>How do I use it?</h3>
|
||||||
<p>OSC Triggers doesn't <i>currently</i> have a user interface, but the configuration file is
|
<p>OSC Triggers doesn't <i>currently</i> have a user interface, but the configuration file is
|
||||||
designed to be as straightforward as possible with <a href="https://toml.io/en/">TOML</a>.
|
designed to be as straightforward as possible with <a href="https://toml.io/en/">TOML</a>.
|
||||||
Here's an example configuration file that will issue a keypress for the F24 key
|
Here's an example configuration file that will press the F7 key
|
||||||
when the user mutes themselves in VRChat:
|
when the you toggle mute in VRChat. Download the relevant file from below, unpack it somewhere safe, then save this alongside the executable as a
|
||||||
|
<code>config.toml</code> file:
|
||||||
|
|
||||||
<pre><code>[[mapping]]
|
<pre><code>[[mapping]]
|
||||||
event = "/avatar/parameters/MuteSelf"
|
event = "/avatar/parameters/MuteSelf"
|
||||||
key = "F24"</code></pre>
|
key = "F7"</code></pre>
|
||||||
|
|
||||||
|
You can define multiple mappings if you want to, for example, issue a keypress for each
|
||||||
|
unique value of a event. In this example, muting yourself will press F7, while unmuting
|
||||||
|
will press F8.
|
||||||
|
|
||||||
|
<pre><code>[[mapping]]
|
||||||
|
event = "/avatar/parameters/MuteSelf"
|
||||||
|
key = "F7"
|
||||||
|
value = 1
|
||||||
|
|
||||||
|
[[mapping]]
|
||||||
|
event = "/avatar/parameters/MuteSelf"
|
||||||
|
key = "F8"
|
||||||
|
value = 0</code></pre>
|
||||||
|
|
||||||
|
You can then run the executable file by double clicking it. It will run in the background
|
||||||
|
and listen for VRChat or another OSC program.</p><p>
|
||||||
|
|
||||||
The event is entirely dependant on the program you're using. You can see an example
|
The event is entirely dependant on the program you're using. You can see an example
|
||||||
list of VRChat OSC events <a href="https://raw.githubusercontent.com/vrchat-community/osc/main/files/avatar-parameters/configs/example-avatar-config.json">here</a>. Custom parameters can be added with some work in Unity.</p>
|
list of VRChat OSC events <a href="https://raw.githubusercontent.com/vrchat-community/osc/main/files/avatar-parameters/configs/example-avatar-config.json">here</a>. Custom parameters can be added with some work in Unity. Any alphanumeric key, and F keys 1-24 are
|
||||||
|
supported.</p>
|
||||||
|
|
||||||
<h3>Where can I download it?</h3>
|
<h3>Where can I download it?</h3>
|
||||||
<p>Downloads are available from <a href="https://github.com/gmemstr/osc-triggers/releases/latest">GitHub</a>. Be sure to download the file labelled with your operating system. If you know a bit of Rust, you can also build it yourself from
|
<p>Downloads are available from <a href="https://github.com/gmemstr/osc-triggers/releases/latest">GitHub</a>. Be sure to download the file labelled with your operating system. If you know a bit of Rust, you can also build it yourself from
|
||||||
|
|
Loading…
Reference in a new issue