Skip to content

Vehicle WINCH ​

Documentation relating to the kd_winch.

1. Installation ​

Vehicle WINCH is a standalone script. So you don't need a specific framework to use it. It's also mean it works with all framework (Esx, QBCore, VRP, DRP, …).

  • Drag and drop this 4 resources in your resources folder
    • InteractSound
    • kd_custom-native
    • kd_hud-event
    • kd_winch
  • Add this 4 ensures in your server.cfg
    • ensure InteractSound
    • ensure kd_custom-native
    • ensure kd_hud-event
    • ensure kd_winch
  • Congratulation, the Vehicle WINCH script is ready to be use !

2. Usage ​

By default, the script is configured to work with the Dune Loader: dloader. Use your admin menu (or other scripts) to spawn it.

A help message with key will appears at the top left of your screen every time action is available. Please read them to know what keys are usable.

  1. Go to the front of the dune loader to take the winch.
  2. Go to near other car to attach it.
  3. Back to the front of the dune loader or inside to roll up/down the winch
  4. If you need to detach the winch, go back to the front of vehicle and take the winch. You can store it by go back to the front of the dune loader

3. Config.lua ​

The configuration file is config.lua in the resource root. Do not edit this file directly as your changes may be lost during updates. Instead, use overwriteConfig.lua to store your customizations.

  • config.lua - Default configuration maintained by developers. Do not modify this file.
  • overwriteConfig.lua - This is where you place only the values you want to override.

How to customize the configuration ​

  1. Open /overwriteConfig.lua
  2. Find the value you want to change in config.lua (e.g., Config.language )
  3. Copy only that line into overwriteConfig.lua
  4. Edit the copied value to your liking

The script loads config.lua first, then overwriteConfig.lua overwrites only the values you redefine. This ensures your customizations are preserved when updating the script.

Loading configuration...

4. For developer ​

You can turn off the script for a specific player by using this client event

lua
TriggerClientEvent('kd_winch:CanUse', source, false)

You can turn on the script again with the same client event

lua
TriggerClientEvent('kd_winch:CanUse', source, true)

Last updated: