├── .gitattributes ├── fxmanifest.lua ├── config.lua ├── locales ├── en.lua ├── es.lua └── da.lua ├── server └── server.lua ├── README.md ├── client └── client.lua └── LICENSE /.gitattributes: -------------------------------------------------------------------------------- 1 | # Auto detect text files and perform LF normalization 2 | * text=auto 3 | -------------------------------------------------------------------------------- /fxmanifest.lua: -------------------------------------------------------------------------------- 1 | fx_version 'cerulean' 2 | game 'gta5' 3 | 4 | description 'K-9 Script for QB original author hashx_k9 edited by FjamZoo#0001' 5 | version '1.0.0' 6 | 7 | shared_script { 8 | '@qb-core/shared/locale.lua', 9 | 'locales/en.lua', 10 | 'config.lua', 11 | } 12 | 13 | client_scripts { 14 | 'client/client.lua' 15 | } 16 | 17 | server_script { 18 | 'server/server.lua' 19 | } 20 | -------------------------------------------------------------------------------- /config.lua: -------------------------------------------------------------------------------- 1 | Config = {} 2 | 3 | Config.DogModelProps = { 4 | [1] = { -- Number of dogs can be infinite 5 | ["Header"] = "Police K9", -- Menu Header 6 | ["Text"] = "Police Issued K9 Unit Dog", 7 | ["Dog"] = "a_c_shepherd", -- Dog stats 8 | ["Colour"] = 3, -- Normally 1-3 -- Dog stats 9 | ["Vest"] = 3 -- Dog stats 10 | }, 11 | } 12 | 13 | Config.Autorhized = {["police"] = 4, ["parkranger"] = 2, ["bcso"] = 4} -- This is setup as [JOB] = [GRADE] 14 | 15 | Config.K9Search = { 16 | "joint", 17 | "cokebaggy", 18 | "crack_baggy", 19 | "xtcbaggy", 20 | "weed_white-widow", 21 | "weed_skunk", 22 | "weed_purple-haze", 23 | "weed_og-kush", 24 | "weed_amnesia", 25 | "weed_ak47", 26 | "weed_brick", 27 | "coke_brick", 28 | "coke_small_brick", 29 | "puremeth", 30 | "meth" 31 | }; 32 | -------------------------------------------------------------------------------- /locales/en.lua: -------------------------------------------------------------------------------- 1 | local Translations = { 2 | error = { 3 | ["k9_alert"] = "Dog did not alert", 4 | ["k9_toofar"] = " Is too far away!", 5 | ["k9_locaterror"] = " Unable to locate people..", 6 | ["k9_vehlocate"] = " Unable to locate vehicle..", 7 | ["k9_returnerror"] = "You returned the K9 Unit!", 8 | }, 9 | success = { 10 | ["k9_alert"] = "Dog Alerted!", 11 | }, 12 | info = { 13 | ["k9_name"] = "Renewed Scripts", 14 | ["k9_searching"] = " is searching..", 15 | ["k9_scent"] = " found a scent..", 16 | ["k9_nofollow"] = " is no longer tracking..", 17 | ["k9_lostscent"] = " lost the scent..", 18 | ["k9_purchase"] = "Patrol Dog", 19 | ["k9_return"] = "You returned the K9 Unit!", 20 | }, 21 | menu = { 22 | ["purchase_header"] = "🐶 | Police K9 Menu", 23 | ["k9_takeout"] = "🐕‍🦺 | Take out K9", 24 | ["takeout_txt"] = "Here you can take out one of departments avaible dogs", 25 | ["k9_return"] = "🐕 | Return K9", 26 | ["return_txt"] = "Here you can return one of the departments K9 Dogs", 27 | ["k9_commands"] = "Police K9 Commands", 28 | ["k9_sit"] = "🔈| K9 Sit", 29 | ["k9_sittxt"] = "Make your K9 Dog Sit", 30 | ["k9_lay"] = "🔈| K9 Lay Down", 31 | ["k9_laytxt"] = "Make your K9 Dog Lay Down", 32 | ["k9_carsearch"] = "🚗 | K9 Search Car", 33 | ["k9_carsearchtxt"] = "Make your K9 search nearby car", 34 | ["k9_enterveh"] = "🚘 | Put K9 in vehicle", 35 | ["k9_entervehtxt"] = "Tell your K9 to enter vehicle", 36 | ["k9_searchp"] = "🧍 | K9 Search Person", 37 | ["k9_searchptxt"] = "Make your K9 search nearby person", 38 | ["k9_area"] = "🌍 | K9 Search Area", 39 | ["k9_areatxt"] = "Make your K9 search area", 40 | } 41 | } 42 | Lang = Locale:new({ 43 | phrases = Translations, 44 | warnOnMissing = true 45 | }) -------------------------------------------------------------------------------- /locales/es.lua: -------------------------------------------------------------------------------- 1 | local Translations = { 2 | error = { 3 | ["k9_alert"] = "Perro canino no alerto!", 4 | ["k9_toofar"] = "Esta muy lejo!", 5 | ["k9_locaterror"] = "No se pudo encontrar delincuentes!", 6 | ["k9_vehlocate"] = "No se pudo encontrar el carro.", 7 | ["k9_returnerror"] = "Has devuelto la unidad canina., 8 | }, 9 | success = { 10 | ["k9_alert"] = "Unidad canina alterto!", 11 | }, 12 | info = { 13 | ["k9_name"] = "Renewed Scripts", 14 | ["k9_searching"] = "esta buscando...", 15 | ["k9_scent"] = "encontro un olor...", 16 | ["k9_nofollow"] = "ya no esta rastreando..", 17 | ["k9_lostscent"] = "perdido el olor...", 18 | ["k9_purchase"] = "Unidad Canina", 19 | ["k9_return"] = "Devolviste la unidad canina", 20 | }, 21 | menu = { 22 | ["purchase_header"] = "🐶 | Unidad Canina Policia", 23 | ["k9_takeout"] = "🐕‍🦺 | Sacar Unidad Canina", 24 | ["takeout_txt"] = "Aqui puedes sacar un perro canino", 25 | ["k9_return"] = "🐕 | Devolver K9", 26 | ["return_txt"] = "Aqui puedes devolver el perro canino", 27 | ["k9_commands"] = "Comandos", 28 | ["k9_sit"] = "🔈| K9 Sentarse", 29 | ["k9_sittxt"] = "Haz que tu perro K9 se siente", 30 | ["k9_lay"] = "🔈| K9 Acuestarse", 31 | ["k9_laytxt"] = "Haz que tu perro K9 se acueste", 32 | ["k9_carsearch"] = "🚗 | K9 Buscar auto", 33 | ["k9_carsearchtxt"] = "Haz que tu K9 busque un coche cercano", 34 | ["k9_enterveh"] = "🚘 | Poner K9 en el vehiculo", 35 | ["k9_entervehtxt"] = "Decir a K9 que entre al vehiculo", 36 | ["k9_searchp"] = "🧍 | K9 Buscar Persona", 37 | ["k9_searchptxt"] = "Haz que tu K9 busque a las personas cercanas", 38 | ["k9_area"] = "🌍 | K9 Buscar el Area", 39 | ["k9_areatxt"] = "Haz que tu perro busque en la zona", 40 | } 41 | } 42 | Lang = Locale:new({ 43 | phrases = Translations, 44 | warnOnMissing = true 45 | }) 46 | -------------------------------------------------------------------------------- /locales/da.lua: -------------------------------------------------------------------------------- 1 | local Translations = { 2 | error = { 3 | ["k9_alert"] = "Hunden gav ikke tegn", 4 | ["k9_toofar"] = " Er for for langt væk!", 5 | ["k9_locaterror"] = " Kunne ikke finde nogen!", 6 | ["k9_vehlocate"] = " Kunne ikke finde nogen biler!", 7 | ["k9_returnerror"] = "Der er ingenting at returnere", 8 | }, 9 | success = { 10 | ["k9_alert"] = "Hunden Gav Tegn!", 11 | }, 12 | info = { 13 | ["k9_name"] = "Renewed Scripts", 14 | ["k9_searching"] = " Leder efter kontrabande", 15 | ["k9_scent"] = " kan dufte noget..", 16 | ["k9_nofollow"] = " kunne ikke længere finde personen..", 17 | ["k9_lostscent"] = " mistede duften..", 18 | ["k9_purchase"] = "Patrulje Hund", 19 | ["k9_return"] = "Du returneret Politihunden!", 20 | }, 21 | menu = { 22 | ["purchase_header"] = "🐶 | Politi K9 Menu", 23 | ["k9_takeout"] = "🐕‍🦺 | Tag en K9 ud", 24 | ["takeout_txt"] = "Her kan du tage en af politihundene ud!", 25 | ["k9_return"] = "🐕 | Returner K9 hund", 26 | ["return_txt"] = "Her kan du returnere en af Politi k9 hundene!", 27 | ["k9_commands"] = "Politi k9 Kommandoer", 28 | ["k9_sit"] = "🔈| K9 Sit", 29 | ["k9_sittxt"] = "Få hunden til at sætte sig", 30 | ["k9_lay"] = "🔈| K9 Læg Dig", 31 | ["k9_laytxt"] = "Få hunden til at lægge sig ned", 32 | ["k9_carsearch"] = "🚗 | K9 Søg Bilen", 33 | ["k9_carsearchtxt"] = "Få din hund til at søge den tætteste bil!", 34 | ["k9_enterveh"] = "🚘 | Put k9 hunden I bilen!", 35 | ["k9_entervehtxt"] = "Få din k9 hund til at hoppe ind eller ud af bilen!", 36 | ["k9_searchp"] = "🧍 | K9 Søg Person", 37 | ["k9_searchptxt"] = "Få din K9 Hund til at søge den nærmeste person", 38 | ["k9_area"] = "🌍 | K9 Søg Område", 39 | ["k9_areatxt"] = "Få din K9 hund til at søge området", 40 | } 41 | } 42 | Lang = Locale:new({ 43 | phrases = Translations, 44 | warnOnMissing = true 45 | }) -------------------------------------------------------------------------------- /server/server.lua: -------------------------------------------------------------------------------- 1 | local QBCore = exports['qb-core']:GetCoreObject() 2 | 3 | RegisterServerEvent("K9:SERVER:SPAWN_K9", function(model, colour, vest) 4 | local PLAYER = QBCore.Functions.GetPlayer(source).PlayerData 5 | 6 | if PLAYER.job ~= nil and PLAYER.job.name == "police" and PLAYER.job.grade.level >= 2 then 7 | 8 | TriggerClientEvent("K9:CLIENT:SPAWN_K9", source, model, colour, vest) 9 | 10 | end 11 | 12 | end) 13 | 14 | RegisterServerEvent("K9:SERVER:SEARCH_PERSON") 15 | AddEventHandler("K9:SERVER:SEARCH_PERSON", function(target) 16 | 17 | local PLAYER_CHECK = HasIllegalItems(target) 18 | 19 | if PLAYER_CHECK then 20 | TriggerClientEvent("k9:client:search_results", source, true, 'person') 21 | end 22 | 23 | end) 24 | 25 | RegisterServerEvent("K9:SERVER:SEARCH_VEHICLE") 26 | AddEventHandler("K9:SERVER:SEARCH_VEHICLE", function(vehicle, players) 27 | 28 | SearchVehicle(source, vehicle, players) 29 | 30 | end) 31 | 32 | function SearchVehicle(source, vehicle, players) 33 | local VEHICLE_RESULTS = nil 34 | local PLAYER_RESULTS = false 35 | 36 | TriggerEvent("inventory:server:SearchLocalVehicleInventory", vehicle, Config.K9Search, function (results) 37 | VEHICLE_RESULTS = results 38 | end) 39 | 40 | while VEHICLE_RESULTS == nil do 41 | Citizen.Wait(0) 42 | end 43 | 44 | if not VEHICLE_RESULTS then 45 | for i = 1, #players do 46 | 47 | local ITEM = HasIllegalItems(players[i]) 48 | 49 | if ITEM then 50 | PLAYER_RESULTS = true 51 | break 52 | end 53 | end 54 | end 55 | 56 | if VEHICLE_RESULTS or PLAYER_RESULTS then 57 | TriggerClientEvent("k9:client:search_results", source, true, 'vehicle') 58 | else 59 | TriggerClientEvent("k9:client:search_results", source, false, 'vehicle') 60 | end 61 | end 62 | 63 | function HasIllegalItems(target) 64 | local Player = QBCore.Functions.GetPlayer(target) 65 | 66 | for i = 1, #Config.K9Search do 67 | 68 | local item = Player.Functions.GetItemByName(Config.K9Search[i]) 69 | 70 | if item ~= nil then 71 | return true 72 | end 73 | end 74 | 75 | return false 76 | end 77 | -------------------------------------------------------------------------------- /README.md: -------------------------------------------------------------------------------- 1 | # Police K9 Scripts originally forked from hashisx https://github.com/hashisx/hashx_k9 2 | 3 | # Use 4 | Purchase a dog from the location specified in the Config, use Z to follow or attack (Must be pointing a weapon to attack). 5 | 6 | Press K to show K9 Commands (Both of these are now keymaps so its a on user basis) 7 | 8 | # Searching 9 | 10 | You must be facing your target (vehicle or player) when selecting the Search Action, except for Search Area. 11 | Sometimes the Search Person will pick up the dog. Best to have the dog behind you. 12 | 13 | # K9 Ped 14 | The k9 ped I use personally from this script is from here https://forum.cfx.re/t/how-to-german-shepherd-malinois-k9-dog-1-0-1/1065040 15 | 16 | # You must add this to QB Inventory Server main.lua. 17 | ``` 18 | local function HasItem(list, item) 19 | 20 | for i = 1, #list do 21 | 22 | if item == list[i] then 23 | return true 24 | end 25 | end 26 | 27 | return false 28 | end 29 | 30 | AddEventHandler("inventory:server:SearchLocalVehicleInventory", function(plate, list, cb) 31 | local trunk = Trunks[plate] 32 | local glovebox = Gloveboxes[plate] 33 | local result = false 34 | 35 | if trunk ~= nil then 36 | for k, v in pairs(trunk.items) do 37 | local ITEM = trunk.items[k].name 38 | if HasItem(list, ITEM) then 39 | RESULT = true 40 | end 41 | end 42 | else 43 | trunk = GetOwnedVehicleItems(plate) 44 | 45 | for k, v in pairs(TRUNK) do 46 | 47 | local ITEM = TRUNK[k].name 48 | if HasItem(list, ITEM) then 49 | RESULT = true 50 | end 51 | end 52 | 53 | end 54 | 55 | if glovebox ~= nil then 56 | for k, v in pairs(glovebox.items) do 57 | 58 | local ITEM = glovebox.items[k].name 59 | if HasItem(list, ITEM) then 60 | RESULT = true 61 | end 62 | end 63 | else 64 | glovebox = GetOwnedVehicleGloveboxItems(plate) 65 | 66 | for k, v in pairs(glovebox) do 67 | local ITEM = glovebox[k].name 68 | if HasItem(list, ITEM) then 69 | RESULT = true 70 | end 71 | end 72 | end 73 | cb(RESULT) 74 | end) 75 | ``` 76 | -------------------------------------------------------------------------------- /client/client.lua: -------------------------------------------------------------------------------- 1 | local QBCore = exports['qb-core']:GetCoreObject() 2 | ---- ** Locales ** ---- 3 | local activate_k9 = false 4 | local k9_name = Lang:t("info.k9_name") 5 | local k9_id = false 6 | local searching = false 7 | local following = true 8 | 9 | local sit = { 10 | dict = "creatures@rottweiler@amb@world_dog_sitting@idle_a", 11 | anim = "idle_b" 12 | } 13 | local laydown = { 14 | dict = "creatures@rottweiler@amb@sleep_in_kennel@", 15 | anim = "sleep_in_kennel" 16 | } 17 | local searchhit = { 18 | dict = "creatures@rottweiler@indication@", 19 | anim = "indicate_high" 20 | } 21 | 22 | 23 | ---- ** Functions ** ---- 24 | ---- ** Sit and Lay animations ** ---- 25 | local function PlayAnimation(dict, anim) 26 | RequestAnimDict(dict) 27 | while not HasAnimDictLoaded(dict) do 28 | Wait(0) 29 | end 30 | local DOG = NetworkGetEntityFromNetworkId(k9_id) 31 | following = false 32 | TaskPlayAnim(DOG, dict, anim, 8.0, -8.0, -1, 2, 0.0, 0, 0, 0) 33 | end 34 | 35 | local function K9AttackorFollow(target) 36 | local DOG = NetworkGetEntityFromNetworkId(k9_id) 37 | if target then 38 | SetCanAttackFriendly(DOG, true, true); 39 | TaskPutPedDirectlyIntoMelee(DOG, target, 0.0, -1.0, 0.0, false); 40 | following = false 41 | QBCore.Functions.Notify(k9_name.." is attacking!", "error", 2000) 42 | else 43 | TaskFollowToOffsetOfEntity(DOG, PlayerPedId(), 0.5, -1.0, 0.0, 5.0, -1, 1.0, true); 44 | following = true 45 | QBCore.Functions.Notify(k9_name.." is following.", "primary", 2000) 46 | end 47 | end 48 | 49 | -- Spawns and Deletes K9 50 | local function DespawnK9() 51 | if k9_id then 52 | local DOG = NetworkGetEntityFromNetworkId(k9_id) 53 | if DoesEntityExist(DOG) then 54 | DeleteEntity(DOG) 55 | end 56 | end 57 | following = true 58 | k9_id = false 59 | searching = false 60 | end 61 | 62 | local function CheckK9Conditions() 63 | if k9_id then 64 | local DOG = NetworkGetEntityFromNetworkId(k9_id) 65 | local DOG_COORDS = GetEntityCoords(DOG) 66 | local PLAYER_COORDS = GetEntityCoords(PlayerPedId()) 67 | local DISTANCE = #(DOG_COORDS - PLAYER_COORDS) 68 | if DISTANCE > 100 and not IsPedInAnyVehicle(DOG, false) then 69 | K9AttackorFollow(false) 70 | end 71 | if IsEntityDead(DOG) or IsEntityDead(PlayerPedId()) then 72 | DespawnK9() 73 | end 74 | end 75 | end 76 | 77 | local function EnableK9(bool) 78 | SetPedRelationshipGroupHash(PlayerPedId(), GetHashKey("PLAYER_POLICE")) 79 | if bool then 80 | activate_k9 = true 81 | while activate_k9 do 82 | Wait(15000) 83 | CheckK9Conditions() 84 | end 85 | end 86 | end 87 | 88 | 89 | --Animation set if we found something. 90 | local function K9Found(status, type) 91 | local time = math.random(500,1500) 92 | if(type == 'vehicle') then 93 | time = math.random(1500,3500) 94 | end 95 | Wait(time) 96 | if status then 97 | QBCore.Functions.Notify(Lang:t("success.k9_alert"), "success", 4000) 98 | searching = false 99 | PlayAnimation(searchhit.dict, searchhit.anim) 100 | Wait(2500) 101 | PlayAnimation(sit.dict, sit.anim) 102 | following = false 103 | else 104 | QBCore.Functions.Notify(Lang:t("error.k9_alert"), "error", 4000) 105 | following = true 106 | end 107 | end 108 | 109 | -- Gets Closest Door To Player 110 | local function GetClosestVehicleDoor(vehicle) 111 | local PLAYER = GetEntityCoords(PlayerPedId(), false) 112 | local BACKLEFT = GetWorldPositionOfEntityBone(vehicle, GetEntityBoneIndexByName(vehicle, "door_dside_r")) 113 | local BACKRIGHT = GetWorldPositionOfEntityBone(vehicle, GetEntityBoneIndexByName(vehicle, "door_pside_r")) 114 | local BLDISTANCE = #(PLAYER - BACKLEFT) 115 | local BRDISTANCE = #(PLAYER - BACKRIGHT) 116 | 117 | local FOUND_DOOR = false 118 | 119 | if BLDISTANCE < BRDISTANCE then 120 | FOUND_DOOR = 2 121 | else 122 | FOUND_DOOR = 3 123 | end 124 | 125 | return FOUND_DOOR 126 | end 127 | 128 | local function K9ToggleVehicle(target) 129 | searching = false 130 | local DOG = NetworkGetEntityFromNetworkId(k9_id) 131 | local VEHICLE = QBCore.Functions.GetClosestVehicle() 132 | local DOOR = GetClosestVehicleDoor(VEHICLE) 133 | local PLAYER_COORDS = GetEntityCoords(PlayerPedId()) 134 | local VEHICLE_COORDS = GetEntityCoords(VEHICLE) 135 | local DOG_COORDS = GetEntityCoords(DOG) 136 | local SEAT = 0 137 | 138 | if #(VEHICLE_COORDS - DOG_COORDS) < 5 or target then 139 | if DOOR == 3 then 140 | SEAT = "seat_pside_r" 141 | else 142 | SEAT = "seat_dside_r" 143 | end 144 | if IsEntityAttached(DOG) then 145 | following = false 146 | SetEntityInvincible(DOG, true) 147 | SetPedCanRagdoll(DOG, false) 148 | --Get Vehicle Coords, Open Rear Passenger Door, Spawn Dog 149 | local DOOR_COORDS = GetEntryPositionOfDoor(VEHICLE, DOOR); 150 | local bool, gZero = GetGroundZFor_3dCoord(DOOR_COORDS.x, DOOR_COORDS.y, PLAYER_COORDS.z+5, false); 151 | 152 | SetVehicleDoorOpen(VEHICLE, DOOR, false, false); 153 | Wait(500) 154 | AttachEntityToEntity(DOG, VEHICLE, GetEntityBoneIndexByName(VEHICLE, SEAT), 0.0, -0.25, 0.40, 0.0, 0.0, 0, false, false, false, true, 20, true) 155 | Wait(500) 156 | DetachEntity(DOG, false, false) 157 | SetEntityCoords(DOG, DOOR_COORDS.x, DOOR_COORDS.y, gZero, false, false, false, false) 158 | ClearPedTasks(DOG) 159 | Wait(1500) 160 | K9AttackorFollow(target) 161 | SetPedCanRagdoll(DOG, true) 162 | SetEntityInvincible(DOG, false) 163 | SetVehicleDoorShut(VEHICLE, DOOR, false) 164 | 165 | else 166 | following = true 167 | SetVehicleDoorOpen(VEHICLE, DOOR, false, false) 168 | Wait(1500) 169 | AttachEntityToEntity(DOG, VEHICLE, GetEntityBoneIndexByName(VEHICLE, SEAT), 0.0, -0.25, 0.40, 0.0, 0.0, 0, false, false, false, true, 20, true) 170 | PlayAnimation(sit.dict, sit.anim) 171 | SetVehicleDoorShut(VEHICLE, DOOR, false) 172 | 173 | end 174 | else 175 | QBCore.Functions.Notify(k9_name..Lang:t("error.k9_toofar"), "error", 4000) 176 | end 177 | end 178 | 179 | -- Gets Players 180 | local function GetPlayers() 181 | local players = {} 182 | for i = 0, 256 do 183 | if NetworkIsPlayerActive(i) then 184 | table.insert(players, i) 185 | end 186 | end 187 | return players 188 | end 189 | 190 | local function K9SearchPerson() 191 | following = false 192 | local TARGET = GetPlayerSourceAheadOfPlayer() 193 | 194 | if TARGET > 0 then 195 | TriggerServerEvent("K9:SERVER:SEARCH_PERSON", TARGET) 196 | else 197 | QBCore.Functions.Notify(k9_name..Lang:t("error.k9_locaterror"), "error", 4500) 198 | end 199 | 200 | end 201 | 202 | -- Gets Player ID 203 | function GetPlayerId(target_ped) 204 | local players = GetPlayers() 205 | for a = 1, #players do 206 | 207 | local ped = GetPlayerPed(players[a]) 208 | local server_id = GetPlayerServerId(players[a]) 209 | if target_ped == ped then 210 | return server_id 211 | end 212 | end 213 | return 0 214 | end 215 | 216 | local function K9SearchVehicle() 217 | following = false 218 | local VEHICLE = QBCore.Functions.GetClosestVehicle() 219 | local PLATE = GetVehicleNumberPlateText(VEHICLE) 220 | local DOG = NetworkGetEntityFromNetworkId(k9_id) 221 | 222 | if VEHICLE then 223 | QBCore.Functions.Notify(k9_name..Lang:t("info.k9_searching"), "success", 4500) 224 | 225 | local PLAYERS = {} 226 | local MAX_SEATS = GetVehicleMaxNumberOfPassengers(VEHICLE) -2 227 | 228 | for i = -1, MAX_SEATS do 229 | 230 | local TARGET = GetPedInVehicleSeat(VEHICLE, i) 231 | 232 | if TARGET ~= nil then 233 | local SERVER_ID = GetPlayerId(TARGET) 234 | 235 | if SERVER_ID > 0 then 236 | table.insert(PLAYERS, SERVER_ID) 237 | end 238 | end 239 | 240 | end 241 | 242 | TriggerServerEvent("K9:SERVER:SEARCH_VEHICLE", PLATE, PLAYERS) 243 | 244 | searching = true 245 | 246 | if searching then 247 | local offset_1 = GetOffsetFromEntityInWorldCoords(VEHICLE, 2.0, -2.0, 0.0) 248 | TaskGoToCoordAnyMeans(DOG, offset_1.x, offset_1.y, offset_1.z, 5.0, 0, false, 1, 10.0) 249 | Wait(2500) 250 | end 251 | 252 | if searching then 253 | local offset_2 = GetOffsetFromEntityInWorldCoords(VEHICLE, 2.0, 2.0, 0.0) 254 | TaskGoToCoordAnyMeans(DOG, offset_2.x, offset_2.y, offset_2.z, 5.0, 0, false, 1, 10.0) 255 | Wait(2500) 256 | end 257 | 258 | if searching then 259 | local offset_3 = GetOffsetFromEntityInWorldCoords(VEHICLE, -2.0, 2.0, 0.0) 260 | TaskGoToCoordAnyMeans(DOG, offset_3.x, offset_3.y, offset_3.z, 5.0, 0, false, 1, 10.0) 261 | Wait(2500) 262 | end 263 | 264 | if searching then 265 | local offset_4 = GetOffsetFromEntityInWorldCoords(VEHICLE, -2.0, -2.0, 0.0) 266 | TaskGoToCoordAnyMeans(DOG, offset_4.x, offset_4.y, offset_4.z, 5.0, 0, false, 1, 10.0) 267 | Wait(2500) 268 | end 269 | 270 | searching = false 271 | else 272 | QBCore.Functions.Notify(Lang:t("error.k9_vehlocate"), "error", 4000) 273 | end 274 | end 275 | 276 | -- Gets Player ID 277 | local function GetPlayersInRadius(min, max) 278 | local players = GetPlayers() 279 | local IN_RANGE = {} 280 | for a = 1, #players do 281 | 282 | local PED = GetPlayerPed(players[a]) 283 | local PED_COORDS = GetEntityCoords(PED) 284 | local PLAYER_COORDS = GetEntityCoords(PlayerPedId()) 285 | local DISTANCE = #(PED_COORDS - PLAYER_COORDS) 286 | 287 | if DISTANCE <= max and DISTANCE >= min then 288 | table.insert(IN_RANGE, PED) 289 | end 290 | 291 | end 292 | return IN_RANGE 293 | end 294 | 295 | local function K9SearchArea() 296 | local PLAYERS = GetPlayersInRadius(20,75) 297 | 298 | for i = 1, #PLAYERS do 299 | following = false 300 | QBCore.Functions.Notify(k9_name..Lang:t("info.k9_scent"), "primary", 4000) 301 | local DOG = NetworkGetEntityFromNetworkId(k9_id) 302 | local DOG_COORDS = GetEntityCoords(DOG) 303 | local COORDS = GetEntityCoords(PLAYERS[i]) 304 | TaskGoToCoordAnyMeans(DOG, COORDS.x, COORDS.y, COORDS.z, 5.0, 0, false, 1, 10.0) 305 | 306 | while #(DOG_COORDS - COORDS) > 2 do 307 | Wait(1000) 308 | DOG_COORDS = GetEntityCoords(DOG) 309 | if following then 310 | break 311 | end 312 | end 313 | 314 | if following then 315 | QBCore.Functions.Notify(k9_name..Lang:t("info.k9_nofollow"), "primary", 4000) 316 | break 317 | end 318 | QBCore.Functions.Notify(k9_name..Lang:t("info.k9_lostscent"), "primary", 4000) 319 | K9AttackorFollow(false) 320 | Wait(2000) 321 | end 322 | 323 | end 324 | 325 | -- Gets Control Of Ped 326 | local function RequestNetworkControl() 327 | NetworkRequestControlOfNetworkId(k9_id) 328 | while not NetworkHasControlOfNetworkId(k9_id) do 329 | Wait(500) 330 | NetworkRequestControlOfNetworkId(k9_id) 331 | end 332 | end 333 | 334 | function GetPlayerSourceAheadOfPlayer() 335 | local PLAYER = PlayerPedId() 336 | local COORDS = GetEntityCoords(PLAYER) 337 | local OFFSET = GetOffsetFromEntityInWorldCoords(PLAYER, 0.0, 2.0, 0.0) 338 | local RAY = StartShapeTestCapsule(COORDS.x, COORDS.y, COORDS.z, OFFSET.x, OFFSET.y, OFFSET.z, 0.5, 12, PLAYER, 7) 339 | local RETURN, HIT, ENDCOORDS, SURFACE, PED = GetShapeTestResult(RAY) 340 | 341 | if HIT then 342 | return GetPlayerId(PED) 343 | else 344 | return false 345 | end 346 | 347 | end 348 | 349 | 350 | ---- ** Job Handlers ** ---- 351 | 352 | AddEventHandler('QBCore:Client:OnPlayerLoaded', function() 353 | local player = QBCore.Functions.GetPlayerData() 354 | PlayerJob = player.job 355 | 356 | if PlayerJob or PlayerJob.name == "police" then 357 | EnableK9() 358 | end 359 | end) 360 | 361 | RegisterNetEvent('QBCore:Client:OnPlayerUnload', function() 362 | DespawnK9() 363 | end) 364 | 365 | RegisterNetEvent('QBCore:Client:OnJobUpdate', function(JobInfo) 366 | PlayerJob = JobInfo 367 | if JobInfo.name == "police" then 368 | EnableK9() 369 | end 370 | end) 371 | 372 | ---- ** Create Threads ** ---- 373 | CreateThread(function() 374 | exports['qb-target']:AddBoxZone("1234", vector3(458.95, -1016.99, 28.17), 1.5, 1.6, { 375 | name = "1234", 376 | heading = 102.0, 377 | debugPoly = false, 378 | minZ = 25.7, 379 | maxZ = 30.9, 380 | }, { 381 | options = { 382 | { 383 | type = "client", 384 | event = "qb-k9:client:menu", 385 | icon = 'fa-solid fa-dog', 386 | label = Lang:t("info.k9_lostscent"), 387 | job = Config.Autorhized, 388 | } 389 | }, 390 | distance = 2.5, 391 | }) 392 | end) 393 | 394 | ---- ** Register NetEvents ** ---- 395 | 396 | RegisterNetEvent('qb-k9:client:menu', function() 397 | local K9Purchase = { 398 | { 399 | header = Lang:t("menu.purchase_header"), 400 | isMenuHeader = true 401 | }, 402 | { 403 | header = Lang:t("menu.k9_takeout"), 404 | txt = Lang:t("menu.takeout_txt"), 405 | params = { 406 | event = 'qb-k9:client:PurchaseDog', 407 | } 408 | }, 409 | { 410 | header = Lang:t("menu.k9_return"), 411 | txt = Lang:t("menu.return_txt"), 412 | params = { 413 | event = 'qb-k9:client:ReturnDoggo', 414 | } 415 | }, 416 | } 417 | 418 | exports['qb-menu']:openMenu(K9Purchase) 419 | end) 420 | 421 | RegisterNetEvent('qb-k9:client:ReturnDoggo', function() 422 | if k9_id then 423 | DespawnK9() 424 | QBCore.Functions.Notify(Lang:t("info.k9_return"), "success", 4500) 425 | else 426 | QBCore.Functions.Notify(Lang:t("error.k9_returnerror"), "error", 4500) 427 | end 428 | end) 429 | 430 | 431 | RegisterNetEvent('qb-k9:client:PurchaseDog', function() 432 | if k9_id then 433 | DespawnK9() 434 | end 435 | 436 | local K9Dawgs = {} 437 | for k,v in pairs(Config.DogModelProps) do 438 | K9Dawgs[#K9Dawgs + 1] = { 439 | header = Config.DogModelProps[k]["Header"], 440 | txt = Config.DogModelProps[k]["Text"], 441 | params = { 442 | event = 'qb-k9:client:SpawnHandler', 443 | args = { 444 | model = Config.DogModelProps[k]["Dog"], 445 | colour = Config.DogModelProps[k]["Colour"], 446 | vest = Config.DogModelProps[k]["Vest"], 447 | } 448 | } 449 | } 450 | end 451 | exports['qb-menu']:openMenu(K9Dawgs) 452 | end) 453 | 454 | RegisterNetEvent('qb-k9:client:SpawnHandler', function(data) 455 | TriggerServerEvent("K9:SERVER:SPAWN_K9", data.model, data.colour, data.vest) 456 | end) 457 | 458 | --- SPAWN EVENT 459 | RegisterNetEvent('K9:CLIENT:SPAWN_K9', function(DawgHash, colour, vest) 460 | local pos = GetEntityCoords(PlayerPedId()) 461 | local heading = GetEntityHeading(PlayerPedId()) 462 | RequestModel(DawgHash); 463 | 464 | while not HasModelLoaded(DawgHash) do 465 | Wait(1) 466 | RequestModel(DawgHash); 467 | end 468 | 469 | local DOG = CreatePed(28, DawgHash, pos.x, pos.y, pos.z, heading, true, true) 470 | 471 | --SET NET ID FOR DOG 472 | k9_id = NetworkGetNetworkIdFromEntity(DOG) 473 | --REQEUST CONTROL 474 | RequestNetworkControl() 475 | --GET ENTITY 476 | local DOG = NetworkGetEntityFromNetworkId(k9_id) 477 | --set K9 Properties 478 | SetPedComponentVariation(DOG, 0, 0, colour, 0) 479 | SetPedComponentVariation(DOG, vest, 0, 1, 0) 480 | SetBlockingOfNonTemporaryEvents(DOG, true) 481 | SetPedFleeAttributes(DOG, 0, false) 482 | SetPedRelationshipGroupHash(DOG, GetHashKey("PLAYER_POLICE")) 483 | SetPedArmour(DOG, 25) 484 | SetEntityHeading(DOG, 90) 485 | 486 | ---- ** BLIPS ** ---- 487 | local BLIP = AddBlipForEntity(DOG) 488 | SetBlipAsFriendly(BLIP, true) 489 | SetBlipSprite(BLIP, 442) 490 | BeginTextCommandSetBlipName("STRING") 491 | AddTextComponentString(k9_name) 492 | EndTextCommandSetBlipName(BLIP) 493 | K9AttackorFollow(false) 494 | 495 | ---- ** Enable K9 ** ---- 496 | EnableK9(true) 497 | end) 498 | 499 | 500 | RegisterNetEvent('k9:client:search_results', function(status, type) 501 | if status then 502 | K9Found(status, type) 503 | end 504 | end) 505 | 506 | 507 | ---- ** Register Commands ** ---- 508 | 509 | RegisterKeyMapping('caninecommanders', 'K9 COMMANDS POLICE ONLY', 'keyboard', 'K') 510 | 511 | RegisterCommand("caninecommanders", function() 512 | if activate_k9 then 513 | local k9Commands = { 514 | { 515 | header = Lang:t("menu.k9_commands"), 516 | isMenuHeader = true 517 | }, 518 | { 519 | header = Lang:t("menu.k9_sit"), 520 | txt = Lang:t("menu.k9_sittxt"), 521 | params = { 522 | event = 'qb-k9:client:Commands', 523 | args = "sit" 524 | } 525 | }, 526 | { 527 | header = Lang:t("menu.k9_lay"), 528 | txt = Lang:t("menu.k9_laytxt"), 529 | params = { 530 | event = 'qb-k9:client:Commands', 531 | args = "laydown" 532 | } 533 | }, 534 | { 535 | header = Lang:t("menu.k9_carsearch"), 536 | txt = Lang:t("menu.k9_carsearchtxt"), 537 | params = { 538 | event = 'qb-k9:client:Commands', 539 | args = "searchcar" 540 | } 541 | }, 542 | { 543 | header = Lang:t("menu.k9_enterveh"), 544 | txt = Lang:t("menu.k9_entervehtxt"), 545 | params = { 546 | event = 'qb-k9:client:Commands', 547 | args = "entercar" 548 | } 549 | }, 550 | { 551 | header = Lang:t("menu.k9_searchp"), 552 | txt = Lang:t("menu.k9_searchptxt"), 553 | params = { 554 | event = 'qb-k9:client:Commands', 555 | args = "searchdude" 556 | } 557 | }, 558 | { 559 | header = Lang:t("menu.k9_area"), 560 | txt = Lang:t("menu.k9_areatxt"), 561 | params = { 562 | event = 'qb-k9:client:Commands', 563 | args = "searcharea" 564 | } 565 | }, 566 | } 567 | exports['qb-menu']:openMenu(k9Commands) 568 | end 569 | end, false) 570 | 571 | RegisterKeyMapping('cannineattackfollow', 'K9 COMMANDS POLICE ONLY', 'keyboard', 'Z') 572 | 573 | RegisterCommand("cannineattackfollow", function() 574 | if activate_k9 then 575 | local ped = PlayerPedId() 576 | if IsPlayerFreeAiming(PlayerId()) then 577 | local bool, target = GetEntityPlayerIsFreeAimingAt(PlayerId()) 578 | if bool then 579 | if IsEntityAPed(target) then 580 | following = false 581 | local DOG = NetworkGetEntityFromNetworkId(k9_id) 582 | 583 | if IsEntityAttached(DOG) then 584 | K9ToggleVehicle(target) 585 | else 586 | K9AttackorFollow(target) 587 | end 588 | end 589 | end 590 | else 591 | if not following then 592 | K9AttackorFollow(false) 593 | following = true 594 | end 595 | end 596 | end 597 | end, false) 598 | 599 | RegisterNetEvent('qb-k9:client:Commands', function(data) 600 | if data == "sit" then 601 | PlayAnimation(sit.dict, sit.anim) 602 | elseif data == "laydown" then 603 | PlayAnimation(laydown.dict, laydown.anim) 604 | elseif data == "searchcar" then 605 | K9SearchVehicle() 606 | elseif data == "entercar" then 607 | K9ToggleVehicle(false) 608 | elseif data == "searchdude" then 609 | K9SearchPerson() 610 | elseif data == "searcharea" then 611 | K9SearchArea() 612 | end 613 | end) 614 | -------------------------------------------------------------------------------- /LICENSE: -------------------------------------------------------------------------------- 1 | GNU GENERAL PUBLIC LICENSE 2 | Version 3, 29 June 2007 3 | 4 | Copyright (C) 2007 Free Software Foundation, Inc. 5 | Everyone is permitted to copy and distribute verbatim copies 6 | of this license document, but changing it is not allowed. 7 | 8 | Preamble 9 | 10 | The GNU General Public License is a free, copyleft license for 11 | software and other kinds of works. 12 | 13 | The licenses for most software and other practical works are designed 14 | to take away your freedom to share and change the works. By contrast, 15 | the GNU General Public License is intended to guarantee your freedom to 16 | share and change all versions of a program--to make sure it remains free 17 | software for all its users. We, the Free Software Foundation, use the 18 | GNU General Public License for most of our software; it applies also to 19 | any other work released this way by its authors. You can apply it to 20 | your programs, too. 21 | 22 | When we speak of free software, we are referring to freedom, not 23 | price. Our General Public Licenses are designed to make sure that you 24 | have the freedom to distribute copies of free software (and charge for 25 | them if you wish), that you receive source code or can get it if you 26 | want it, that you can change the software or use pieces of it in new 27 | free programs, and that you know you can do these things. 28 | 29 | To protect your rights, we need to prevent others from denying you 30 | these rights or asking you to surrender the rights. Therefore, you have 31 | certain responsibilities if you distribute copies of the software, or if 32 | you modify it: responsibilities to respect the freedom of others. 33 | 34 | For example, if you distribute copies of such a program, whether 35 | gratis or for a fee, you must pass on to the recipients the same 36 | freedoms that you received. You must make sure that they, too, receive 37 | or can get the source code. And you must show them these terms so they 38 | know their rights. 39 | 40 | Developers that use the GNU GPL protect your rights with two steps: 41 | (1) assert copyright on the software, and (2) offer you this License 42 | giving you legal permission to copy, distribute and/or modify it. 43 | 44 | For the developers' and authors' protection, the GPL clearly explains 45 | that there is no warranty for this free software. For both users' and 46 | authors' sake, the GPL requires that modified versions be marked as 47 | changed, so that their problems will not be attributed erroneously to 48 | authors of previous versions. 49 | 50 | Some devices are designed to deny users access to install or run 51 | modified versions of the software inside them, although the manufacturer 52 | can do so. This is fundamentally incompatible with the aim of 53 | protecting users' freedom to change the software. The systematic 54 | pattern of such abuse occurs in the area of products for individuals to 55 | use, which is precisely where it is most unacceptable. Therefore, we 56 | have designed this version of the GPL to prohibit the practice for those 57 | products. If such problems arise substantially in other domains, we 58 | stand ready to extend this provision to those domains in future versions 59 | of the GPL, as needed to protect the freedom of users. 60 | 61 | Finally, every program is threatened constantly by software patents. 62 | States should not allow patents to restrict development and use of 63 | software on general-purpose computers, but in those that do, we wish to 64 | avoid the special danger that patents applied to a free program could 65 | make it effectively proprietary. To prevent this, the GPL assures that 66 | patents cannot be used to render the program non-free. 67 | 68 | The precise terms and conditions for copying, distribution and 69 | modification follow. 70 | 71 | TERMS AND CONDITIONS 72 | 73 | 0. Definitions. 74 | 75 | "This License" refers to version 3 of the GNU General Public License. 76 | 77 | "Copyright" also means copyright-like laws that apply to other kinds of 78 | works, such as semiconductor masks. 79 | 80 | "The Program" refers to any copyrightable work licensed under this 81 | License. Each licensee is addressed as "you". "Licensees" and 82 | "recipients" may be individuals or organizations. 83 | 84 | To "modify" a work means to copy from or adapt all or part of the work 85 | in a fashion requiring copyright permission, other than the making of an 86 | exact copy. The resulting work is called a "modified version" of the 87 | earlier work or a work "based on" the earlier work. 88 | 89 | A "covered work" means either the unmodified Program or a work based 90 | on the Program. 91 | 92 | To "propagate" a work means to do anything with it that, without 93 | permission, would make you directly or secondarily liable for 94 | infringement under applicable copyright law, except executing it on a 95 | computer or modifying a private copy. Propagation includes copying, 96 | distribution (with or without modification), making available to the 97 | public, and in some countries other activities as well. 98 | 99 | To "convey" a work means any kind of propagation that enables other 100 | parties to make or receive copies. Mere interaction with a user through 101 | a computer network, with no transfer of a copy, is not conveying. 102 | 103 | An interactive user interface displays "Appropriate Legal Notices" 104 | to the extent that it includes a convenient and prominently visible 105 | feature that (1) displays an appropriate copyright notice, and (2) 106 | tells the user that there is no warranty for the work (except to the 107 | extent that warranties are provided), that licensees may convey the 108 | work under this License, and how to view a copy of this License. If 109 | the interface presents a list of user commands or options, such as a 110 | menu, a prominent item in the list meets this criterion. 111 | 112 | 1. Source Code. 113 | 114 | The "source code" for a work means the preferred form of the work 115 | for making modifications to it. "Object code" means any non-source 116 | form of a work. 117 | 118 | A "Standard Interface" means an interface that either is an official 119 | standard defined by a recognized standards body, or, in the case of 120 | interfaces specified for a particular programming language, one that 121 | is widely used among developers working in that language. 122 | 123 | The "System Libraries" of an executable work include anything, other 124 | than the work as a whole, that (a) is included in the normal form of 125 | packaging a Major Component, but which is not part of that Major 126 | Component, and (b) serves only to enable use of the work with that 127 | Major Component, or to implement a Standard Interface for which an 128 | implementation is available to the public in source code form. A 129 | "Major Component", in this context, means a major essential component 130 | (kernel, window system, and so on) of the specific operating system 131 | (if any) on which the executable work runs, or a compiler used to 132 | produce the work, or an object code interpreter used to run it. 133 | 134 | The "Corresponding Source" for a work in object code form means all 135 | the source code needed to generate, install, and (for an executable 136 | work) run the object code and to modify the work, including scripts to 137 | control those activities. However, it does not include the work's 138 | System Libraries, or general-purpose tools or generally available free 139 | programs which are used unmodified in performing those activities but 140 | which are not part of the work. For example, Corresponding Source 141 | includes interface definition files associated with source files for 142 | the work, and the source code for shared libraries and dynamically 143 | linked subprograms that the work is specifically designed to require, 144 | such as by intimate data communication or control flow between those 145 | subprograms and other parts of the work. 146 | 147 | The Corresponding Source need not include anything that users 148 | can regenerate automatically from other parts of the Corresponding 149 | Source. 150 | 151 | The Corresponding Source for a work in source code form is that 152 | same work. 153 | 154 | 2. Basic Permissions. 155 | 156 | All rights granted under this License are granted for the term of 157 | copyright on the Program, and are irrevocable provided the stated 158 | conditions are met. This License explicitly affirms your unlimited 159 | permission to run the unmodified Program. The output from running a 160 | covered work is covered by this License only if the output, given its 161 | content, constitutes a covered work. This License acknowledges your 162 | rights of fair use or other equivalent, as provided by copyright law. 163 | 164 | You may make, run and propagate covered works that you do not 165 | convey, without conditions so long as your license otherwise remains 166 | in force. You may convey covered works to others for the sole purpose 167 | of having them make modifications exclusively for you, or provide you 168 | with facilities for running those works, provided that you comply with 169 | the terms of this License in conveying all material for which you do 170 | not control copyright. Those thus making or running the covered works 171 | for you must do so exclusively on your behalf, under your direction 172 | and control, on terms that prohibit them from making any copies of 173 | your copyrighted material outside their relationship with you. 174 | 175 | Conveying under any other circumstances is permitted solely under 176 | the conditions stated below. Sublicensing is not allowed; section 10 177 | makes it unnecessary. 178 | 179 | 3. Protecting Users' Legal Rights From Anti-Circumvention Law. 180 | 181 | No covered work shall be deemed part of an effective technological 182 | measure under any applicable law fulfilling obligations under article 183 | 11 of the WIPO copyright treaty adopted on 20 December 1996, or 184 | similar laws prohibiting or restricting circumvention of such 185 | measures. 186 | 187 | When you convey a covered work, you waive any legal power to forbid 188 | circumvention of technological measures to the extent such circumvention 189 | is effected by exercising rights under this License with respect to 190 | the covered work, and you disclaim any intention to limit operation or 191 | modification of the work as a means of enforcing, against the work's 192 | users, your or third parties' legal rights to forbid circumvention of 193 | technological measures. 194 | 195 | 4. Conveying Verbatim Copies. 196 | 197 | You may convey verbatim copies of the Program's source code as you 198 | receive it, in any medium, provided that you conspicuously and 199 | appropriately publish on each copy an appropriate copyright notice; 200 | keep intact all notices stating that this License and any 201 | non-permissive terms added in accord with section 7 apply to the code; 202 | keep intact all notices of the absence of any warranty; and give all 203 | recipients a copy of this License along with the Program. 204 | 205 | You may charge any price or no price for each copy that you convey, 206 | and you may offer support or warranty protection for a fee. 207 | 208 | 5. Conveying Modified Source Versions. 209 | 210 | You may convey a work based on the Program, or the modifications to 211 | produce it from the Program, in the form of source code under the 212 | terms of section 4, provided that you also meet all of these conditions: 213 | 214 | a) The work must carry prominent notices stating that you modified 215 | it, and giving a relevant date. 216 | 217 | b) The work must carry prominent notices stating that it is 218 | released under this License and any conditions added under section 219 | 7. This requirement modifies the requirement in section 4 to 220 | "keep intact all notices". 221 | 222 | c) You must license the entire work, as a whole, under this 223 | License to anyone who comes into possession of a copy. This 224 | License will therefore apply, along with any applicable section 7 225 | additional terms, to the whole of the work, and all its parts, 226 | regardless of how they are packaged. This License gives no 227 | permission to license the work in any other way, but it does not 228 | invalidate such permission if you have separately received it. 229 | 230 | d) If the work has interactive user interfaces, each must display 231 | Appropriate Legal Notices; however, if the Program has interactive 232 | interfaces that do not display Appropriate Legal Notices, your 233 | work need not make them do so. 234 | 235 | A compilation of a covered work with other separate and independent 236 | works, which are not by their nature extensions of the covered work, 237 | and which are not combined with it such as to form a larger program, 238 | in or on a volume of a storage or distribution medium, is called an 239 | "aggregate" if the compilation and its resulting copyright are not 240 | used to limit the access or legal rights of the compilation's users 241 | beyond what the individual works permit. Inclusion of a covered work 242 | in an aggregate does not cause this License to apply to the other 243 | parts of the aggregate. 244 | 245 | 6. Conveying Non-Source Forms. 246 | 247 | You may convey a covered work in object code form under the terms 248 | of sections 4 and 5, provided that you also convey the 249 | machine-readable Corresponding Source under the terms of this License, 250 | in one of these ways: 251 | 252 | a) Convey the object code in, or embodied in, a physical product 253 | (including a physical distribution medium), accompanied by the 254 | Corresponding Source fixed on a durable physical medium 255 | customarily used for software interchange. 256 | 257 | b) Convey the object code in, or embodied in, a physical product 258 | (including a physical distribution medium), accompanied by a 259 | written offer, valid for at least three years and valid for as 260 | long as you offer spare parts or customer support for that product 261 | model, to give anyone who possesses the object code either (1) a 262 | copy of the Corresponding Source for all the software in the 263 | product that is covered by this License, on a durable physical 264 | medium customarily used for software interchange, for a price no 265 | more than your reasonable cost of physically performing this 266 | conveying of source, or (2) access to copy the 267 | Corresponding Source from a network server at no charge. 268 | 269 | c) Convey individual copies of the object code with a copy of the 270 | written offer to provide the Corresponding Source. This 271 | alternative is allowed only occasionally and noncommercially, and 272 | only if you received the object code with such an offer, in accord 273 | with subsection 6b. 274 | 275 | d) Convey the object code by offering access from a designated 276 | place (gratis or for a charge), and offer equivalent access to the 277 | Corresponding Source in the same way through the same place at no 278 | further charge. You need not require recipients to copy the 279 | Corresponding Source along with the object code. If the place to 280 | copy the object code is a network server, the Corresponding Source 281 | may be on a different server (operated by you or a third party) 282 | that supports equivalent copying facilities, provided you maintain 283 | clear directions next to the object code saying where to find the 284 | Corresponding Source. Regardless of what server hosts the 285 | Corresponding Source, you remain obligated to ensure that it is 286 | available for as long as needed to satisfy these requirements. 287 | 288 | e) Convey the object code using peer-to-peer transmission, provided 289 | you inform other peers where the object code and Corresponding 290 | Source of the work are being offered to the general public at no 291 | charge under subsection 6d. 292 | 293 | A separable portion of the object code, whose source code is excluded 294 | from the Corresponding Source as a System Library, need not be 295 | included in conveying the object code work. 296 | 297 | A "User Product" is either (1) a "consumer product", which means any 298 | tangible personal property which is normally used for personal, family, 299 | or household purposes, or (2) anything designed or sold for incorporation 300 | into a dwelling. In determining whether a product is a consumer product, 301 | doubtful cases shall be resolved in favor of coverage. For a particular 302 | product received by a particular user, "normally used" refers to a 303 | typical or common use of that class of product, regardless of the status 304 | of the particular user or of the way in which the particular user 305 | actually uses, or expects or is expected to use, the product. A product 306 | is a consumer product regardless of whether the product has substantial 307 | commercial, industrial or non-consumer uses, unless such uses represent 308 | the only significant mode of use of the product. 309 | 310 | "Installation Information" for a User Product means any methods, 311 | procedures, authorization keys, or other information required to install 312 | and execute modified versions of a covered work in that User Product from 313 | a modified version of its Corresponding Source. The information must 314 | suffice to ensure that the continued functioning of the modified object 315 | code is in no case prevented or interfered with solely because 316 | modification has been made. 317 | 318 | If you convey an object code work under this section in, or with, or 319 | specifically for use in, a User Product, and the conveying occurs as 320 | part of a transaction in which the right of possession and use of the 321 | User Product is transferred to the recipient in perpetuity or for a 322 | fixed term (regardless of how the transaction is characterized), the 323 | Corresponding Source conveyed under this section must be accompanied 324 | by the Installation Information. But this requirement does not apply 325 | if neither you nor any third party retains the ability to install 326 | modified object code on the User Product (for example, the work has 327 | been installed in ROM). 328 | 329 | The requirement to provide Installation Information does not include a 330 | requirement to continue to provide support service, warranty, or updates 331 | for a work that has been modified or installed by the recipient, or for 332 | the User Product in which it has been modified or installed. Access to a 333 | network may be denied when the modification itself materially and 334 | adversely affects the operation of the network or violates the rules and 335 | protocols for communication across the network. 336 | 337 | Corresponding Source conveyed, and Installation Information provided, 338 | in accord with this section must be in a format that is publicly 339 | documented (and with an implementation available to the public in 340 | source code form), and must require no special password or key for 341 | unpacking, reading or copying. 342 | 343 | 7. Additional Terms. 344 | 345 | "Additional permissions" are terms that supplement the terms of this 346 | License by making exceptions from one or more of its conditions. 347 | Additional permissions that are applicable to the entire Program shall 348 | be treated as though they were included in this License, to the extent 349 | that they are valid under applicable law. If additional permissions 350 | apply only to part of the Program, that part may be used separately 351 | under those permissions, but the entire Program remains governed by 352 | this License without regard to the additional permissions. 353 | 354 | When you convey a copy of a covered work, you may at your option 355 | remove any additional permissions from that copy, or from any part of 356 | it. (Additional permissions may be written to require their own 357 | removal in certain cases when you modify the work.) You may place 358 | additional permissions on material, added by you to a covered work, 359 | for which you have or can give appropriate copyright permission. 360 | 361 | Notwithstanding any other provision of this License, for material you 362 | add to a covered work, you may (if authorized by the copyright holders of 363 | that material) supplement the terms of this License with terms: 364 | 365 | a) Disclaiming warranty or limiting liability differently from the 366 | terms of sections 15 and 16 of this License; or 367 | 368 | b) Requiring preservation of specified reasonable legal notices or 369 | author attributions in that material or in the Appropriate Legal 370 | Notices displayed by works containing it; or 371 | 372 | c) Prohibiting misrepresentation of the origin of that material, or 373 | requiring that modified versions of such material be marked in 374 | reasonable ways as different from the original version; or 375 | 376 | d) Limiting the use for publicity purposes of names of licensors or 377 | authors of the material; or 378 | 379 | e) Declining to grant rights under trademark law for use of some 380 | trade names, trademarks, or service marks; or 381 | 382 | f) Requiring indemnification of licensors and authors of that 383 | material by anyone who conveys the material (or modified versions of 384 | it) with contractual assumptions of liability to the recipient, for 385 | any liability that these contractual assumptions directly impose on 386 | those licensors and authors. 387 | 388 | All other non-permissive additional terms are considered "further 389 | restrictions" within the meaning of section 10. If the Program as you 390 | received it, or any part of it, contains a notice stating that it is 391 | governed by this License along with a term that is a further 392 | restriction, you may remove that term. If a license document contains 393 | a further restriction but permits relicensing or conveying under this 394 | License, you may add to a covered work material governed by the terms 395 | of that license document, provided that the further restriction does 396 | not survive such relicensing or conveying. 397 | 398 | If you add terms to a covered work in accord with this section, you 399 | must place, in the relevant source files, a statement of the 400 | additional terms that apply to those files, or a notice indicating 401 | where to find the applicable terms. 402 | 403 | Additional terms, permissive or non-permissive, may be stated in the 404 | form of a separately written license, or stated as exceptions; 405 | the above requirements apply either way. 406 | 407 | 8. Termination. 408 | 409 | You may not propagate or modify a covered work except as expressly 410 | provided under this License. Any attempt otherwise to propagate or 411 | modify it is void, and will automatically terminate your rights under 412 | this License (including any patent licenses granted under the third 413 | paragraph of section 11). 414 | 415 | However, if you cease all violation of this License, then your 416 | license from a particular copyright holder is reinstated (a) 417 | provisionally, unless and until the copyright holder explicitly and 418 | finally terminates your license, and (b) permanently, if the copyright 419 | holder fails to notify you of the violation by some reasonable means 420 | prior to 60 days after the cessation. 421 | 422 | Moreover, your license from a particular copyright holder is 423 | reinstated permanently if the copyright holder notifies you of the 424 | violation by some reasonable means, this is the first time you have 425 | received notice of violation of this License (for any work) from that 426 | copyright holder, and you cure the violation prior to 30 days after 427 | your receipt of the notice. 428 | 429 | Termination of your rights under this section does not terminate the 430 | licenses of parties who have received copies or rights from you under 431 | this License. If your rights have been terminated and not permanently 432 | reinstated, you do not qualify to receive new licenses for the same 433 | material under section 10. 434 | 435 | 9. Acceptance Not Required for Having Copies. 436 | 437 | You are not required to accept this License in order to receive or 438 | run a copy of the Program. Ancillary propagation of a covered work 439 | occurring solely as a consequence of using peer-to-peer transmission 440 | to receive a copy likewise does not require acceptance. However, 441 | nothing other than this License grants you permission to propagate or 442 | modify any covered work. These actions infringe copyright if you do 443 | not accept this License. Therefore, by modifying or propagating a 444 | covered work, you indicate your acceptance of this License to do so. 445 | 446 | 10. Automatic Licensing of Downstream Recipients. 447 | 448 | Each time you convey a covered work, the recipient automatically 449 | receives a license from the original licensors, to run, modify and 450 | propagate that work, subject to this License. You are not responsible 451 | for enforcing compliance by third parties with this License. 452 | 453 | An "entity transaction" is a transaction transferring control of an 454 | organization, or substantially all assets of one, or subdividing an 455 | organization, or merging organizations. If propagation of a covered 456 | work results from an entity transaction, each party to that 457 | transaction who receives a copy of the work also receives whatever 458 | licenses to the work the party's predecessor in interest had or could 459 | give under the previous paragraph, plus a right to possession of the 460 | Corresponding Source of the work from the predecessor in interest, if 461 | the predecessor has it or can get it with reasonable efforts. 462 | 463 | You may not impose any further restrictions on the exercise of the 464 | rights granted or affirmed under this License. For example, you may 465 | not impose a license fee, royalty, or other charge for exercise of 466 | rights granted under this License, and you may not initiate litigation 467 | (including a cross-claim or counterclaim in a lawsuit) alleging that 468 | any patent claim is infringed by making, using, selling, offering for 469 | sale, or importing the Program or any portion of it. 470 | 471 | 11. Patents. 472 | 473 | A "contributor" is a copyright holder who authorizes use under this 474 | License of the Program or a work on which the Program is based. The 475 | work thus licensed is called the contributor's "contributor version". 476 | 477 | A contributor's "essential patent claims" are all patent claims 478 | owned or controlled by the contributor, whether already acquired or 479 | hereafter acquired, that would be infringed by some manner, permitted 480 | by this License, of making, using, or selling its contributor version, 481 | but do not include claims that would be infringed only as a 482 | consequence of further modification of the contributor version. For 483 | purposes of this definition, "control" includes the right to grant 484 | patent sublicenses in a manner consistent with the requirements of 485 | this License. 486 | 487 | Each contributor grants you a non-exclusive, worldwide, royalty-free 488 | patent license under the contributor's essential patent claims, to 489 | make, use, sell, offer for sale, import and otherwise run, modify and 490 | propagate the contents of its contributor version. 491 | 492 | In the following three paragraphs, a "patent license" is any express 493 | agreement or commitment, however denominated, not to enforce a patent 494 | (such as an express permission to practice a patent or covenant not to 495 | sue for patent infringement). To "grant" such a patent license to a 496 | party means to make such an agreement or commitment not to enforce a 497 | patent against the party. 498 | 499 | If you convey a covered work, knowingly relying on a patent license, 500 | and the Corresponding Source of the work is not available for anyone 501 | to copy, free of charge and under the terms of this License, through a 502 | publicly available network server or other readily accessible means, 503 | then you must either (1) cause the Corresponding Source to be so 504 | available, or (2) arrange to deprive yourself of the benefit of the 505 | patent license for this particular work, or (3) arrange, in a manner 506 | consistent with the requirements of this License, to extend the patent 507 | license to downstream recipients. "Knowingly relying" means you have 508 | actual knowledge that, but for the patent license, your conveying the 509 | covered work in a country, or your recipient's use of the covered work 510 | in a country, would infringe one or more identifiable patents in that 511 | country that you have reason to believe are valid. 512 | 513 | If, pursuant to or in connection with a single transaction or 514 | arrangement, you convey, or propagate by procuring conveyance of, a 515 | covered work, and grant a patent license to some of the parties 516 | receiving the covered work authorizing them to use, propagate, modify 517 | or convey a specific copy of the covered work, then the patent license 518 | you grant is automatically extended to all recipients of the covered 519 | work and works based on it. 520 | 521 | A patent license is "discriminatory" if it does not include within 522 | the scope of its coverage, prohibits the exercise of, or is 523 | conditioned on the non-exercise of one or more of the rights that are 524 | specifically granted under this License. You may not convey a covered 525 | work if you are a party to an arrangement with a third party that is 526 | in the business of distributing software, under which you make payment 527 | to the third party based on the extent of your activity of conveying 528 | the work, and under which the third party grants, to any of the 529 | parties who would receive the covered work from you, a discriminatory 530 | patent license (a) in connection with copies of the covered work 531 | conveyed by you (or copies made from those copies), or (b) primarily 532 | for and in connection with specific products or compilations that 533 | contain the covered work, unless you entered into that arrangement, 534 | or that patent license was granted, prior to 28 March 2007. 535 | 536 | Nothing in this License shall be construed as excluding or limiting 537 | any implied license or other defenses to infringement that may 538 | otherwise be available to you under applicable patent law. 539 | 540 | 12. No Surrender of Others' Freedom. 541 | 542 | If conditions are imposed on you (whether by court order, agreement or 543 | otherwise) that contradict the conditions of this License, they do not 544 | excuse you from the conditions of this License. If you cannot convey a 545 | covered work so as to satisfy simultaneously your obligations under this 546 | License and any other pertinent obligations, then as a consequence you may 547 | not convey it at all. For example, if you agree to terms that obligate you 548 | to collect a royalty for further conveying from those to whom you convey 549 | the Program, the only way you could satisfy both those terms and this 550 | License would be to refrain entirely from conveying the Program. 551 | 552 | 13. Use with the GNU Affero General Public License. 553 | 554 | Notwithstanding any other provision of this License, you have 555 | permission to link or combine any covered work with a work licensed 556 | under version 3 of the GNU Affero General Public License into a single 557 | combined work, and to convey the resulting work. The terms of this 558 | License will continue to apply to the part which is the covered work, 559 | but the special requirements of the GNU Affero General Public License, 560 | section 13, concerning interaction through a network will apply to the 561 | combination as such. 562 | 563 | 14. Revised Versions of this License. 564 | 565 | The Free Software Foundation may publish revised and/or new versions of 566 | the GNU General Public License from time to time. Such new versions will 567 | be similar in spirit to the present version, but may differ in detail to 568 | address new problems or concerns. 569 | 570 | Each version is given a distinguishing version number. If the 571 | Program specifies that a certain numbered version of the GNU General 572 | Public License "or any later version" applies to it, you have the 573 | option of following the terms and conditions either of that numbered 574 | version or of any later version published by the Free Software 575 | Foundation. If the Program does not specify a version number of the 576 | GNU General Public License, you may choose any version ever published 577 | by the Free Software Foundation. 578 | 579 | If the Program specifies that a proxy can decide which future 580 | versions of the GNU General Public License can be used, that proxy's 581 | public statement of acceptance of a version permanently authorizes you 582 | to choose that version for the Program. 583 | 584 | Later license versions may give you additional or different 585 | permissions. However, no additional obligations are imposed on any 586 | author or copyright holder as a result of your choosing to follow a 587 | later version. 588 | 589 | 15. Disclaimer of Warranty. 590 | 591 | THERE IS NO WARRANTY FOR THE PROGRAM, TO THE EXTENT PERMITTED BY 592 | APPLICABLE LAW. EXCEPT WHEN OTHERWISE STATED IN WRITING THE COPYRIGHT 593 | HOLDERS AND/OR OTHER PARTIES PROVIDE THE PROGRAM "AS IS" WITHOUT WARRANTY 594 | OF ANY KIND, EITHER EXPRESSED OR IMPLIED, INCLUDING, BUT NOT LIMITED TO, 595 | THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR 596 | PURPOSE. THE ENTIRE RISK AS TO THE QUALITY AND PERFORMANCE OF THE PROGRAM 597 | IS WITH YOU. SHOULD THE PROGRAM PROVE DEFECTIVE, YOU ASSUME THE COST OF 598 | ALL NECESSARY SERVICING, REPAIR OR CORRECTION. 599 | 600 | 16. Limitation of Liability. 601 | 602 | IN NO EVENT UNLESS REQUIRED BY APPLICABLE LAW OR AGREED TO IN WRITING 603 | WILL ANY COPYRIGHT HOLDER, OR ANY OTHER PARTY WHO MODIFIES AND/OR CONVEYS 604 | THE PROGRAM AS PERMITTED ABOVE, BE LIABLE TO YOU FOR DAMAGES, INCLUDING ANY 605 | GENERAL, SPECIAL, INCIDENTAL OR CONSEQUENTIAL DAMAGES ARISING OUT OF THE 606 | USE OR INABILITY TO USE THE PROGRAM (INCLUDING BUT NOT LIMITED TO LOSS OF 607 | DATA OR DATA BEING RENDERED INACCURATE OR LOSSES SUSTAINED BY YOU OR THIRD 608 | PARTIES OR A FAILURE OF THE PROGRAM TO OPERATE WITH ANY OTHER PROGRAMS), 609 | EVEN IF SUCH HOLDER OR OTHER PARTY HAS BEEN ADVISED OF THE POSSIBILITY OF 610 | SUCH DAMAGES. 611 | 612 | 17. Interpretation of Sections 15 and 16. 613 | 614 | If the disclaimer of warranty and limitation of liability provided 615 | above cannot be given local legal effect according to their terms, 616 | reviewing courts shall apply local law that most closely approximates 617 | an absolute waiver of all civil liability in connection with the 618 | Program, unless a warranty or assumption of liability accompanies a 619 | copy of the Program in return for a fee. 620 | 621 | END OF TERMS AND CONDITIONS 622 | 623 | How to Apply These Terms to Your New Programs 624 | 625 | If you develop a new program, and you want it to be of the greatest 626 | possible use to the public, the best way to achieve this is to make it 627 | free software which everyone can redistribute and change under these terms. 628 | 629 | To do so, attach the following notices to the program. It is safest 630 | to attach them to the start of each source file to most effectively 631 | state the exclusion of warranty; and each file should have at least 632 | the "copyright" line and a pointer to where the full notice is found. 633 | 634 | 635 | Copyright (C) 636 | 637 | This program is free software: you can redistribute it and/or modify 638 | it under the terms of the GNU General Public License as published by 639 | the Free Software Foundation, either version 3 of the License, or 640 | (at your option) any later version. 641 | 642 | This program is distributed in the hope that it will be useful, 643 | but WITHOUT ANY WARRANTY; without even the implied warranty of 644 | MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the 645 | GNU General Public License for more details. 646 | 647 | You should have received a copy of the GNU General Public License 648 | along with this program. If not, see . 649 | 650 | Also add information on how to contact you by electronic and paper mail. 651 | 652 | If the program does terminal interaction, make it output a short 653 | notice like this when it starts in an interactive mode: 654 | 655 | Copyright (C) 656 | This program comes with ABSOLUTELY NO WARRANTY; for details type `show w'. 657 | This is free software, and you are welcome to redistribute it 658 | under certain conditions; type `show c' for details. 659 | 660 | The hypothetical commands `show w' and `show c' should show the appropriate 661 | parts of the General Public License. Of course, your program's commands 662 | might be different; for a GUI interface, you would use an "about box". 663 | 664 | You should also get your employer (if you work as a programmer) or school, 665 | if any, to sign a "copyright disclaimer" for the program, if necessary. 666 | For more information on this, and how to apply and follow the GNU GPL, see 667 | . 668 | 669 | The GNU General Public License does not permit incorporating your program 670 | into proprietary programs. If your program is a subroutine library, you 671 | may consider it more useful to permit linking proprietary applications with 672 | the library. If this is what you want to do, use the GNU Lesser General 673 | Public License instead of this License. But first, please read 674 | . 675 | --------------------------------------------------------------------------------