diff --git a/website/index.html b/website/index.html index 76b1c06..8b84fe2 100644 --- a/website/index.html +++ b/website/index.html @@ -28,15 +28,34 @@
OSC Triggers doesn't currently have a user interface, but the configuration file is
designed to be as straightforward as possible with TOML.
- Here's an example configuration file that will issue a keypress for the F24 key
- when the user mutes themselves in VRChat:
+ Here's an example configuration file that will press the F7 key
+ 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
+ config.toml
file:
[[mapping]]
event = "/avatar/parameters/MuteSelf"
-key = "F24"
+key = "F7"
+
+ 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.
+
+ [[mapping]]
+event = "/avatar/parameters/MuteSelf"
+key = "F7"
+value = 1
+
+[[mapping]]
+event = "/avatar/parameters/MuteSelf"
+key = "F8"
+ value = 0
+
+ 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.The event is entirely dependant on the program you're using. You can see an example - list of VRChat OSC events here. Custom parameters can be added with some work in Unity.
+ list of VRChat OSC events here. Custom parameters can be added with some work in Unity. Any alphanumeric key, and F keys 1-24 are + supported.Downloads are available from GitHub. 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