Merge remote-tracking branch 'origin/main' into main

README.md

@@ -1,8 +1,39 @@
 # BulletGrabber
-u grab bulets
+***u grab bulets***
 
+## Description:
+Do you hate the feeling of just dropping all bullets to the ground and having to pick them up?
 
+Do you use Index and your thumb just hurts on limited ammo runs?
+
+Do you want to have Psychokinesis power?
+
+Boy, I have the thing for you!
+
+## Usage
+
+Just point the grab lasor to the bulet and grab it, all nearby bullets will start entering your palm.
+
+## Installation
+Requires: Deli 3.0
+1. Download the release `.deli` file
+2. Place the `.deli` file into your `Steam\steamapps\common\H3VR\Deli\mods` folder
+
+## Configurating:
+Open: `Steam\steamapps\common\H3VR\Deli\configs\osa.bulletgrabber.cfg` with a notepad to configure. 
+
+### HandMode
+You can choose if the hand should be able to use the grab.
+Valid options are: `both`, `left` or `right`.
+### BulletGrabMode
 Three modes of bullet grabbing:
-- "firstTheSame": Default. It picks up all bullets ot the selected tyope first, then (if needed) fill with the rest that is also compatible
-- "closest": It picks up bullets closest to you, disregarding the type
-- "onlyTheSame": Only picks up bullets of the same type
+- `firstTheSame`: Default. It picks up all bullets ot the selected type first, then (if needed) fill with the rest that is also compatible
+- `closest`: It picks up bullets closest to you, disregarding the type
+- `onlyTheSame`: Only picks up bullets of the same type
+
+### Delay
+Defines delay (in milliseconds) between each bullet grab.
+The lowest it can go is your frame time times two.
+
+### Range
+Defines range (in meters) of grab. Setting it higher than default will disable TnH scoring.