[PAID] [MEGA UPDATE] MFPD-PoliceCompanion - EUP Support and SQUAD FORMATION!

MajorFivePD · July 29, 2024, 9:58am

Here’s the updated description with the latest information while preserving the image links and previews from the outdated version:

MFPD-PoliceCompanion

HOW IT WORKS:

The MFPD Police Companion resource is designed to enhance your in-game experience by providing responsive, realistic police companions. These companions inherit your full appearance (including hair color), mirror your current equipped weapon/components upon spawning, and are fully visible to nearby players. They remain non-aggressive to players, cops, and security guards, focusing only on hostile entities to avoid unexpected shootouts or fights.

Buy your Police Companion here!

Preview:

Some previews were compressed to less size to be able to be sent here, so ignore the quality loss, sorry.

Formation preview:

Your police companion will NOT attack any cop/security guard:

Companions Entering and Leaving your vehicle, They will look for free seats, if there are none anymore, they will follow on foot! (Remember: You can spawn up to 9!)

Overview

MFPD-PoliceCompanion provides AI police companions that inherit your appearance, equipment, and behavior. They follow you in configurable formations, assist in combat, and adapt to vehicles and targeting. Fully configurable via a single config.lua – all commands, keybinds, animations, props, spotlight tuning, AI stats, and translations are exposed there. Supports English, Portuguese (BR), French, German, and Spanish out of the box.

KEY FEATURES:

Companion Management:

Spawn/Dismiss/Stay/Formation Commands:
```
Config.SpawnCommand = 'mfpd'      -- Change to whatever you desire
Config.StopCompanion = 'stay'     -- Change to whatever you desire
Config.DismissCommand = 'bye'     -- Change to whatever you desire
```
- /mfpd – spawn up to 10 companions (limit configurable)
- /bye – dismiss all companions
- /stay – toggle hold position / resume following
- /pullcomp – instantly teleport all companions to your current location
- /compstatus – display active companion count and current state (following, aiming, deployed, etc.)
- /formation – open the NUI formation editor; positions saved per player and shared as named server-wide presets

If your ped dies, it will AUTOMATICALLY delete all of your companions, to avoid strange behaviors!

Formation and Movement:

Structured squad formations based on saved per-player offsets
Dynamic movement speed: companions match your walking/running/sprinting speed
Named formation presets shared across the whole server

Combat and Behavior:

Non-aggressive to players, cops, and security guards
Intelligent threat detection – prioritizes active hostiles with clear line-of-sight
Retaliation guard: ignores friendly groups even when damaged by them
Automatic re-arming and full weapon/attachment mirroring on spawn and after exiting vehicles
Flashlight auto-toggle at night when carrying a flashlight-equipped weapon

Aiming Support:

Press H (configurable) while aiming at an entity to lock all companions onto that target
Aim is never overridden by follow, combat, or world events while active – re-asserted every 200 ms (configurable)
If the target dies, aim mode cancels cleanly and companions return to formation with a notification
Blocked entirely when no valid entity is detected – shows a “No Target” notification and does nothing

Cease-Fire Mode:

/stp – companions raise weapons and aim at nearby threats but will not shoot, melee, or engage
Ideal for detainments, traffic stops, or any scenario requiring visible armed presence without lethal force

Deployment and Patrol:

/dep – deploy companions to autonomously patrol a radius around your position; type again to recall
Companions automatically disembark from vehicles when deployed
Patrol radius, minimum walk length, and rest time all configurable

Patrol Torch Animations (Synced):

/ptrfoot – equip on-foot companions with a synced torch animation, physical prop, and real spotlight beam
/ptrcar – equip in-vehicle companions with an in-vehicle torch patrol animation and prop
Type the command again to cancel – animation stops and props are fully removed on all clients
Companions automatically stow their weapon during the animation and have it restored when the command is canceled
Torch mode auto-transitions when the player enters or exits a vehicle (foot to car and back)
Props synced across all clients via server broadcast – every player in the session sees the torch
Stuck-prop detection: if the animation is interrupted by combat, props are cleaned up automatically on all clients

Vehicle Interaction:

Automatic boarding and disembarking to match the player
Seat assignment avoids conflicts and retries on configurable timeout
Left-behind detection: companions that miss boarding are teleported into the vehicle after a grace period
Weapon auto-equip on vehicle exit after a configurable delay so the exit animation fully finishes first

Appearance and Customization:

Full appearance inherit: face blend, skin, hair model and color (with highlights), eye color, overlays (0–12), clothing, and props
Female freemode support with smart parent-blend mapping for clearly feminine results
Night awareness: auto-enables weapon flashlights at night when applicable

Weapon Mirroring:

Copies every weapon the player carries with correct ammo – not just the selected one
Full attachment cloning: covers all flashlights, scopes, grips, suppressors, muzzles, magazines, and MK2 upgrades
Addon weapon support: add any server-side addon weapon spawn name to Config.AddonWeapons in config.lua – companions will automatically receive and mirror it with no code changes
Falls back to best available weapon automatically after vehicle exit or torch mode

Multilingual Notifications:

All in-game notifications fully translated: English, Portuguese (BR), French, German, and Spanish
Set Config.Language to 'en', 'pt', 'fr', 'de', or 'es' – one line change
Full translation table exposed in config.lua so you can edit any string or add your own language

Multiplayer Sync:

Server-side appearance cache stores the latest look for each companion (hair color included)
Join-time replay sends current companions’ appearances to new/returning players and after resource restarts
Robust timing: client handler retries resolving networked entities for several seconds
Pruning: cache entries removed on dismiss and when the owner disconnects

Configuration and Compatibility:

Single config file: every user-facing setting lives in config.lua
Frameworks: Standalone, ESX, or QBCore
Allowed Jobs (ESX/QBCore): configured via Config.ESX.AllowedJobs / Config.QBCore.AllowedJobs
Command names and keybinds: all configurable – players can also rebind keys in GTA Settings > Key Bindings
Addon weapons: add any server-side weapon spawn name to Config.AddonWeapons for full companion compatibility
PvP-friendly: companions won’t attack friendlies while normal PvP remains enabled
config.lua comments written in English, Portuguese (BR), French, German, and Spanish

HOW TO INSTALL:

Download and extract the “MFPD-PoliceCompanion” resource.
Place the resource folder into your server’s resources directory.
Add the following line to your server.cfg:
```
ensure MFPD-PoliceCompanion
```
Open config/config.lua and adjust all settings to your server.

Code is accessible	No - Config files only accessible
Subscription-based	No
-------------------------------------	----------------------------
Lines (approximately)	3000+
-------------------------------------	----------------------------
Requirements	N/A
-------------------------------------	----------------------------
Support	Yes
-------------------------------------	----------------------------

Any support related questions, bugs/errors found, contact me via DM here on the Forum.