DO NOT EXPECT ME TO HELP YOU OR FIX ANY ISSUES. I WON'T. YOU ARE ON YOUR OWN UNLESS SOMEONE DOES A PR WITH FULL FIX/OVERHAUL.
- qbcore pet script
- Partially Ox Compatible (for Ox Lib, inv, target)
- Still needs qbcore (I'm not sure if this can work with only ox, I don't know don't ask)
Dependencies:
- QBCore
- Ox Lib, Inv, Target
- Patience
If you want the police k9 I have attached the files, they are downsized from 4k from this: https://www.lcpdfr.com/downloads/gta5mods/character/19996-german-shepherd-malinois-k9-dog/
You need to make/stream add-on peds.
Use this for the pet store: https://www.gta5-mods.com/maps/mlo-pet-shop
The illegal/poacher store is on cayo sitting on a chair, using https://github.com/TayMcKenzieNZ/CayoTwoIslands
It's not necessary, but this is how I set it up for my community. Change it if you want.
- Food/Water not always working
- some items related to pets not working
- Leveling system not working
- Sometimes pets die/don't revive properly
I've "fixed" these issues in my own (duct-taped) ways:
- Pet levels are set to allow them to have full abilities on spawn
- Pets generally will revive when respawned. Sometimes the items work, some times it doesn't.
- Don't use items that change pet metadata generally (name change etc)
The most important thing is pets are FUNCTIONAL with Ox. This is purely experimental/working for me. If you want to, feel free to use this and modify it yourself to fix other issues.
Please support SWKeep if you use this. This is probably the best/most user friendly pet script on FiveM. And it's free.
https://github.com/swkeep https://swkeep.tebex.io/
-- ================ Keep-companion ================
['keepcompanionhusky'] = {
label = 'Husky',
weight = 5000,
stack = false,
close = true,
description = "Also the nickname everyone calls you behind your back."
},
['keepcompanionpoodle'] = {
label = 'Poodle',
weight = 5000,
stack = false,
close = true,
description = "This dog's haircut is more expensive than your car."
},
['keepcompanionrottweiler'] = {
label = 'Rottweiler',
weight = 5000,
stack = false,
close = true,
description = "A butcher's best friend."
},
['keepcompanionwesty'] = {
label = 'Westie',
weight = 5000,
stack = false,
close = true,
description = "A great breed for hunting rats, and wearing cute sweaters."
},
['keepcompanioncat'] = {
label = 'Cat',
weight = 5000,
stack = false,
close = true,
description = "What's new pussycat?"
},
['keepcompanionpug'] = {
label = 'Pug',
weight = 5000,
stack = false,
close = true,
description = "The snorting haunts you in your sleep."
},
['keepcompanionretriever'] = {
label = 'Retriever',
weight = 5000,
stack = false,
close = true,
description = "America's favorite dog."
},
['keepcompanionshepherd'] = {
label = 'Border Collie',
weight = 5000,
stack = false,
close = true,
description = "Useful to heard your flock of sheep."
},
['keepcompanionrabbit'] = {
label = 'Rabbit',
weight = 5000,
stack = false,
close = true,
description = "Boing boing boing boing."
},
['keepcompanionhen'] = {
label = 'Hen',
weight = 5000,
stack = false,
close = true,
description = "A best friend AND lunch. Two for one!"
},
['keepcompanionrat'] = {
label = 'Rat',
weight = 5000,
stack = false,
close = true,
description = "Snitches get stiches, but rats get scritches."
},
['keepcompanionk9unit'] = {
label = 'K9 Unit Malinois',
weight = 5000,
stack = false,
close = true,
description = "LSPD exclusive K9."
},
---
--- pet items ----
['petfood'] = {
label = 'Pet Food',
weight = 500,
stack = true,
close = true,
description = "Nom nom for your pom pom."
},
['collarpet'] = {
label = 'Pet Collar',
weight = 500,
stack = false,
close = true,
description = "Rename your pet."
},
['firstaidforpet'] = {
label = 'Pet First-aid Kit',
weight = 500,
stack = true,
close = true,
description = "Bring your pet back from the dead again and again."
},
['petnametag'] = {
label = 'Pet Name Tag',
weight = 500,
stack = true,
close = true,
description = "rename your pet."
},
['petwaterbottleportable'] = {
label = 'Pet Water Bottle',
weight = 500,
stack = false,
close = true,
description = "Water for your pet. Stop trying to drink this."
},
['petgroomingkit'] = {
label = 'Pet Grooming Kit',
weight = 500,
stack = false,
close = true,
description = "Now your pet can pass a wave check."
},Please add the LSPD K9 somewhere like your police locker or another shop that only LSPD has access to.
PetShop = {
blip = {
id = 463, colour = 31, scale = 1.1
},
name = 'Pet Shop',
inventory = {
{ name = 'petfood', price = 500, },
{ name = 'collarpet', price = 2000, },
{ name = 'firstaidforpet', price = 2000, },
{ name = 'petnametag', price = 2000, },
{ name = 'petwaterbottleportable', price = 500, },
{ name = 'petgroomingkit', price = 75000, },
{ name = 'keepcompanionhusky', price = 75000, count = 5, },
{ name = 'keepcompanionpoodle', price = 45000, count = 5, },
{ name = 'keepcompanionrottweiler', price = 75000, count = 5, },
{ name = 'keepcompanionwesty', price = 30000, count = 5, },
{ name = 'keepcompanioncat', price = 25000, count = 10, },
{ name = 'keepcompanionpug', price = 50000, count = 5, },
{ name = 'keepcompanionretriever', price = 50000, count = 5, },
{ name = 'keepcompanionshepherd', price = 50000, count = 5, },
{ name = 'keepcompanionhen', price = 25000, count = 10, },
{ name = 'keepcompanionrat', price = 25000, count = 10, },
{ name = 'keepcompanionrabbit', price = 25000, count = 20, },
},
locations = {
},
targets = {
{
ped = `cs_guadalope`,
scenario = 'WORLD_HUMAN_STAND_IMPATIENT',
loc = vector3(563.64, 2753.1, 41.88),
heading = 183.65,
distance = 3.0,
},
}
},
Poacher = {
name = 'Poacher',
inventory = {
{ name = 'keepcompanionmtlion', price = 75000, count = 5, currency = 'black_money', },
{ name = 'keepcompanionmtlion2', price = 75000, count = 5, currency = 'black_money', },
{ name = 'keepcompanioncoyote', price = 75000, count = 5, currency = 'black_money', },
},
locations = {
},
targets = {
{
ped = `csb_cletus`,
scenario = 'PROP_HUMAN_SEAT_BENCH',
loc = vector3(4803.68, -4601.88, 17.31),
heading = 178.26,
distance = 3.0,
},
}
},Keep Companion Original Read Me (you may need to do some stuff here, use your critical thinking skills to figure out what):
- XP and levelling system
- Food system
- thirst system
- Health system (heal and revive)
- Auto naming (At first usage) & Renaming
- pet variation
- Control pet's actions
- Pet shop
- Pet animation
- ...
- Pls, note this project is a work in progress.
- open the menu with "o"
- menu keybind can be customized inside settings and Fivem keybinds
- The installation may seem a bit longer than it should be, but it's just a lot of text
- qb-target
- qbcore framework
- qb-menu
- qbcore inventory
- lj-inventory -- in screenshot
- qb-shops
-- Add this code at end of qb-core\shared\items.lua
-- ================ Keep-companion ================
["keepcompanionhusky"] = {
["name"] = "keepcompanionhusky",
["label"] = "Husky",
["weight"] = 500,
["type"] = "item",
["image"] = "A_C_Husky.png",
["unique"] = true,
["useable"] = true,
["shouldClose"] = true,
["combinable"] = nil,
["description"] = "Husky is your royal companion!"
},
["keepcompanionpoodle"] = {
["name"] = "keepcompanionpoodle",
["label"] = "Poodle",
["weight"] = 500,
["type"] = "item",
["image"] = "A_C_Poodle.png",
["unique"] = true,
["useable"] = true,
["shouldClose"] = true,
["combinable"] = nil,
["description"] = "Poodle is your royal companion!"
},
["keepcompanionrottweiler"] = {
["name"] = "keepcompanionrottweiler",
["label"] = "Rottweiler",
["weight"] = 500,
["type"] = "item",
["image"] = "A_Rottweiler.png",
["unique"] = true,
["useable"] = true,
["shouldClose"] = true,
["combinable"] = nil,
["description"] = "Rottweiler is your royal companion!"
},
["keepcompanionwesty"] = {
["name"] = "keepcompanionwesty",
["label"] = "Westy",
["weight"] = 500,
["type"] = "item",
["image"] = "A_C_Westy.png",
["unique"] = true,
["useable"] = true,
["shouldClose"] = true,
["combinable"] = nil,
["description"] = "Westy is your royal companion!"
},
["keepcompanionmtlion"] = {
["name"] = "keepcompanionmtlion",
["label"] = "MtLion",
["weight"] = 500,
["type"] = "item",
["image"] = "A_C_MtLion.png",
["unique"] = true,
["useable"] = true,
["shouldClose"] = true,
["combinable"] = nil,
["description"] = "MtLion is your royal companion!"
},
["keepcompanionmtlion2"] = {
["name"] = "keepcompanionmtlion2",
["label"] = "Panter",
["weight"] = 500,
["type"] = "item",
["image"] = "A_C_MtLion.png",
["unique"] = true,
["useable"] = true,
["shouldClose"] = true,
["combinable"] = nil,
["description"] = "Panter is your royal companion!"
},
["keepcompanioncat"] = {
["name"] = "keepcompanioncat",
["label"] = "Cat",
["weight"] = 500,
["type"] = "item",
["image"] = "A_C_Cat_01.png",
["unique"] = true,
["useable"] = true,
["shouldClose"] = true,
["combinable"] = nil,
["description"] = "Cat is your royal companion!"
},
["keepcompanionpug"] = {
["name"] = "keepcompanionpug",
["label"] = "Pug",
["weight"] = 500,
["type"] = "item",
["image"] = "A_C_Pug.png",
["unique"] = true,
["useable"] = true,
["shouldClose"] = true,
["combinable"] = nil,
["description"] = "Pug is your royal companion!"
},
["keepcompanionretriever"] = {
["name"] = "keepcompanionretriever",
["label"] = "Retriever",
["weight"] = 500,
["type"] = "item",
["image"] = "A_C_Retriever.png",
["unique"] = true,
["useable"] = true,
["shouldClose"] = true,
["combinable"] = nil,
["description"] = "Retriever is your royal companion!"
},
["keepcompanionshepherd"] = {
["name"] = "keepcompanionshepherd",
["label"] = "Shepherd",
["weight"] = 500,
["type"] = "item",
["image"] = "A_C_shepherd.png",
["unique"] = true,
["useable"] = true,
["shouldClose"] = true,
["combinable"] = nil,
["description"] = "Shepherd is your royal companion!"
},
-- new pets
["keepcompanioncoyote"] = {
["name"] = "keepcompanioncoyote",
["label"] = "Coyote",
["weight"] = 500,
["type"] = "item",
["image"] = "A_C_Coyote.png",
["unique"] = true,
["useable"] = true,
["shouldClose"] = true,
["combinable"] = nil,
["description"] = "Coyote is your royal companion!"
},
["keepcompanionrabbit"] = {
["name"] = "keepcompanionrabbit",
["label"] = "Rabbit",
["weight"] = 500,
["type"] = "item",
["image"] = "A_C_Rabbit_01.png",
["unique"] = true,
["useable"] = true,
["shouldClose"] = true,
["combinable"] = nil,
["description"] = "Rabbit is your royal companion!"
},
["keepcompanionhen"] = {
["name"] = "keepcompanionhen",
["label"] = "Hen",
["weight"] = 500,
["type"] = "item",
["image"] = "A_C_Hen.png",
["unique"] = true,
["useable"] = true,
["shouldClose"] = true,
["combinable"] = nil,
["description"] = "Hen is your royal companion!"
},
["keepcompanionrat"] = {
["name"] = "keepcompanionrat",
["label"] = "Rat",
["weight"] = 500,
["type"] = "item",
["image"] = "A_C_Rat.png",
["unique"] = true,
["useable"] = true,
["shouldClose"] = true,
["combinable"] = nil,
["description"] = "Your royal companion!"
},
---
["petfood"] = {
["name"] = "petfood",
["label"] = "pet food",
["weight"] = 500,
["type"] = "item",
["image"] = "petfood.png",
["unique"] = false,
["useable"] = true,
["shouldClose"] = true,
["combinable"] = nil,
["description"] = "food for your companion!"
},
["collarpet"] = {
["name"] = "collarpet",
["label"] = "Pet collar",
["weight"] = 500,
["type"] = "item",
["image"] = "collarpet.png",
["unique"] = false,
["useable"] = true,
["shouldClose"] = true,
["combinable"] = true,
["description"] = "Rename your pets!"
},
["firstaidforpet"] = {
["name"] = "firstaidforpet",
["label"] = "First aid for pet",
["weight"] = 500,
["type"] = "item",
["image"] = "firstaidforpet.png",
["unique"] = false,
["useable"] = true,
["shouldClose"] = true,
["combinable"] = nil,
["description"] = "Revive your pet!"
},
["petnametag"] = {
["name"] = "petnametag",
["label"] = "Name tag",
["weight"] = 500,
["type"] = "item",
["image"] = "petnametag.png",
["unique"] = false,
["useable"] = true,
["shouldClose"] = true,
["combinable"] = nil,
["description"] = "Rename your pet"
},
["petwaterbottleportable"] = {
["name"] = "petwaterbottleportable",
["label"] = "Portable water bottle",
["weight"] = 1000,
["type"] = "item",
["image"] = "petwaterbottleportable.png",
["unique"] = true,
["useable"] = true,
["shouldClose"] = true,
["combinable"] = nil,
["description"] = "Flask to store water for your pets"
},
["petgroomingkit"] = {
["name"] = "petgroomingkit",
["label"] = "Pet Grooming Kit",
["weight"] = 1000,
["type"] = "item",
["image"] = "petgroomingkit.png",
["unique"] = true,
["useable"] = true,
["shouldClose"] = true,
["combinable"] = nil,
["description"] = "Pet Grooming Kit"
},- Here is tables qb-shops/config.lua
-- add it at end of Config.Products table
["petshop"] = {
[1] = {
name = 'keepcompanionwesty',
price = 50000,
amount = 5,
info = {},
type = 'item',
slot = 1
},
[2] = {
name = 'keepcompanionshepherd',
price = 150000,
amount = 5,
info = {},
type = 'item',
slot = 2
},
[3] = {
name = 'keepcompanionretriever',
price = 50000,
amount = 5,
info = {},
type = 'item',
slot = 3
},
[4] = {
name = 'keepcompanionrottweiler',
price = 75000,
amount = 5,
info = {},
type = 'item',
slot = 4
},
[5] = {
name = 'keepcompanionpug',
price = 95000,
amount = 5,
info = {},
type = 'item',
slot = 5
},
[6] = {
name = 'keepcompanionpoodle',
price = 50000,
amount = 5,
info = {},
type = 'item',
slot = 6
},
[7] = {
name = 'keepcompanionmtlion2',
price = 50000,
amount = 5,
info = {},
type = 'item',
slot = 7
},
[8] = {
name = 'keepcompanioncat',
price = 50000,
amount = 5,
info = {},
type = 'item',
slot = 8
},
[9] = {
name = 'keepcompanionmtlion',
price = 50000,
amount = 5,
info = {},
type = 'item',
slot = 9
},
[10] = {
name = 'keepcompanionhusky',
price = 50000,
amount = 5,
info = {},
type = 'item',
slot = 10
},
[11] = {
name = 'petfood',
price = 500,
amount = 1000,
info = {},
type = 'item',
slot = 11
},
[12] = {
name = 'collarpet',
price = 50000,
amount = 50,
info = {},
type = 'item',
slot = 12
},
[13] = {
name = 'firstaidforpet',
price = 5000,
amount = 50,
info = {},
type = 'item',
slot = 13
},
[14] = {
name = 'petnametag',
price = 5000,
amount = 50,
info = {},
type = 'item',
slot = 14
},
[15] = {
name = 'petwaterbottleportable',
price = 5000,
amount = 50,
info = {},
type = 'item',
slot = 15
},
[16] = {
name = 'petgroomingkit',
price = 5000,
amount = 50,
info = {},
type = 'item',
slot = 16
},
[17] = {
name = 'keepcompanionrabbit',
price = 15000,
amount = 50,
info = {},
type = 'item',
slot = 17
},
[18] = {
name = 'keepcompanionhen',
price = 5000,
amount = 50,
info = {},
type = 'item',
slot = 18
},
[19] = {
name = 'keepcompanioncoyote',
price = 50000,
amount = 50,
info = {},
type = 'item',
slot = 19
},
}
-- add it at end of Config.Locations table
["petshop"] = {
["label"] = "Pet Shop",
["coords"] = vector4(561.18, 2741.51, 42.87, 199.08), --or vector4(-659.87, -936.46, 21.83, 130.04), -- for mlo https://www.gta5-mods.com/maps/
["ped"] = 'S_M_M_StrVend_01',
["scenario"] = "WORLD_HUMAN_COP_IDLES",
["radius"] = 1.5,
["targetIcon"] = "fas fa-paw",
["targetLabel"] = "Open Pet Shop",
["products"] = Config.Products["petshop"],
["showblip"] = true,
["blipsprite"] = 267,
["blipcolor"] = 5
},- i'm using lj-inventory just find where tooltip codes are!
- in inventory\js\app.js find FormatItemInfo() there is if statement like: if (itemData.name == "id_card")
- track where all of elseif statments ends then add else if below at there
else if (
itemData.name == "keepcompanionhusky" ||
itemData.name == "keepcompanionrottweiler" ||
itemData.name == "keepcompanionmtlion" ||
itemData.name == "keepcompanionmtlion2" ||
itemData.name == "keepcompanioncat" ||
itemData.name == "keepcompanionpoodle" ||
itemData.name == "keepcompanionpug" ||
itemData.name == "keepcompanionretriever" ||
itemData.name == "keepcompanionshepherd" ||
itemData.name == "keepcompanionwesty" ||
itemData.name == "keepcompanioncoyote" ||
itemData.name == "keepcompanionrabbit" ||
itemData.name == "keepcompanionhen"
) {
let gender = itemData.info.gender;
gender ? (gender = "male") : (gender = "female");
$(".item-info-title").html("<p>" + itemData.info.name + "</p>");
$(".item-info-description").html(
"<p><strong>Owner Phone: </strong><span>" +
itemData.info.owner.phone +
"</span></p><p><strong>Variation: </strong><span>" +
`${itemData.info.variation}` +
"</span></p><p><strong>Gender: </strong><span>" +
`${gender}` +
"</span></p><p><strong>Health: </strong><span>" +
itemData.info.health +
"</span></p><p><strong>Xp/Max: </strong><span>" +
`${itemData.info.XP} / ${maxExp(itemData.info.level)}` +
"</span></p><p><strong>Level: </strong><span>" +
itemData.info.level +
"</span></p><p><strong>Age: </strong><span>" +
callAge(itemData.info.age) +
"</span></p><p><strong>Food: </strong><span>" +
itemData.info.food +
"</span></p>" +
"</span></p><p><strong>Thirst: </strong><span>" +
itemData.info.thirst +
"</span></p>"
);
}
else if (itemData.name == "petwaterbottleportable") {
$(".item-info-title").html("<p>" + itemData.label + "</p>");
$(".item-info-description").html("<p>capacity(L): " + itemData.info.liter + "</p>");
}- and add this codes at end of inventory\js\app.js
function callAge(age) {
let max = 0;
let min = 0;
if (age === 0) {
return 0;
}
for (let index = 1; index < 10; index++) {
max = 60 * 60 * 24 * index;
min = 60 * 60 * 24 * (index - 1);
if (age >= min && age <= max) {
return index - 1;
}
}
}
function maxExp(level) {
let xp = Math.floor(
(1 / 4) * Math.floor((level + 300) * Math.pow(2, level / 7))
);
return xp;
}
function currentLvlExp(xp) {
let maxExp = 0;
let minExp = 0;
for (let index = 0; index <= 50; index++) {
maxExp = Math.floor(Math.floor((i + 300) * (2 ^ (i / 7))) / 4);
minExp = Math.floor(Math.floor((i - 1 + 300) * (2 ^ ((i - 1) / 7))) / 4);
if (xp >= minExp && xp <= maxExp) {
return i;
}
}
}#K9
- important steps for k9 to work
- first open you inventory script qb-inventory/server/main.lua
- find this event
RegisterNetEvent('inventory:server:SetIsOpenState')-
add code below after or before this event (not inside it!)
-
then go to script confing file find Config.inventory_name and change it to your inventory's name