From ada18c52db738208becc6522856a5b68b5df3379 Mon Sep 17 00:00:00 2001 From: nya <24845294+nyakowint@users.noreply.github.com> Date: Tue, 31 Oct 2023 18:30:13 -0400 Subject: [PATCH] Readme changes --- README.md | 32 +++++++++++++++----------------- 1 file changed, 15 insertions(+), 17 deletions(-) diff --git a/README.md b/README.md index 8dfa54a..51bb2f0 100644 --- a/README.md +++ b/README.md @@ -12,16 +12,15 @@ A personal plugin to make chatbox typing in VRChat easier for me. Inspired by th 1. [Follow the BepInEx install guide](https://docs.bepinex.dev/articles/user_guide/installation/index.html) into XSOverlay. 2. Download both the plugin DLL **and** `BepInEx.cfg` from [Releases](../../releases/latest) -3. **:bangbang: IMPORTANT :bangbang:**: Move `KeyboardOSC.dll` into `/BepInEx/plugins` folder, +3. **:bangbang:** Move `KeyboardOSC.dll` into `/BepInEx/plugins` folder, and `BepInEx.cfg` into `/BepInEx/config` folder. - **Make sure you have done the second part.** if you dont then you will have a quite useless plugin :L - or set it yourself: `HideManagerGameObject = true` 4. Start XSOverlay -5. If you did everything right you should have a message icon on the keyboard toolbar (right). \ -Click it. A bar should pop up above the keyboard. If not, move the - keyboard around and it should pop up. -6. congration you done it - - You may also want to disable XSO analytics while using the plugin, but that's up to you, i'm not the one getting error logs XD +5. You should have a message icon on the right side keyboard toolbar, press it. \ + A bar should pop up above the keyboard. If not, move the keyboard around and it should pop up. +7. Make sure you have OSC enabled in VRChat or the Chatbox mod for chillout +8. congration you done it ### Removing the plugin @@ -35,16 +34,17 @@ Use the following shortcut keys: | Shortcut Key | Function | ---------------- | -------- | TAB | Toggle silent msg (orange text) -| ESC | Clear current text | Backspace or Delete | Delete last character from right (bksp) or left (del) +| ESC | Clear current text | END | Clear last sent message (equivalent to pressing "Clear Chatbox" in radial menu) | INSERT | Replace current text with your last message | CTRL + C | Copy current text to clipboard | CTRL + V | Paste text from your clipboard -| CTRL + Backspace | Delete last word (this one is weird as holding ctrl doesnt actually mean -holding ctrl) | +| CTRL + Backspace | Delete last word (works very jankily) | | ENTER | Send message to the chatbox! +I cannot guarantee full functionality with the CVR chatbox mod, as this is built with VRChat's OSC routes in mind. They were identical last I checked. + ## Unplanned features - Any type of "now playing" feature. It's out of scope for the plugin lol @@ -54,9 +54,10 @@ holding ctrl) | - Positioning is still a little weird, especially if you scale the keyboard -Steam might not instantly detect XSOverlay as closed. Not a big deal but this is out of my control just so you know +- ~~Steam might not instantly detect XSOverlay as closed.~~ + - This was *not* a bie/plugin issue, Xiexe has since fixed this. woohoo -If you find any other issues create an issue so i can remember to try and fix it when i feel like it +If you have any other annoyances raise an issue and I might be able to fix it ## Build from source @@ -67,9 +68,6 @@ config. dll will be in `builds` folder (or moved to your plugins folder if you used debug and have XSO on your C drive loool) -## Why a mod for a vr overlay? - -* I like XSOverlay better than OVRTK. No, you _dont_ have to agree with me. -* Xiexe plate - of [feature requests](https://github.com/Xiexe/XSOverlay-Issue-Tracker/issues?q=is%3Aissue+is%3Aopen+label%3A"feature+req.") - is far too long for me to wait for it to be added. lol. +Why a mod for a vr overlay? +I like XSOverlay better than OVRTK. No, you _dont_ have to agree with me. +lol