From 6d8f7ba43b4a37e0550705236dfd299c851a2bff Mon Sep 17 00:00:00 2001
From: Administrator <delucecc@gmail.com>
Date: Fri, 21 Feb 2025 19:29:51 -0800
Subject: [PATCH] docs: update ngd-detector

---
 ngd-detector.md | 109 ++++++++++++++++++++++--------------------------
 1 file changed, 50 insertions(+), 59 deletions(-)

diff --git a/ngd-detector.md b/ngd-detector.md
index 5632e65..0799f05 100644
--- a/ngd-detector.md
+++ b/ngd-detector.md
@@ -2,7 +2,7 @@
 title: ngd-detector
 description: 
 published: true
-date: 2025-02-22T03:20:43.944Z
+date: 2025-02-22T03:29:49.638Z
 tags: 
 editor: markdown
 dateCreated: 2025-02-22T03:20:43.944Z
@@ -17,74 +17,65 @@ dateCreated: 2025-02-22T03:20:43.944Z
 
 ## Installation Steps
 
-1. **Install ngd-Bridge**  
+1. ### **Install ngd-Bridge**  
    Follow the guide to install ngd-Bridge [HERE](https://nemesisdocs.com/en/gettingstarted).
 
-2. **Install ngd-detector**  
+2. ### **Install ngd-detector**  
    Place `ngd-detector` into your **[ngd]** folder. This script must be started **after** `ngd-Bridge`.
 
-6. Add the items into your framework/inventory.
+6. ### **Configure Detectors**.
 <details>
-<summary><strong>Items List (OX)</strong> (Click to Expand)</summary>
+<summary><strong>Detector Config</strong> (Click to Expand)</summary>
 
+-- There are two different types on config options for detectors.
+- Config.PropDetectors will spawn in a prop and then have a configurable box zone over it.
+- Config.ZoneDetectors will just use a boxzone, so you can put it over existing props in the map.
+
+### See below for variables:
 ```lua
-  	['ngd_suspiciousnote'] = {
-		label = 'Suspicious Note',
-		weight = 0,
-		stack = false,
-		close = true,
-		description = ''
-	},
-		['ngd_fakeidtoken'] = {
-		label = 'A Token Of Trust',
-		weight = 0,
-		stack = false,
-		close = true,
-		description = ''
-	},
-		['ngd_pbsecurity'] = {
-		label = 'Forged Pillbox Security Card',
-		weight = 0,
-		stack = false,
-		close = true,
-		description = ''
-	},
-		['ngd_pbfreezerring'] = {
-		label = 'Mafia Family Ring',
-		weight = 0,
-		stack = false,
-		close = true,
-		description = ''
-	},
-```
-
-</details>
-<details>
-<summary><strong>Items List (QB Format #1)</strong> (Click to Expand)</summary>
-
-```lua
-    ngd_suspiciousnote            = { name = 'ngd_suspiciousnote', label = 'Suspicious Note', weight = 0, type = 'item', image = 'ngd_suspiciousnote.png', unique = true, useable = true, shouldClose = false, combinable = nil, description = '' },
-    ngd_fakeidtoken               = { name = 'ngd_fakeidtoken', label = 'A Token Of Trust', weight = 0, type = 'item', image = 'ngd_fakeidtoken.png', unique = false, useable = false, shouldClose = false, combinable = nil, description = '' },
-    ngd_pbsecurity                = { name = 'ngd_pbsecurity', label = 'Forged Pillbox Security Card', weight = 0, type = 'item', image = 'ngd_pbsecurity.png', unique = false, useable = false, shouldClose = false, combinable = nil, description = '' },
-    ngd_pbfreezerring             = { name = 'ngd_pbfreezerring', label = 'Mafia Family Ring', weight = 0, type = 'item', image = 'ngd_pbfreezerring.png', unique = false, useable = false, shouldClose = false, combinable = nil, description = '' },
-
-
-    
-```
-
-</details>
-<details>
-<summary><strong>Items List (QB Format #2)</strong> (Click to Expand)</summary>
-
-```lua
-    ['ngd_suspiciousnote']        = { ['name'] = 'ngd_suspiciousnote', ['label'] = 'Suspicious Note', ['weight'] = 0, ['type'] = 'item', ['image'] = 'ngd_suspiciousnote.png', ['unique'] = true, ['useable'] = true, ['shouldClose'] = false, ['combinable'] = nil, ['description'] = '' },
-    ['ngd_fakeidtoken']           = { ['name'] = 'ngd_fakeidtoken', ['label'] = 'A Token Of Trust', ['weight'] = 0, ['type'] = 'item', ['image'] = 'ngd_fakeidtoken.png', ['unique'] = false, ['useable'] = false, ['shouldClose'] = false, ['combinable'] = nil, ['description'] = '' },
-    ['ngd_pbsecurity']            = { ['name'] = 'ngd_pbsecurity', ['label'] = 'Forged Pillbox Security Card', ['weight'] = 0, ['type'] = 'item', ['image'] = 'ngd_pbsecurity.png', ['unique'] = false, ['useable'] = false, ['shouldClose'] = false, ['combinable'] = nil, ['description'] = '' },
-    ['ngd_pbfreezerring']         = { ['name'] = 'ngd_pbfreezerring', ['label'] = 'Mafia Family Ring', ['weight'] = 0, ['type'] = 'item', ['image'] = 'ngd_pbfreezerring.png', ['unique'] = false, ['useable'] = false, ['shouldClose'] = false, ['combinable'] = nil, ['description'] = '' },
-
+--Prop Detectors 
+Config.PropDetectors = {
+    [1] = {
+        Coords = vector4(-540.8, -208.84, 37.65, 178.55), -- Coords of the prop
+        Prop = 'ngd_detector', -- Prop Name
+        BeepDistance = 8, -- Distance the detector alarm can be heard
+        Zone = {
+            Coords = vector3(-546.63, -201.32, 38.23), -- Coords of the boxzone
+            Size = vector3(1, 1, 2), -- Size of the boxzone
+            Rotation = 210, -- Heading of the boxzone
+        },
+        DetectItems = {
+            'weapon_pistol', -- Item 'strings' that can be detected
+            'weapon_smg'
+        },
+        Sounds = {
+            SoundSet = 'HUD_MINI_GAME_SOUNDSET', -- GTA Soundset
+            SoundName = 'CHECKPOINT_MISSED' -- GTA Soundname
+        },
+        IgnoreJobs = {
+            Enabled = false, -- If true, the detector won't beep for the jobs below
+            Jobs = {
+                'police', -- Job 'name'
+                'taxi'
+            }
+        },
+        Notify = {
+            Enabled = true, -- If true, will send notifications to the jobs below
+            Job = {
+                'police', -- Job 'name'
+                'taxi'
+            },
+            Range = 20, -- Range that script will send notifications (such as a security system inside of a building)
+            Name = 'City Hall Front Door' -- Name of detector to show up in notification
+        }
+    }
+}
+  
+-- Config.ZoneDetectors have the same exact config, minus the prop logic.
 ```
 </details>
 
+
 ---
 
 # Configuration Notes