Merge branch 'master' of https://github.com/whateverusername0/VRTRAKILL

README.md

@@ -1,5 +1,5 @@
 # VRTRAKILL
-[Installation](https://github.com/whateverusername0/VRTRAKILL#installing-vrtrakill-in-less-than-10-steps) | [Common problems](https://github.com/whateverusername0/VRTRAKILL#common-issues) | [Default controller bindings](https://github.com/whateverusername0/VRTRAKILL#default-controller-bindings)
+[Installation](https://github.com/whateverusername0/VRTRAKILL#installation) | [Common problems](https://github.com/whateverusername0/VRTRAKILL#common-issues) | [Default controller bindings](https://github.com/whateverusername0/VRTRAKILL#default-controller-bindings)
 
 [![](https://img.shields.io/github/downloads/whateverusername0/VRTRAKILL/total)](https://github.com/whateverusername0/VRTRAKILL/releases)
 [![](https://img.shields.io/github/downloads/whateverusername0/VRTRAKILL/latest/total)](https://github.com/whateverusername0/VRTRAKILL/releases)
@@ -15,39 +15,48 @@ Also it does not require any other mods to function.
 
 ## Features
 ### What works right now:
-- Camera, HUD, Crosshair, UI Interaction
-- Full movement (jump, dash, slide, slam storage, rocket ride, etc.)
-- Full controller tracking (aiming / shooting, punching)
-- Controller haptics (vibrations) (CRumble-based) (nobody uses it for some reason)
-- Weapon swap, weapon scroll using joystick, weapon wheel
+It'll be much easier to describe what **doesn't** work.
+### What doesn't work right now:
+- Controller-based UI interaction.
+- Accessibility stuff. (left-handed mode, something else, blabla)
+- 5-S.
+- 4-S.
+- VRAvatar's legs.
 ### Planned stuff:
-**1.0**: Full release (when i think that nothing more can be done)
+**1.0**: Full release (when i think that nothing more can be done)  
+**1.x.x**: Mods compatibility (JAKET, ultraballing, etc.) (angry level loader works) (dab me up ![xzxADIxzx](https://github.com/xzxADIxzx))  
+**Future**: Maintenance updates  
 
 ## Requirements
-- A copy of the latest version of ULTRAKILL (any kind)
-- A VR compatible PC w/ SteamVR installed
-- Any PCVR compatible headset
+- A copy of the latest version of ULTRAKILL (doesn't matter which one)
+- Any SteamVR compatible PC & headset.
 
-## Installing VRTRAKILL in less than 10 steps
-VRTRAKILL Installation tutorial [here](https://www.youtube.com/watch?v=FcTysn8jwFQ) (@guesty5060 you're welcome)
+## Installation
+VRTRAKILL Installation tutorial [here](https://www.youtube.com/watch?v=FcTysn8jwFQ) (@guesty5060 you're welcome) (might already be outdated, see text guide)
 
 The text version:
 1. Make a copy of ULTRAKILL so you can safely mod that version without affecting your normal game:  
   1.1 Locate ULTRAKILL in your Steam library (or wherever you store it)  
   1.2 RMB -> Manage -> Browse local files  
   1.3 Make a copy of the ULTRAKILL folder and put it somewhere  
 2. Get & Install [latest stable (at the moment) BepInEx 5.4.21](https://github.com/BepInEx/BepInEx/releases/tag/v5.4.21) that **matches your CPU architecture** into the new ULTRAKILL folder using [their guide](https://github.com/BepInEx/BepInEx/wiki/Installation). Make sure to run BepInEx'ed ULTRAKILL at least once so it can generate needed folders & files  
-3. Download one of [releases](https://github.com/whateverusername0/VRTRAKILL/releases), unarchive and merge both ULTRAKILL folders  
+3. Download one of [releases](https://github.com/whateverusername0/VRTRAKILL/releases), unarchive and merge both ULTRAKILL folders.
+
+The steps 4-6 are actually unnecessary, since you can launch the game from it's original .exe and SteamVR will catch up, but for your own convenience you can follow them.
+
 4. Add the modded ULTRAKILL as a 'non-steam game' to steam so it can be run with SteamVR:  
   4.1 ADD A GAME (at the bottom left in library) -> Add a non-steam game -> select your VR-ed ULTRAKILL.exe  
   4.2 Right click on the new VR-ed ULTRAKILL in your steam library -> Properties -> Shortcut -> Include in VR Library  
 5. Open SteamVR  
 6. Select your VR-ed ULTRAKILL  
-7. Run it once, wait for the error message to appear in the console and then exit  
+
+Now **these** steps **are necessary**.
+
+7. Run it once, wait for the error message "*unable to find config file, generating a new one*" to appear in the console then exit  
 8. Go to BepInEx/plugins, open VRTRAKILL_Config.json and set your preferences there. **Make sure you have the same keybinds both in config and in ULTRAKILL**  
 9. Run VR-ed ULTRAKILL again  
 
-## Build VRTRAKILL from source
+## Building from source
 Building from source video tutorial [here](https://www.youtube.com/watch?v=h1rS-p7aFFo) (@jackietanuki you're welcome)
 
 The text version:
@@ -64,16 +73,16 @@ The text version:
 ## Common issues:
 1. Your gun is too big (or "twice the size of your head"):  
   - Solution: If you have SteamVR world size tweaked - disable it. If you set your weapon position to the middle - set it to the right. Else open an issue, because this shouldn't be happening :(  
-2. On Valve Index you move too slowly and can't jump normally:  
-  - Solution: In config there's an option "Do not override movement values". Enable it and launch the game again and see if it worked.
-  - Solution 2 (applies to **all** devices): Try to lower the refresh rate of your headset.
-3. Awful/missing HTC Vive, Index, etc. controller bindings:
-  - Since I don't have those controllers you gotta make your own. It's pretty simple, there's no cryptic words in actions' names.
+2. On Valve Index you move too slowly and can't jump normally:
+  - For this in the config there is a setting "movement multiplier". Since the game has a really goofy movement logic, you need to set your own multiplier there depending on your headset refresh rate.
+3. "There's no controller bindings for my BICO 3.0"
+  - You gotta make your own. It's pretty simple, there's no cryptic words in actions' names.
   - Also if you wanna help you can send me your controller bindings via discord or whatever and I'll set them as defaults so no more people have to suffer.
 4. OverflowException when launching the game:
   - Get an already patched version of globalgamemanagers from [releases](https://github.com/whateverusername0/VRTRAKILL/releases) and paste it in your ULTRAKILL_Data folder, after that delete the VRPatcher from BepInEx/patchers
 5. Literally any other problem, or recommendations to fixing them yourself:
   - If you have other mods enabled (like ultraballing, middle finger or sniper rifle), try disabling/removing them and see if things work.
+  - UPDATE: ULTRATWEAKER breaks the final ranking screen. If you have it enabled, disable it.
 
 ## Default controller bindings:
 ### Oculus Touch (made in MSPaint by me):