🔫Morgue Robbery!

Installation Guide!

DEPENDENCIES

To ensure the xmmx_morguerob script functions properly, the following resources are required or recommended:

✅ Mandatory

Resource	Description
xmmx_bridge	Core dependency that handles targeting, item systems, notifications, and framework support. Required for this script to work. 🔗 Download from Keymaster or Free Version
Target System	This is implemented through xmmx_bridge and supports both "target" and "interact" modes. One of these must be installed (e.g., ox_target, qb-target, or interact).
bob74_ipl (or any IPL loader)	Needed to load the default GTA Coroners Office interior if your server does not load it by default.

🧪 Optional

Resource	Description
Minigame	Optional hacking minigame. Use either: - xmmx_circlesgame (included in this script), or - boii-chiphack for an external option. Configure via Minigame = "xmmx" or "boii" in config.lua.
Dispatch System	Optional police alert dispatch system. Configure dispatch events in client/editable.lua. Works with ps-dispatch, qs-dispatch, core-dispatch, or custom.

💡 Tip: All targeting and interaction logic is routed through xmmx_bridge, so you only need to configure one method ("target" or "interact") in config.lua.

---

CONFIG.LUA

This configuration file defines the core settings for the morgue robbery system, including interaction method, police requirements, loot rewards, NPC combat behavior, and locations. Carefully review each section and update values according to your server's needs.

🔄 General Settings

Key	Description
VersionCheck	Enables version check notifications (useful for updates).
Debug	Enables debug print statements and visual zones. Useful during development/testing.
Interaction	Chooses the targeting system: "target" (ox_target/qb-target) or "interact" (interact resource).
Distance	Distance (in meters) for interaction zones.

🎁 Rewards Configuration

Key	Description
RewardsAmt	Number of random rewards the player will receive from RewardItems.
RewardItems	A table of items and amounts that can be given when looting the reward crate. Values can be static or randomized (e.g. black_money).

🔧 Customize items with your own server’s item names.

🔧 Search Animation (Loot Crate)

Key	Description
SearchDict	Animation dictionary used while looting.
SearchClip	Animation clip name used during looting.
SearchFlag	Animation flag (determines behavior like movement restrictions).
SearchTime	Duration of animation and progress bar in milliseconds.

🧰 Locations & Entry Points

• MorgueFuseBox: Where the robbery starts.

• MorgueOutside: Outside entrance and player spawn point.

• MorgueInside: Inside exit and player spawn point.

Each location includes:

• Coords: Location of the interaction zone.

• Heading: Player facing direction when teleported or targeting.

• SpawnCoords/SpawnHeading: Player spawn locations when transitioning.

🕒 Robbery Requirements

Key	Description
CoolDown	Cooldown in minutes before the robbery can be triggered again.
PoliceAmt	Minimum police required online to start the robbery.
PoliceJobs	List of job names that qualify as police.

🧨 Hacking Configuration

Key	Description
HackItem	Item required to begin the robbery (e.g. "thermite").
HackItemRemove	Should the item be removed upon successful use? (true/false)
Minigame	Minigame used for hacking ("xmmx" or "boii").

🔥 Thermite Effect

Key	Description
ThermiteCoord	Coordinates and hint location used when placing thermite. Includes hint vector for UI/visual zones.

📰 News Alert Banner

Key	Description
UseNews	Enables the Weazel News breaking news banner for all players.
NewsWait	Delay in seconds after hacking before the banner displays.
NewsAlert	Text content of the news banner.
NewsTime	Duration in seconds the banner stays visible.
ToggleHud	Temporarily hides HUD/radar during banner display.

🥷 Combat Configuration

Defines behavior of defending NPCs during the robbery.

Key	Description
PedModel	Ped model used for security (e.g., "s_m_m_security_01").
NPCWeapon	Weapon assigned to the guard NPCs.
NPCAmmo	Amount of ammo per guard.
PedArmour	Armor value (0-100%).
PedAccuracy	Accuracy rating (0-100).
Range	AI range behavior: 0 = near, 1 = medium, etc.
Sight/Hear	How far the NPCs can see or hear players.
SecondWave	Enables a second wave of guards after looting begins.

📦 Morgue Crate Spawns

Morgue is a table of locations where reward crates and defending NPCs are spawned. Each entry includes:

• RewardModel: Object model used for the loot crate.

• RewardSpawn: Where the crate appears.

• NPC: List of coordinates where NPC guards spawn.

You can add more locations or remove ones you don’t need.

🌐 Localization

Locales defines all translatable strings and UI elements:

Key	Usage
"rob_start" to "nocops"	Messages displayed to players throughout the robbery process.
"searching"	Progress text while looting the crate.
"small_text"	Small text displayed on the news banner (e.g., city name).
"icon_color"	Color for icons in target/interact menus.
"hint_icon"	FontAwesome icon shown in item hint.
"item_hint"	Format string used for displaying required item hints (%s will be replaced with item label).

---

✅ Final Notes

• Always customize item names, job names, and coordinates for your own framework/setup.

• If using "interact", ensure the interact resource is installed and started properly.

• The config is modular and designed to be expanded—feel free to add more crate locations, NPCs, and rewards.