Miscellaneous Configuration

Shared.DefaultLeadState

Whether or not the lead should be enabled when you first spawn in the dog. It's recommended this is kept true, the dog is generally more natural to use with the lead.

This is the server default - players can change the lead state with /dheel, and customizing how long a players change lasts is done in the below Shared.EnableStoringLeadState.

Shared.DefaultLeadState = true -- Whether or not the lead should be enabled by default when you spawn in a dog. It's recommended this remains as true, as the dog is generally more natural to use on the lead. Players can change their preferred state themselves with /dheel.

Shared.EnableStoringLeadState

How long (if it all) to store a player's lead preference after they change it with /dheel. Regardless of this option, the first time a player interacts with the script, the lead state will be the above config Shared.DefaultLeadState. The options are: - "KVP": The player's lead state selection will be stored across server restarts and client sessions, and is stored in client KVP. - "SESSION": The player's lead state selection will be stored until the client restarts their game, and when they re-log it will be reset to the above Shared.DefaultLeadState. - false: The player's lead state will be stored until the client respawns their dog, and will then be reset to the above Shared.DefaultLeadState.

Shared.EnableStoringLeadState = false -- "KVP" (INCLUDE QUOTES), "SESSION" (INCLUDE QUOTES), or false (No quotes/lowercase) - Whether or not individual players lead/heeling state should be stored. Regardless of this option, the lead state the first time interacting with the script will be the above DefaultLeadState. If this is "KVP", the players preferred lead state (changed with /dheel) will store for the duration of their session, and across server-restarts/different sessions. If this is "SESSION", the players preferred lead state will store for the duration of their session, and be forgotten and reset to the server default when they re-log. If this is false, the server default (above) will be used everytime a player spawns a dog, and using /dheel will only be effective until you respawn the dog. (Original Behaviour up until v1.8.0)

Shared.AllowAi

Whether or not the dog will accept an AI ped as a target for attacking.

Shared.AllowAi = false -- Whether or not AI peds can be a target for the dog attacking.

Shared.BarkingAnimation

The style of animation the dog uses when barking. A is the default animation, and has a more aggressive barking style, but doesn't play any audio. B is the secondary animation, and is a less aggressive barking style, but does play audio.

Shared.BarkingAnimation = "A" -- Either 'A' or 'B'. A is a more aggressive animation but doesn't play any audio. B is a less aggressive animation but plays a barking sound track.

Shared.DogMenu

The name of the command to open the dog management menu. The menu can be used to control most aspects of the dog without using commands/keybinds. Set this to an empty string to disable the menu.

Shared.DogMenu = "dmenu" -- The name of the command to open the dog management menu. Make the string empty to disable the command.

Shared.WaitTime

The time, in milliseconds, in the wait statement in the loop that controls the dog's movement. If you want the dog to be more reactive to direction changes, decrease this number. If you are experiencing game crashes or performance issues, increase this number.

Shared.WaitTime = 110 -- The wait time in milliseconds on the loop that checks for player movement. If you want the dog to respond faster to direction changes, decrease this number. If you are experiencing game crashes or performance issues, increase this number.

Shared.LeadMovementSpeed

Many customers find that the dog moves to quickly on the lead. This configuration option lets you change how fast the dog moves.

The dog's speed is calculated by subtracting this number from the dog handlers speed, so if you want the dog to move slower, you need to increase this number, and if you want the dog to move faster, you need to decrease this number.

Shared.LeadMovementSpeed = 2.0 -- This is the number that is **SUBTRACTED** from the dog handlers speed to calculate the speed from the dog on a lead.. If you want the dog to move slower, INCREASE this number.

Shared.HeelingMovementSpeed

This is the same as the above, but for when the dog is not on the lead. It's generally reccomended that the dog has a slower speed when not using the lead.

The dog's speed is calculated by subtracting this number from the dog handlers speed, so if you want the dog to move slower, you need to increase this number, and if you want the dog to move faster, you need to decrease this number.

Shared.HeelingMovementSpeed = 2.3 -- This is the number that is **SUBTRACTED** from the dog handlers speed to calculate the speed from the dog while heeling.. If you want the dog to move slower, INCREASE this number.

Shared.DefaultKeybinds

The default keybinds that are used when a client first joins the server. All of these can be customized by each player individually after they are initially set to these values. Available keys: https://docs.fivem.net/docs/game-references/input-mapper-parameter-ids/keyboard/

Shared.DefaultKeybinds = { -- The default keybinds for when the bind is registered. All keybinds are changeable by individual players through Settings -> Keybindings -> FiveM
    ["EXTEND_LEASH"] = "UP", -- Hold down this key to extend the length of the leash
    ["SHORTEN_LEASH"] = "DOWN", -- Hold down this key to decrease the length of the leash
    ["CANCEL_EMOTE"] = "X", -- Cancel your dogs current emote
    ["SIT"] = "", -- Make your dog sit,
    ["LIE_DOWN"] = "", -- Make your dog lie down
    ["HOLD"] = "", -- Hold your dog between your legs
    ["BARK"] = "", -- Make your dog bark
    ["HEEL"] = "", -- Toggle your dogs heeling status
    ["TP"] = "", -- Teleport your dog to you
    ["CAR"] = "", -- Makes your dog enter/exit your car
    ["ATTACK"] = "", -- Make your dog attack a player/ped
    ["MENU"] = "", -- Opens the dog management menu (Shared.DogMenu)
    ["GPS"] = "", -- Toggle the GPS Blip to your dog (if Shared.EnableGPS is true)
}