All resources

rsg-medic — Developer & Server Owner Docs#

Version 3.1.1 · Dependencies: rsg-core, rsg-inventory (optional rsg-society)

Contents#

  1. Files
  2. Death flow
  3. Medic actions
  4. Auto medic
  5. Events & callbacks
  6. Exports
  7. Items & data
  8. Security model
  9. How-tos
  10. Troubleshooting

1. Files#

FilePurpose
shared/config.luaAll gameplay settings (jobs, timers, items, prices, locations, auto medic)
server/sv_config.luaDiscord webhook URLs (server only)
server/server.luaDeath state, respawn, alerts, office menu, duty, supplies, stash, revive/treat, bandage, /revive. Defines the RSGMedic server table used by automedic.lua
server/automedic.lua/automedic command, payment, call tracking
server/automedic_webhooks.luaQueued Discord logging, SendAutomedicLog
server/versionchecker.luaGitHub version check
client/client.luaDeath detection, death screen + camera, office prompt, field menu, progress actions, NUI bridge
client/automedic.luaNPC doctor spawn, ride, dismount, treat, ride away
html/NUI (death screen, office, field menu, buy modal, movable panels)

No database tables — death state is stored in player metadata isdead.

2. Death flow#

  1. Client sees the live ped dead for 500 ms → rsg-medic:server:setDead.
  2. Server only accepts it if the ped's health is 0 server-side, then sets isdead = true and starts the timer.
  3. Death screen syncs remaining time and medic count every 15 s (rsg-medic:server:getDeathInfo).
  4. [G] sends an alert (cooldown Config.AlertCooldown) or, with no doctors on duty, runs /automedic.
  5. After Config.DeathTimer, [E] → rsg-medic:server:respawn: fee from cash then bank (free if neither covers it), revived at the nearest Config.Locations[].spawn.
  6. Logging in with isdead re-applies death.

3. Medic actions#

  • Office (hold [E] at point, medic jobs only): duty toggle, supplies (Config.Supplies, cash), stash medic_<id>, boss menu (Config.BossMenuEvent, boss grades).
  • Field menu (/medic, on duty): patients within Config.FieldRange.
  • Revive / treat: beginAction callback opens a server session → progress bar → finishAction re-checks timing, duty, distance and items. Revive uses one medical bag charge (Config.Revive.uses, stored in item info uses); treat consumes Config.Treat.item and heals to full. Both pay reward cash.
  • Bandage (anyone): using the item starts a server timer; bandageDone only heals if Config.Bandage.duration has passed.

4. Auto medic#

/automedic (while downed): checks active call (stale after ~arrival+leave+treat+90 s), cooldown per citizenid, on-duty medics vs MaxMedicsOnDuty, and funds. The client spawns the doctor; rsg-medic:automedic:server:treated revives in place (requires an active call and at least ReviveTime), then charges Cost in MoneyType.

5. Events & callbacks#

NameSideNotes
rsg-medic:client:revive (spawn?)clientRevive; optional vec4 respawn point. Also clear isdead on the server
rsg-medic:client:heal (amount)client-1 = full heal
rsg-medic:client:alert (coords)clientAlert blip for medics
rsg-medic:server:reviveInPlace (src)server-only (AddEventHandler)Revive a downed player where they are
rsg-medic:server:setDead / respawn / alert / toggleDuty / buy / openStash / finishAction / cancelAction / bandageDone / bandageCancelnetAll validated server-side
rsg-medic:server:getDeathInfo / getMenu / getPatients / beginActionrsg-core callbacks

Example — revive from another resource (server):

TriggerEvent('rsg-medic:server:reviveInPlace', targetSrc)

6. Exports#

exports['rsg-medic']:SendAutomedicLog(event, source, fields?, description?) (server) — event is a key of SvConfig.Webhooks.Events; fields is a list of { name, value, inline? }.

7. Items & data#

bandage (useable), tool_medicalbag (info { uses = n }). Definitions in installation/shared_items.lua.

8. Security model#

  • Never trusts client amounts, prices, items or targets: prices come from Config.Supplies, targets are re-checked for distance/state.
  • Job + duty checked on every medic event and callback; office actions require being within 5 m of a location.
  • Revive/treat/bandage are server-timed; respawn timer is server-side.
  • setDead requires a dead ped server-side.
  • Webhook URLs never reach clients.
  • Other scripts calling rsg-medic:client:revive must also set isdead = false on the server (or use reviveInPlace).

9. How-tos#

  • Add a doctor's office: append to Config.Locations with a unique id, point and spawn.
  • Change language: setr rsg:locale de in server.cfg.
  • Disable the NPC doctor: Config.AutoMedic.Enabled = false.
  • Free respawns: Config.RespawnFee = 0.

10. Troubleshooting#

