FS-DeathSystem
A death screen, configurable revive choices, low-health limp, and jump-landing stumble.
Start Here
- Start FS-Lib before the built FS-DeathSystem resource.
- Choose the allowed revive options and review the default death-screen wording.
- Confirm your server uses one owner for death/respawn handling.
Expected result: a dead player sees the death screen and allowed revive controls; after revival the camera and overlay clear. This guide reflects the current local 1.0.0 source.
Installation
Copy the built release folder, including nui/ and compiled Lua files, into your resources directory:
ensure FS-Lib
ensure FS-DeathSystemFS-Lib is required by the manifest and startup version check. A framework or database is not required. Stock spawnmanager compatibility is internal; avoid a competing death screen or respawn controller.
Configuration
Edit config.lua in the installed resource and restart after changes.
| Setting | Default | Meaning and when to change it |
|---|---|---|
EnableHealCommand | true | Enables /heal for living players. Disable if your server should not provide self-healing. |
AllowFieldRevive | true | Allows the in-place revive option. Disable when that choice does not fit your server. |
AllowGroundRevive | true | Allows revival while remaining on the ground. Disable to remove that choice. |
FieldReviveKey | E | Initial in-place revive key. Players can rebind it. |
GroundReviveKey | U | Initial ground-revive key. Players can rebind it. |
StandAfterGroundReviveKey | COMMA | Releases the ground-revive hold. Change the default only if needed. |
OverlayOpacity | 0.60 | Death-overlay darkness from 0 to 1. Lower for a clearer view. |
DeathCauseTitleChance | 0.70 | Chance to use a recognized cause's title pool. Set 0 for general titles only. |
EnableInjuredWalk | true | Enables the low-health walking animation. Disable to leave walks alone. |
LimpHealthPercent | 40 | Percentage of usable native health at which limping begins. At a 200 maximum, this means 140 native health. |
JumpLandingStumbleChance | 0.25 | Stumble chance after a jump, regardless of health. Set 0 to disable. |
All keys above are under Config. For example, disable self-healing and random jump stumbles:
Config.EnableHealCommand = false
Config.JumpLandingStumbleChance = 0.0Death titles
The shipped wording includes profanity and dark humor. Review it before player use. Each title has white lead text and red accent text; pools are general, weapon, melee, fall, vehicle, explosion, fire and drowning. Replace the existing general pool with your own text, for example:
Config.DeathTitles.general = {
{ lead = "Your story", accent = "is not over yet." },
}Missing cause pools fall back to general; an empty/invalid general pool falls back to “You're dead”. The title is selected once per death. Death-camera and revive timing are internal, not owner settings.
Usage
- On the death screen, use E for field revival or U for ground revival when allowed.
- After ground revival, press comma to release the held ragdoll and let GTA recover naturally.
- While living, /heal restores native health and clears blood when enabled. It does not bypass the death screen.
Revives restore full native health while preserving higher health caps. GTA still owns damage, regeneration, armor and critical hits. The script does not provide an injury-scoring or medical-treatment system.
Troubleshooting
A revive key does nothing
Check that its option is enabled and inspect the player's saved FiveM key binding. Default-key changes do not necessarily replace saved bindings.
The player respawns twice or another death screen appears
Check for another death/respawn controller. Only one should own that flow. The initial stock join spawn is allowed to finish.
Players revive when the resource restarts
That is intentional cleanup: stopping/restarting revives dead players at their current position with full health. Schedule updates accordingly.
An old injury export no longer works
Managed-health/injury exports were removed. When updating from that build, use a normal resource restart so its stop handler can restore native health settings. The remaining client export is documented below.
Advanced reference
exports['FS-DeathSystem']:RegisterWalkStyle('your_clipset_name')Register a known custom walk clipset so it can be restored after healing/revival. This is a client export. There is no server injury component in the current source.