# Duel Gun
Documentation relating to the kd_gun_duel.
:::: tabs
::: tab BUY
[Buy the script](https://jumpon-studios.com/redm/gun-duel)
:::
::: tab PREVIEW
| | |
| --------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | --------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- |
:::
::::
## 1. Installation
kd_gun_duel works with VORPcore and RedEM:RP. Be sure you installed one of this two frameworks.
- Drag and drop this 2 resources in your resources folder
- InteractSound
- kd_gun_duel
- Add this 2 ensures in your server.cfg
- `ensure InteractSound`
- `ensure kd_gun_duel`
- Congratulation, the Duel gun script is ready to be use !
## 2. Usage
Two types of duel are available on the script. Both work the same way but the execution is a bit different.
- First type
Use the command `/duel [ID]` to challenge another player (ID is the server ID of the other player). He will have 10s (can be edited) to answer at this request.
If he accepts, both player have to nearby and stand back to back. Next, they have to walk until the **rang of the bells**. At this moment, the first player who hit his opponent wins the duel !
- Second type
Use the command `/duel2 [ID]` to challenge player with this second scenario. In this scenario, both players have to move away from other. When they are far enough, the duel will start with a little cinematic. After a random duration, the bells will ring. The first guy who hit his opponent wins the duel !
## 3. Configuration
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 `kd_gun_duel/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.
`kd_gun_duel/shared/config.lua`
```lua
-------------------------------
-- DOCUMENTATION : https://docs.kaddarem.com/
--------------------------------
-------------------------------------------
-- DON'T EDIT THIS FILE
-- TO OVERWRITE CONFIG VALUE, USE overwriteConfig.lua file instead
-------------------------------------------
Config = {}
Config.CommandDuel1 = "duel"
Config.CommandDuel2 = "duel2"
Config.Debug = false
Config.DurationRequest = 10000
Config.MinTimeGong = 2000
Config.MaxTimeGong = 4000
Config.MaxDistance = 10.0 --Max distance between player to start the duel
Config.CanDamage = false
Config.GongAudio = {
ref = "TOWN_SECRET_SOUNDS",
name = "SECRET_FOUND"
}
Config.Music = {
Name = "duel",
Volume = 0.5,
StartFocusTarget = false,
SwitchPlanTimer = {5500,11300},
Duration = 11000
}
Config.DefaultWeapon = "WEAPON_REVOLVER_CATTLEMAN" -- turn it to false to not give weapon
Config.DrawWithPrompt = true
Config.Keys = {
Accept = "INPUT_INTERACT_ANIMAL",
Draw = "INPUT_INTERACT_OPTION1"
}
Config.ForceRagdoll = true
--------------
-- CLIENT SIDE
--------------
-- Function to test if player have weapon to the duel
Config.HaveWeapon = function()
return true
end
Config.Notifications = {}
Config.Notifications.Tip = function(text,duration)
TriggerEvent("vorp:Tip",text,duration)
TriggerEvent("redem_roleplay:Tip",text,duration)
TriggerEvent('RSGCore:Notify', text)
end
Config.Notifications.Left = function(text,subtitle,dict,icon,duration,color)
TriggerEvent('vorp:NotifyLeft',text,subtitle,dict,icon,duration,color)
TriggerEvent('redem_roleplay:NotifyLeft',text,subtitle,dict,icon,duration)
TriggerEvent('RSGCore:Notify', text.." "..subtitle)
end
-- Notification server side
-------------
--SERVER SIDE
-------------
Config.SNotifications = {}
Config.SNotifications.Tip = function(source,text,duration)
TriggerClientEvent("vorp:Tip",source,text,duration)
TriggerClientEvent("redem_roleplay:Tip",source,text,duration)
TriggerClientEvent('RSGCore:Notify', source,text)
end
Config.SNotifications.TopNotif = function(source,text,subtitle,duration)
TriggerClientEvent('vorp:ShowTopNotification', source, text,subtitle,duration)
TriggerClientEvent('redem_roleplay:ShowTopNotification', source,text,subtitle,duration)
TriggerClientEvent('RSGCore:Notify', source,text.." "..subtitle)
end
-- Function fire when the duel is over
--@params winner is the server ID of the winner
--@params loser is the server ID of the loser
Config.DuelResult = function(winner,loser)
end
```
`kd_gun_duel/shared/lang.lua`
```lua
-------------------------------------------
-- DON'T EDIT THIS FILE
-- TO TRANSLATE THE SCRIPT, USE overwriteLang.lua file instead
-------------------------------------------
Lang = {}
Lang['duel_title'] = "Duel"
Lang['wrong_command'] = "Wrong command : /duel "
Lang['missing_weapon'] = "You don't have weapon for this duel"
Lang['invalid_id'] = "Invalid ID"
Lang['duel_sended'] = "Request of duel sended"
Lang['someone_ask_you'] = "Someone duels you"
Lang['press_enter'] = "Press ~%s~ to accept"
Lang['request_failed'] = "Duel not accepted"
Lang['request_accepted'] = "Duel accepted"
Lang['walk_to_player'] = "Walk to other player"
Lang['back_to_back'] = "Stand Back to Back"
Lang['walk_until_gong'] = "Walk until the rang"
Lang['stop_walk_1'] = "He/She stopped walking"
Lang['stop_walk_2'] = "You stopped walking"
Lang['draw_too_fast_1'] = "He/She drew too soon"
Lang['draw_too_fast_2'] = "You drew too soon"
Lang['draw_instruction'] = "Draw the gun"
Lang['win'] = "You win !"
Lang['lost'] = "You lost !"
Lang['fire'] = "FIRE !"
Lang['press_when_ready'] = "When you are ready"
Lang['wait_player'] = "Pending other duelist"
Lang['start_with_you'] = "You can't start a duel with yourself"
Lang['to_far'] = "This player is to far from you"
```
Duel Gun
Documentation relating to the kd_gun_duel.
:::: tabs
::: tab BUY
[Buy the script](https://jumpon-studios.com/redm/gun-duel)
:::
::: tab PREVIEW
| | |
| --------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | --------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- |
:::
::::
## 1. Installation
kd_gun_duel works with VORPcore and RedEM:RP. Be sure you installed one of this two frameworks.
- Drag and drop this 2 resources in your resources folder
- InteractSound
- kd_gun_duel
- Add this 2 ensures in your server.cfg
- `ensure InteractSound`
- `ensure kd_gun_duel`
- Congratulation, the Duel gun script is ready to be use !
## 2. Usage
Two types of duel are available on the script. Both work the same way but the execution is a bit different.
- First type
Use the command `/duel [ID]` to challenge another player (ID is the server ID of the other player). He will have 10s (can be edited) to answer at this request.
If he accepts, both player have to nearby and stand back to back. Next, they have to walk until the **rang of the bells**. At this moment, the first player who hit his opponent wins the duel !
- Second type
Use the command `/duel2 [ID]` to challenge player with this second scenario. In this scenario, both players have to move away from other. When they are far enough, the duel will start with a little cinematic. After a random duration, the bells will ring. The first guy who hit his opponent wins the duel !
## 3. Configuration
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 `kd_gun_duel/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.
`kd_gun_duel/shared/config.lua`
```lua
-------------------------------
-- DOCUMENTATION : https://docs.kaddarem.com/
--------------------------------
-------------------------------------------
-- DON'T EDIT THIS FILE
-- TO OVERWRITE CONFIG VALUE, USE overwriteConfig.lua file instead
-------------------------------------------
Config = {}
Config.CommandDuel1 = "duel"
Config.CommandDuel2 = "duel2"
Config.Debug = false
Config.DurationRequest = 10000
Config.MinTimeGong = 2000
Config.MaxTimeGong = 4000
Config.MaxDistance = 10.0 --Max distance between player to start the duel
Config.CanDamage = false
Config.GongAudio = {
ref = "TOWN_SECRET_SOUNDS",
name = "SECRET_FOUND"
}
Config.Music = {
Name = "duel",
Volume = 0.5,
StartFocusTarget = false,
SwitchPlanTimer = {5500,11300},
Duration = 11000
}
Config.DefaultWeapon = "WEAPON_REVOLVER_CATTLEMAN" -- turn it to false to not give weapon
Config.DrawWithPrompt = true
Config.Keys = {
Accept = "INPUT_INTERACT_ANIMAL",
Draw = "INPUT_INTERACT_OPTION1"
}
Config.ForceRagdoll = true
--------------
-- CLIENT SIDE
--------------
-- Function to test if player have weapon to the duel
Config.HaveWeapon = function()
return true
end
Config.Notifications = {}
Config.Notifications.Tip = function(text,duration)
TriggerEvent("vorp:Tip",text,duration)
TriggerEvent("redem_roleplay:Tip",text,duration)
TriggerEvent('RSGCore:Notify', text)
end
Config.Notifications.Left = function(text,subtitle,dict,icon,duration,color)
TriggerEvent('vorp:NotifyLeft',text,subtitle,dict,icon,duration,color)
TriggerEvent('redem_roleplay:NotifyLeft',text,subtitle,dict,icon,duration)
TriggerEvent('RSGCore:Notify', text.."