Merge branch 'master' of https://github.com/killaketa/CS2-DamageMod

Author: killaketa

.github/workflows/dotnet.yml

@@ -0,0 +1,38 @@
+# This workflow will build a .NET project
+# For more information see: https://docs.github.com/en/actions/automating-builds-and-tests/building-and-testing-net
+
+name: .NET
+
+on:
+  push:
+    branches: [ "master" ]
+  pull_request:
+    branches: [ "master" ]
+
+jobs:
+  build:
+
+    runs-on: ubuntu-latest
+
+    steps:
+    - uses: actions/checkout@v4
+    - name: Setup .NET
+      uses: actions/setup-dotnet@v4
+      with:
+        dotnet-version: 8.0.x
+    - name: Restore dependencies
+      run: dotnet restore
+    - name: Build
+      run: dotnet build --no-restore
+    - name: Test
+      run: dotnet test --no-build --verbosity normal           
+    - name: Upload a Build Artifact
+      uses: actions/[email protected]
+      with:
+        path: DamageMod/
+        # The desired behavior if no files are found using the provided path.
+              
+          
+          
+
+

README.md

@@ -1,8 +1,41 @@
 # CS2 DamageMod
 Modify hitgroups to be enabled/disabled.
 
+## Requirements
+A [CounterStrikeSharp](https://github.com/roflmuffin/CounterStrikeSharp) & [MetaMod:Source](https://www.sourcemm.net/) installation on your server.
+
+## Installation
+1. Download from Releases/Artifacts or compile yourself.
+2. Open root of CS2 installation on server.
+3. Copy DamageMod folder from the zip into `game/csgo/addons/counterstrikesharp/plugins` on server.
+
+## Configuration
+
 Config allows you to enable/disable and change damage multiplier on individual hitgroups.
+```json
+    "HITGROUP_HEAD": {
+      "Enabled": true,
+      "DamageMultiplier": 0.25
+    },
+    "HITGROUP_CHEST": {
+      "Enabled": false,
+      "DamageMultiplier": 1
+    },
 ```
-"HITGROUP_HEAD" = [true, 2]
-```
-This modifies allows damage to the head hitgroup & multipies all damage to the head hitgroup by 2.
+This modifies allows damage to the head hitgroup & multipies all damage to the head hitgroup by 0.25 (divided by 4).\
+It also disables the chest hitgroup, disabling all damage to the chest even though the multiplier is 1.
+
+## Hitgroup Meanings
+
+| Hitgroup | Meaning |
+| --- | --- |
+| HITGROUP_GENERIC | Knife Damage (Also triggers when shooting a wall or prop like glass) |
+| HITGROUP_INVALID | Fall Damage (Potentially hazards too) |
+| HITGROUP_HEAD & HITGROUP_NECK | Headshot Damage |
+| HITGROUP_CHEST | Upper Chest Damage |
+| HITGROUP_STOMACH | Lower Chest Damage |
+| HITGROUP_RIGHTARM & HITGROUP_LEFTARM | Right/Left Arm Damage |
+| HITGROUP_RIGHTLEG & HITGROUP_LEFTLEG | Right/Left Leg Damage |
+| HITGROUP_GEAR, HITGROUP_COUNT, HITGROUP_SPECIAL, & HITGROUP_UNUSED | Unknown/Unused(?) |
+
+If you find anything wrong with these descriptions or the plugin feel free to open a pull request or issue.