ProblemFix
UI shows key namesCheck locales/*.json is valid JSON and rsg:locale is set with setr
No office promptYour job must be in Config.MedicJobs and you must be within 2 m of point
Death screen never appearsAnother death script is running; only one should handle death
Webhooks don't sendReplace CHANGE_ME URLs in server/sv_config.lua
/automedic says medics onlineRaise MaxMedicsOnDuty or set -1

rsg-reputation integration#

Config.Reputation = { Enabled, Action }. After a server-validated revive in the finish handler (patient dead, item used, distance checked), the server calls ApplyAction(src, 'revive') for the medic. No region is passed, so only honor changes. Skipped when rsg-reputation is not started.

Support the Project : https://rexshack.tebex.store/

<!-- BEGIN AUTO-REFERENCE (generated from the code; re-run the generator instead of editing by hand) -->

Technical reference#

Generated from the source of rsg-medic 3.1.1. Names, arguments and defaults below are read straight from the code.

Dependencies#

rsg-core, rsg-inventory

Configuration#

OptionDefaultNotes
Config.MedicJobs{ 'medic' }job names treated as medics
Config.RequireDutytruemedics must be on duty to use field actions / supplies
Config.DeathTimer300seconds before a downed player may respawn at the doctor
Config.RespawnFee25charged on hospital respawn (cash, then bank); 0 = free
Config.AlertCooldown60seconds between "call for a medic" alerts
Config.AlertBlipTime120seconds an alert blip stays on medics' maps
Config.DeathCamtablekeys (RedM control hashes)
Config.Enabledtrue
Config.Distance3.5
Config.MinDistance1.5
Config.MaxDistance8.0
Config.Sensitivity6.0
Config.Keystable
Config.ActionDistance3.0metres between medic and patient
Config.FieldRange10.0metres to list nearby patients in the field menu
Config.UiCommand'medicui'toggles UI move mode (drag panels by their header, double-click to reset)
Config.FieldCommand'medic'opens the field menu for on-duty medics
Config.Revivetable
Config.Treattable
Config.Bandagetableself-use bandage item for anyone
Config.Suppliestable
Config.MaxBuyAmount50
Config.Stash{ slots = 50, maxweight = 400000 }
Config.BossMenuEvent'rsg-society:client:openDesk'rsg-society client event opened for boss grades; receives the player's job name; nil to hide
Config.BlipSpriteblip_shop_doctor
Config.AlertBlipSpriteblip_ambient_companion
Config.Locationstable
Config.AutoMedictable
Config.Debugfalse
Config.Command'automedic'
Config.Cost50
Config.MoneyType'cash'
Config.Cooldown300
Config.MaxMedicsOnDuty0
Config.DoctorModel'u_m_m_rhddoctor_01'
Config.HorseModel'a_c_horse_kentuckysaddle_black'
Config.SpawnDistance80.0
Config.DismountDistance8.0
Config.ReviveDistance1.5
Config.DespawnDistance120.0
Config.RideSpeed3.0
Config.ReviveTime8000
Config.ArrivalTimeout90
Config.LeaveTimeout45
Config.ShowBliptrue
Config.Reputationtablersg-reputation integration (optional). Needs the rsg-reputation resource; does nothing when it is not started.
Config.Action'revive'

Exports#

Server

ExportArgumentsFile
SendAutomedicLog``server/automedic_webhooks.lua
-- example
local result = exports['rsg-medic']:SendAutomedicLog()

Callbacks#

CallbackSideArgumentsFile
rsg-medic:server:getDeathInfoserversrc, cbserver/server.lua
rsg-medic:server:getMenuserversrc, cb, locIdserver/server.lua
rsg-medic:server:getPatientsserversrc, cbserver/server.lua
rsg-medic:server:beginActionserversrc, cb, kind, targetserver/server.lua
-- client side
RSGCore.Functions.TriggerCallback('rsg-medic:server:getDeathInfo', function(result)
    -- use result
end)

Events#

Server events can be fired by any client, so every handler re-validates the player, the arguments and any permission, distance or cooldown on the server. Never add a reward to a handler without those checks.

EventSideArgumentsFile
rsg-medic:automedic:client:callDoctorclient``client/automedic.lua
rsg-medic:client:alertSentclientcooldownclient/client.lua
rsg-medic:client:reviveclientspawnclient/client.lua
rsg-medic:client:healclientamountclient/client.lua
RSGCore:Client:OnPlayerLoadedclient``client/client.lua
RSGCore:Client:OnJobUpdateclientjobclient/client.lua
RSGCore:Client:SetDutyclientdutyclient/client.lua
RSGCore:Client:OnPlayerUnloadclient``client/client.lua
rsg-medic:client:alertclientcoordsclient/client.lua
rsg-medic:client:useBandageclient``client/client.lua
rsg-medic:automedic:server:treatedserver``server/automedic.lua
rsg-medic:automedic:server:stageserverstageserver/automedic.lua
rsg-medic:automedic:server:finishedserver``server/automedic.lua
rsg-medic:server:setDeadserver``server/server.lua
rsg-medic:server:respawnserver``server/server.lua
rsg-medic:server:alertserver``server/server.lua
rsg-medic:server:toggleDutyserver``server/server.lua
rsg-medic:server:buyserveritem, amountserver/server.lua
rsg-medic:server:openStashserver``server/server.lua
rsg-medic:server:cancelActionserver``server/server.lua
rsg-medic:server:finishActionserver``server/server.lua
rsg-medic:server:bandageCancelserver``server/server.lua
rsg-medic:server:bandageDoneserver``server/server.lua
-- from a client script
TriggerServerEvent('rsg-medic:automedic:server:treated')
-- from a server script
TriggerClientEvent('rsg-medic:automedic:client:callDoctor', source)

Commands#

CommandNotesFile
/revivelocale('cmd_revive_help')server/server.lua

Locales#

Language files in locales/: de, el, en, es, fr, ja, nl, pl, pt-br, ro, ru. Set the language with setr rsg:locale "en".

<!-- END AUTO-REFERENCE -->