Installation

Guide to install the HighQez Crawl Dead

Important Steps to Follow

The most important part of this installation is to edit the required resource that enables it to run on your server without any issues

Ensure that you complete the following task before testing the resource

• Required Resource Adjustments

---

Download Resource

Purchase the script from our HighQez Store. After the purchase, the resource will be available in your Keymaster Account

Make sure you purchase the script using the same Keymaster Account that is linked to your server. If not you will receive a warning "You lack the required entitlement".

If you receive the error mentioned above, you may have to transfer the resource from the current Keymaster account to the server's Keymaster account using the transfer feature in Keymaster.

---

Transfer Resource

Unzip the downloaded file and transfer it to your server's resource folder

If you are using FTP, please ensure you use WinSCP to transfer the resource to the server. If you use FileZilla, you may encounter the error "Failed to verify protected resource"

---

Start Resource

Ensure the resource in server.cfg of your server

Make sure to start the resource only after all essential server resources have been started. Follow the example below to ensure highqez_crawldead

ensure es_extended/qb-core #Don't start above this
ensure qb-target/ox-target/qtarget #Don't start above this

#Start the HighQez resource here

ensure highqez_crawldead

#Start the rest of your resources

---

Resource Database

Proceed the required SQL queue to your server database

Insert the SQL query from the attached file to use the resource, depending on your framework. See below for framework-specific SQL queries

SQL query for ESX

ALTER TABLE `users`
	ADD `is_crawl` TINYINT(1) NULL DEFAULT '0'
;

---

Resource Items

Transfer the item's images from the INSTALL folder of the resource to your server's inventory

Ensure to add all required items to your server

ESX INVENTORY

INSERT INTO `items` (name, label, weight) VALUES
	('highdosepill','High Dose Pill', 1)
;

OX INVENTORY

['highdosepill'] = {
    label = 'High Dose Pill',
    weight = 1,
    stack = false,
    close = true,
},

OLD QBCore

["highdosepill"] = {
    ["name"] = "highdosepill", 							
    ["label"] = "High Dose Pill",                     
    ["weight"] = 100,      
    ["type"] = "item",      
    ["image"] = "highdosepill.png",                 
    ["unique"] = false,     
    ["useable"] = true,     
    ["shouldClose"] = true,    
    ["combinable"] = nil,   
    ["description"] = "The pill that can make you high"
},

NEW QBCore

highdosepill = { 
    name = 'highdosepill', 
    label = 'High Dose Pill', 
    weight = 100, 
    type = 'item', 
    image = 'highdosepill.png', 
    unique = false, 
    useable = true, 
    shouldClose = true, 
    combinable = nil, 
    description = 'The pill that can make you high' 
},

---

Configure Resource

Customize the script to suit the specific requirements of your server

Open-source files are available for editing the framework function. The main configuration of the resource is provided below.

Config File

Config = {}

-- Add any keys if you want the injured player to use while crawling
Config.EnabledKeys = {  --https://docs.fivem.net/docs/game-references/controls/
    0, --v
    1, --cam
    2, --cam
    47, -- G
    245, --T 
    38, --E
}

Config.CrawlTimer = 100 -- (In Seconds) Player will be dead after the timer

Config.SelfReviveCommand = 'selfrevive' -- Custom command for self revive

Config.ReviveItem = 'highdosepill' -- Use false if you wanna disable this

Config.EveryoneCanReviveOthers = true -- Anyone can revive the nearby player using the item

Config.CombatLoggingCrawl = true -- Player will be crawl if they exit while crawling

Config.CombatLoggingDead = true -- Player will be dead if they exit when he is dead(TURN ON COMBAT LOG IN YOUR AMBULANCE SCRIPT TOO)

Config.FinishEmotes = true -- true/false Finishing animation effect

Config.ScreenEffect = 'ChopVision' -- Use false to disable it or add 'ChopVision' effect name

Config.Target = 'ox_target' -- 'ox_target' or 'qtarget'

-- Config below if Config.FinishEmotes = true
Config.Emotes = {
    ['Punch'] = {
        ["killer"] = {  -- The killer animation side
            "melee@unarmed@streamed_variations",
            "plyr_takedown_rear_lefthook",
            "Punch",
            "victim"
        },
        ["victim"] = {  -- The victim/injured player animation side
            "melee@unarmed@streamed_variations",
            "victim_takedown_front_cross_r",
            "Punched",
            "killer"
        },
        item = nil  -- Required item to perform the finish move, nill or 'item_name'
    },
    ['Slap'] = {
        ["killer"] = {
            "melee@unarmed@streamed_variations",
            "plyr_takedown_front_slap",
            "Slap",
            "victim",
            AnimationOptions = {
                EmoteDuration = 2000,
            }
        },
        ["victim"] = {
            "melee@unarmed@streamed_variations",
            "victim_takedown_front_slap",
            "Slapped",
            "killer"
        },
        item = nil
    },
    ['Knife'] = {
        ["killer"] = {
            "melee@knife@streamed_variations",
            "plyr_knife_front_takedown_variation_a",
            "Knife",
            "victim",
            AnimationOptions = {
                EmoteDuration = 2000,
            }
        },
        ["victim"] = {
            "melee@knife@streamed_variations",
            "victim_knife_front_takedown_variation_a",
            "Knifed",
            "killer"
        },
        item = 'WEAPON_KNIFE'
    },
    ['SMG'] = {
        ["killer"] = {
            "combat@fire_variations@gang@smg",
            "var_a",
            "Shot",
            "victim",
            AnimationOptions = {
                EmoteDuration = 2000,
            }
        },
        ["victim"] = {
            "melee@pistol@streamed_core",
            "victim_front_takedown_kill",
            "Shoted",
            "killer"
        },
        item = 'WEAPON_SMG'
    },

}

---

Required Resource Adjustments

Server resources need to be modified for the proper execution of this script. Follow the instructions below to ensure the script runs smoothly

Refer to the following tab, which is relevant to your current ambulance job script

ESX AMBULANCE JOB

• Ensure to make edits to both esx_extended and esx_ambulancejob

  • es_extended: View Edited File (GitHub)

  • esx_ambulancejob: View Edited File (GitHub)

QB AMBULANCE JOB

• Ensure to make edits to qb-ambulancejob

  • qb-ambulancejob: View Edited File (GitHub)

ARS AMBULANCE JOB

• Ensure to make edits to ars_ambulancejob

  • ars_ambulancejob: View Edited File (GitHub)

WASABI AMBULANCE

• Ensure to make edits to wasabi_ambulance

  • wasabi_ambulance/game/client/client.lua: View Edited File (Diff)

Remember this important information Use the website to compare old and new edited files. Scroll down and review the Green or Red column to understand the code additions and removals in the current file

---

Resource API

Check out the API page to access all APIs for this resource, which can be very useful for developers

API

---