💻Installation

Don't know how to install the script? Don't worry, we are here to help!

1) Go to keymaster and download the package

You can find your keymaster here, you'll need to login with your Fivem account. Make sure you get the right account because when you purchase the package, it is connected to the Fivem account you logged into.

Once logged in, you can download the package! Downloading the package is as easy as just pressing one button.

2) Putting it in the server

Unzip the folder and drop it into one of your folders inside resources.

3) Giving access

Go to the config.lua there you will find Config.Access. This is where you choose which players get access to use the K9 dog.

I will briefly explain Job, Discord ID and Discord role access

Job access

• If you want this to be a job, add it to ['job'], we highly encourage this to be a different job from police, for example police_k9. You'll need to add it to your qb-core > shared > jobs.lua if you don't have the job already.

config.lua (lumio-k9)

Config.Access = {
    ['job'] = {
        'police_k9'
    },
    ['discord'] = {
    },
    ['license'] = {
    },
    ['discordrole'] = {
    },
    ['citizenid'] = {
    }
}

jobs.lua (qb-core)

police_k9 = {
        label = 'K9 unit police',
        defaultDuty = true,
        offDutyPay = true,
        grades = {
            ['0'] = {
                name = 'K9',
                payment = 0
            },
        },
    },

Discord ID access

config.lua (lumio-k9)

Config.Access = {
    ['job'] = {
    },
    ['discord'] = {
        '123456789012345678'
    },
    ['license'] = {
    },
    ['discordrole'] = {
    },
    ['citizenid'] = {
    }
}

Discord role access

config.lua (lumio-k9)

Config.Access = {
    ['job'] = {
    },
    ['discord'] = {
    },
    ['license'] = {
    },
    ['discordrole'] = {
        ['ROLE NAME'] = 'ROLE ID'
      --['Member'] = '123456789012345678
    },
    ['citizenid'] = {
    }
}

Config.DiscordIntegration = {
    Enabled = true, --PUT THIS ON TRUE
    BotToken = 'YOUR TOKEN',
    GuildId = 'YOUR SERVER ID',
}

Make sure to put Enabled on true!

Where to find BotToken and GuildId?

• You need to make an Discord bot and invite the Discord bot to your Discord server. More explanation in FAQ

• The GuildId is the ID of your Discord server.

4) Adding items

• For qb-inventory or any other variant go to qb-core > shared > items.lua

foodbowl                     = {name = 'foodbowl', label = 'Dogfood bowl', weight = 1000, type = 'item', image = 'foodbowl.png', unique = false, useable = true, shouldClose = true, combinable = nil, description = 'A delicious bowl of food for dogs'},
waterbowl                    = {name = 'waterbowl', label = 'Water bowl', weight = 1000, type = 'item', image = 'waterbowl.png', unique = false, useable = true, shouldClose = true, combinable = nil, description = 'A delicious bowl of water for dogs'},
dog_biscuits                 = {name = 'dog_biscuits', label = 'Dog biscuits', weight = 1000, type = 'item', image = 'dog_biscuits.png', unique = false, useable = true, shouldClose = true, combinable = nil, description = 'Some delicious dog biscuits'},

• Add the images found in lumio-k9 > images to qb-inventory > html > images

---

• For ox_inventory go to ox_inventory > data > items.lua

["foodbowl"] = {
    label = "Dogfood bowl",
    weight = 1000,
    stack = true,
    close = true,
    description = "A delicious bowl of food for dogs",
    client = {
        image = "foodbowl.png",
    }
},
["waterbowl"] = {
    label = "Water bowl",
    weight = 1000,
    stack = true,
    close = true,
    description = "A delicious bowl of water for dogs",
    client = {
        image = "waterbowl.png",
    }
},
["dog_biscuits"] = {
    label = "Dog biscuits",
    weight = 1000,
    stack = true,
    close = true,
    description = "Some delicious dog biscuits",
    client = {
        image = "dog_biscuits.png",
    }
},

• Add the images found in lumio-k9 > images to ox_inventory > web > images

We highly suggest to do at least the qb-ambulancejob edits found in Optional edits!