├── .gitattributes ├── .vscode └── settings.json ├── fxmanifest.lua ├── strings.lua ├── logs.lua ├── README.md ├── server ├── version.lua ├── functions.lua └── main.lua ├── client ├── functions.lua └── main.lua ├── bridge ├── client.lua └── server.lua ├── config.lua └── LICENSE.md /.gitattributes: -------------------------------------------------------------------------------- 1 | # Auto detect text files and perform LF normalization 2 | * text=auto 3 | -------------------------------------------------------------------------------- /.vscode/settings.json: -------------------------------------------------------------------------------- 1 | { 2 | "Lua.diagnostics.globals": [ 3 | "cache", 4 | "lib" 5 | ] 6 | } -------------------------------------------------------------------------------- /fxmanifest.lua: -------------------------------------------------------------------------------- 1 | fx_version 'cerulean' 2 | game 'gta5' 3 | lua54 'yes' 4 | 5 | name 'lation_pawnshop' 6 | author 'iamlation' 7 | version '1.1.1' 8 | description 'A Pawn Shop script for ESX, QBCore & QBox using ox_inventory' 9 | 10 | server_scripts { 11 | 'bridge/server.lua', 12 | 'server/*.lua', 13 | 'logs.lua' 14 | } 15 | 16 | client_scripts { 17 | 'bridge/client.lua', 18 | 'client/*.lua' 19 | } 20 | 21 | shared_scripts { 22 | 'config.lua', 23 | 'strings.lua', 24 | '@ox_lib/init.lua' 25 | } 26 | 27 | dependencies { 28 | 'ox_lib', 29 | 'ox_inventory' 30 | } -------------------------------------------------------------------------------- /strings.lua: -------------------------------------------------------------------------------- 1 | -- All icon fields use the free FontAwesome icons, you can find more here: https://fontawesome.com/v5/search?o=r&m=free 2 | Strings = {} 3 | 4 | Strings.Notify = { 5 | wrongSlot = 'Place the item in the corresponding slot', 6 | complete = 'You were paid $%s via %s for x%s %s', 7 | cantSell = 'You cannot sell that here' 8 | } 9 | 10 | Strings.TextUI = { 11 | openShop = { 12 | label = '**Pawn Shop** \n E - Open shop', 13 | icon = 'fas fa-shop' 14 | } 15 | } 16 | 17 | Strings.Target = { 18 | openShop = { 19 | label = 'Open shop', 20 | icon = 'fas fa-shop' 21 | } 22 | } 23 | 24 | Strings.Alert = { 25 | confirmSale = { 26 | header = '**Confirm**', 27 | content = 'Are you sure you want to sell x%s %s for $%s?' 28 | } 29 | } 30 | 31 | Strings.Logs = { 32 | item_sold = { 33 | title = 'Item Sold', 34 | message = '%s (identifier: %s) successfully sold x%s %s for $%s' 35 | } 36 | } -------------------------------------------------------------------------------- /logs.lua: -------------------------------------------------------------------------------- 1 | Logs = {} 2 | 3 | -- What logging service do you want to use? 4 | -- Available options: 'fivemanage', 'fivemerr', 'discord' & 'none' 5 | -- It is highly recommended to use a proper logging service such as Fivemanage or Fivemerr 6 | Logs.Service = 'none' 7 | 8 | -- Do you want to include screenshots with your logs? 9 | -- This is only applicable to Fivemanage and Fivemerr 10 | Logs.Screenshots = false 11 | 12 | -- You can enable (true) or disable (false) specific player events to log here 13 | Logs.Events = { 14 | -- table_received is when a table is issued to player 15 | item_sold = false, 16 | } 17 | 18 | -- If Logs.Service = 'discord', you can customize the webhook data here 19 | -- If not using Discord, this section can be ignored 20 | Logs.Discord = { 21 | -- The name of the webhook 22 | name = 'Pawn Shop Logs', 23 | -- The webhook link 24 | link = '', 25 | -- The webhook profile image 26 | image = 'https://i.imgur.com/ILTkWBh.png', 27 | -- The webhook footer image 28 | footer = 'https://i.imgur.com/ILTkWBh.png' 29 | } -------------------------------------------------------------------------------- /README.md: -------------------------------------------------------------------------------- 1 | # Lation's Pawn Shop 2 | A modern Pawn Shop/Sell Shop script for ESX, QBCore & QBox frameworks built for ox_inventory! Provide your players a more interactive experience by getting rid of context menu's and enjoy a simple & clean drag-and-drop to a secondary inventory to sell an item. 3 | 4 | ## Preview 5 | [![lation pawnshop preview](http://img.youtube.com/vi/ftPdTO3tlOo/0.jpg)](http://www.youtube.com/watch?v=ftPdTO3tlOo) 6 | 7 | ## Support, Scripts & More 8 | - [Visit our Store](https://lationscripts.com/?utm_source=github&utm_medium=free-script) 9 | - [Join our Discord](https://discord.gg/9EbY4nM5uu) 10 | 11 | ## Features 12 | - Supports ESX, QBCore & QBox 13 | - Choose between using target or TextUI 14 | - Fivemanage, Fivemerr & Discord logging 15 | - Create an unlimited amount of shops 16 | - Customize what items can be sold where 17 | - Set what time the shops are available 18 | - Choose to spawn a ped or not per shop 19 | - Customize payout per shop (cash, bank, dirty) 20 | - Choose between displaying placeholder items or not 21 | - Choose to display a blip or not per shop 22 | - Customize shop sizes (slots) and weight limits 23 | 24 | ## Dependencies 25 | - [ox_inventory](https://github.com/overextended/ox_inventory/releases) 26 | - [ox_lib](https://github.com/overextended/ox_lib/releases) 27 | 28 | ## Installation 29 | - Ensure you have all depdendencies installed above 30 | - Add lation_pawnshop to your 'resources' directory 31 | - Add 'ensure lation_pawnshop' in your server.cfg after dependencies 32 | -------------------------------------------------------------------------------- /server/version.lua: -------------------------------------------------------------------------------- 1 | local resourceName = 'lation_pawnshop' 2 | local currentVersion = GetResourceMetadata(resourceName, 'version', 0) 3 | 4 | -- Check if current version is outdated 5 | local function CheckVersion() 6 | if not currentVersion then 7 | print("^1["..resourceName.."] Unable to determine current resource version for '" ..resourceName.. "' ^0") 8 | return 9 | end 10 | SetTimeout(1000, function() 11 | PerformHttpRequest('https://api.github.com/repos/lation-scripts/' ..resourceName.. '/releases/latest', function(status, response) 12 | if status ~= 200 then return end 13 | response = json.decode(response) 14 | local latestVersion = response.tag_name 15 | if not latestVersion or latestVersion == currentVersion then return end 16 | if latestVersion ~= currentVersion then 17 | print('^1['..resourceName..'] ^3An update is now available for ' ..resourceName.. '^0') 18 | print('^1['..resourceName..'] ^3Current Version: ^1' ..currentVersion.. '^0') 19 | print('^1['..resourceName..'] ^3Latest Version: ^2' ..latestVersion.. '^0') 20 | print('^1['..resourceName..'] ^3Download the latest release from https://github.com/IamLation/'..resourceName..'/releases^0') 21 | print('^1['..resourceName..'] ^3For more information about this update visit our Discord^0') 22 | end 23 | end, 'GET') 24 | end) 25 | end 26 | 27 | -- Print a message 28 | local function PrintMessage() 29 | SetTimeout(1500, function() 30 | print('^1['..resourceName..'] ^2YOU DID IT! You set YouFoundTheBestScripts to true!^0') 31 | print('^1['..resourceName..'] ^2Lation officially loves you, and as a thank you wants to give you a gift..^0') 32 | print('^1['..resourceName..'] ^2Enjoy a secret 20% OFF any script of your choice on lationscripts.com^0') 33 | print('^1['..resourceName..'] ^2Using the coupon code: SECRETGIFT (one-time use coupon, choose wisely)^0') 34 | print('^1['..resourceName..'] ^2There is only 1 catch.. do not spoil it for others! If you want to share^0') 35 | print('^1['..resourceName..'] ^2This special moment feel free to do so, but without spoiling the details!^0') 36 | end) 37 | end 38 | 39 | if Config.Setup.version then 40 | CheckVersion() 41 | end 42 | 43 | if Config.YouFoundTheBestScripts then 44 | PrintMessage() 45 | end -------------------------------------------------------------------------------- /server/functions.lua: -------------------------------------------------------------------------------- 1 | -- Check to see if fm-logs or fmsdk is started 2 | local fmlogs = GetResourceState('fm-logs') == 'started' 3 | local fmsdk = GetResourceState('fmsdk') == 'started' 4 | 5 | -- Log events if applicable 6 | --- @param message string Message contents 7 | --- @param type any | string Log type 8 | function EventLog(message, type) 9 | if not message or not Config.Setup.debug then return end 10 | if Logs.Service == 'fivemanage' then 11 | if not fmsdk then return end 12 | exports.fmsdk:LogMessage(type or 'info', message) 13 | elseif Logs.Service == 'fivemerr' then 14 | if not fmlogs then return end 15 | exports['fm-logs']:createLog({ 16 | LogType = 'Resource', 17 | Resource = 'lation_pawnshop', 18 | Level = type or 'info', 19 | Message = message, 20 | }) 21 | else 22 | print(message) 23 | end 24 | end 25 | 26 | -- Log player events if applicable 27 | --- @param source number Player ID 28 | --- @param title string Log title 29 | --- @param message string Message contents 30 | function PlayerLog(source, title, message) 31 | if Logs.Service == 'fivemanage' then 32 | if not fmsdk then return end 33 | if Logs.Screenshots then 34 | exports.fmsdk:takeServerImage(source, { 35 | name = title, 36 | description = message, 37 | }) 38 | else 39 | exports.fmsdk:LogMessage('info', message) 40 | end 41 | elseif Logs.Service == 'fivemerr' then 42 | if not fmlogs then return end 43 | exports['fm-logs']:createLog({ 44 | LogType = 'Player', 45 | Message = message, 46 | Resource = 'lation_pawnshop', 47 | Source = source, 48 | }, { Screenshot = Logs.Screenshots }) 49 | elseif Logs.Service == 'discord' then 50 | local embed = { 51 | { 52 | ["color"] = 16711680, 53 | ["title"] = "**".. title .."**", 54 | ["description"] = message, 55 | ["footer"] = { 56 | ["text"] = os.date("%a %b %d, %I:%M%p"), 57 | ["icon_url"] = Logs.Discord.footer 58 | } 59 | } 60 | } 61 | PerformHttpRequest(Logs.Discord.link, function() 62 | end, 'POST', json.encode({username = Logs.Discord.name, embeds = embed, avatar_url = Logs.Discord.image}), {['Content-Type'] = 'application/json'}) 63 | end 64 | end -------------------------------------------------------------------------------- /client/functions.lua: -------------------------------------------------------------------------------- 1 | -- Function to show a notification 2 | --- @param message string 3 | --- @param type string 4 | function ShowNotification(message, type) 5 | if Config.Setup.notify == 'ox_lib' then 6 | lib.notify({ title = 'Pawn Shop', description = message, type = type, position = 'top', icon = 'fas fa-shop' }) 7 | elseif Config.Setup.notify == 'esx' then 8 | ESX.ShowNotification(message) 9 | elseif Config.Setup.notify == 'qb' then 10 | QBCore.Functions.Notify(message, type) 11 | elseif Config.Setup.notify == 'okok' then 12 | exports['okokNotify']:Alert('Pawn Shop', message, 5000, type, false) 13 | elseif Config.Setup.notify == 'custom' then 14 | -- Add custom notification export/event here 15 | end 16 | end 17 | 18 | -- Event handler to show notifications from server 19 | --- @param message string 20 | --- @param type string 21 | RegisterNetEvent('lation_pawnshop:Notify', function(message, type) 22 | ShowNotification(message, type) 23 | end) 24 | 25 | -- Function used to display TextUI 26 | --- @param text string 27 | --- @param icon string 28 | function ShowTextUI(text, icon) 29 | local displaying, _ = lib.isTextUIOpen() 30 | if displaying then return end 31 | lib.showTextUI(text, { 32 | position = 'left-center', 33 | icon = icon 34 | }) 35 | end 36 | 37 | -- Function used to hide/remove TextUI 38 | --- @param label string 39 | function HideTextUI(label) 40 | local isOpen, text = lib.isTextUIOpen() 41 | if isOpen and text == label then 42 | lib.hideTextUI() 43 | end 44 | end 45 | 46 | -- Function to add circle target zones 47 | --- @param data table 48 | function AddCircleZone(data) 49 | if Config.Setup.target == 'ox_target' then 50 | exports.ox_target:addSphereZone(data) 51 | elseif Config.Setup.target == 'qb-target' then 52 | exports['qb-target']:AddCircleZone(data.name, data.coords, data.radius, { 53 | name = data.name, 54 | debugPoly = Config.Setup.debug}, { 55 | options = data.options, 56 | distance = 2, 57 | }) 58 | elseif Config.Setup.target == 'qtarget' then 59 | exports.qtarget:AddCircleZone(data.name, data.coords, data.radius, { 60 | name = data.name, 61 | debugPoly = Config.Setup.debug}, { 62 | options = data.options, 63 | distance = 2, 64 | }) 65 | elseif Config.Setup.target == 'custom' then 66 | -- Add support for a custom target system here 67 | elseif Config.Setup.target == 'none' then 68 | -- TextUI is being used 69 | else 70 | print('No target system defined in the config file.') 71 | end 72 | end 73 | 74 | -- Function to remove circle target zones 75 | --- @param id number | string 76 | function RemoveCircleZone(id) 77 | if Config.Setup.target == 'ox_target' then 78 | exports.ox_target:removeZone(id) 79 | elseif Config.Setup.target == 'qb-target' then 80 | exports['qb-target']:RemoveZone(id) 81 | elseif Config.Setup.target == 'qtarget' then 82 | exports.qtarget:RemoveZone(id) 83 | elseif Config.Setup.target == 'custom' then 84 | -- Add support for a custom target system here 85 | elseif Config.Setup.target == 'none' then 86 | -- TextUI is being used 87 | else 88 | print('No target system defined in the config file.') 89 | end 90 | end 91 | 92 | -- Function used to spawn NPCs 93 | --- @param model string 94 | --- @param coords vector3 | vector4 95 | function SpawnNPC(model, coords) 96 | if not model or not coords then return end 97 | lib.requestModel(model, 10000) 98 | while not HasModelLoaded(model) do Wait(0) end 99 | local ped = CreatePed(0, model, coords.x, coords.y, coords.z - 1.0, coords.w, false, true) 100 | FreezeEntityPosition(ped, true) 101 | SetBlockingOfNonTemporaryEvents(ped, true) 102 | SetEntityInvincible(ped, true) 103 | return ped 104 | end -------------------------------------------------------------------------------- /bridge/client.lua: -------------------------------------------------------------------------------- 1 | -- Initialize global variables to store framework & inventory 2 | Framework, Inventory = nil, nil 3 | 4 | -- Initialize global player variables 5 | PlayerLoaded, PlayerData = nil, {} 6 | 7 | -- Get framework 8 | local function InitializeFramework() 9 | if GetResourceState('es_extended') == 'started' then 10 | ESX = exports['es_extended']:getSharedObject() 11 | Framework = 'esx' 12 | 13 | RegisterNetEvent('esx:playerLoaded', function(xPlayer) 14 | PlayerData = xPlayer 15 | PlayerLoaded = true 16 | TriggerEvent('lation_pawnshop:onPlayerLoaded') 17 | end) 18 | 19 | RegisterNetEvent('esx:onPlayerLogout', function() 20 | table.wipe(PlayerData) 21 | PlayerLoaded = false 22 | end) 23 | 24 | AddEventHandler('onResourceStart', function(resourceName) 25 | if GetCurrentResourceName() ~= resourceName then return end 26 | PlayerData = GetPlayerData() 27 | PlayerLoaded = true 28 | TriggerEvent('lation_pawnshop:onPlayerLoaded') 29 | end) 30 | 31 | elseif GetResourceState('qbx_core') == 'started' then 32 | Framework = 'qbx' 33 | 34 | AddEventHandler('QBCore:Client:OnPlayerLoaded', function() 35 | PlayerData = GetPlayerData() 36 | PlayerLoaded = true 37 | TriggerEvent('lation_pawnshop:onPlayerLoaded') 38 | end) 39 | 40 | RegisterNetEvent('qbx_core:client:playerLoggedOut', function() 41 | table.wipe(PlayerData) 42 | PlayerLoaded = false 43 | end) 44 | 45 | AddEventHandler('onResourceStart', function(resourceName) 46 | if GetCurrentResourceName() ~= resourceName then return end 47 | PlayerData = GetPlayerData() 48 | PlayerLoaded = true 49 | TriggerEvent('lation_pawnshop:onPlayerLoaded') 50 | end) 51 | elseif GetResourceState('qb-core') == 'started' then 52 | QBCore = exports['qb-core']:GetCoreObject() 53 | Framework = 'qb' 54 | 55 | AddEventHandler('QBCore:Client:OnPlayerLoaded', function() 56 | PlayerData = GetPlayerData() 57 | PlayerLoaded = true 58 | TriggerEvent('lation_pawnshop:onPlayerLoaded') 59 | end) 60 | 61 | RegisterNetEvent('QBCore:Client:OnPlayerUnload', function() 62 | table.wipe(PlayerData) 63 | PlayerLoaded = false 64 | end) 65 | 66 | AddEventHandler('onResourceStart', function(resourceName) 67 | if GetCurrentResourceName() ~= resourceName then return end 68 | PlayerData = GetPlayerData() 69 | PlayerLoaded = true 70 | TriggerEvent('lation_pawnshop:onPlayerLoaded') 71 | end) 72 | elseif GetResourceState('ox_core') == 'started' then 73 | Ox = require '@ox_core.lib.init' 74 | Framework = 'ox' 75 | 76 | AddEventHandler('ox:playerLoaded', function() 77 | PlayerData = GetPlayerData() 78 | PlayerLoaded = true 79 | TriggerEvent('lation_pawnshop:onPlayerLoaded') 80 | end) 81 | 82 | AddEventHandler('ox:playerLogout', function() 83 | table.wipe(PlayerData) 84 | PlayerLoaded = false 85 | end) 86 | 87 | AddEventHandler('onResourceStart', function(resourceName) 88 | if GetCurrentResourceName() ~= resourceName then return end 89 | PlayerData = GetPlayerData() 90 | PlayerLoaded = true 91 | TriggerEvent('lation_pawnshop:onPlayerLoaded') 92 | end) 93 | else 94 | -- Add custom framework here 95 | end 96 | end 97 | 98 | -- Get inventory 99 | local function InitializeInventory() 100 | if GetResourceState('ox_inventory') == 'started' then 101 | Inventory = 'ox_inventory' 102 | elseif GetResourceState('qb-inventory') == 'started' then 103 | Inventory = 'qb-inventory' 104 | elseif GetResourceState('qs-inventory') == 'started' then 105 | Inventory = 'qs-inventory' 106 | elseif GetResourceState('ps-inventory') == 'started' then 107 | Inventory = 'ps-inventory' 108 | elseif GetResourceState('origen_inventory') == 'started' then 109 | Inventory = 'origen_inventory' 110 | elseif GetResourceState('codem-inventory') == 'started' then 111 | Inventory = 'codem-inventory' 112 | else 113 | -- Add custom inventory here 114 | end 115 | end 116 | 117 | -- Returns player data 118 | function GetPlayerData() 119 | if Framework == 'esx' then 120 | return ESX.GetPlayerData() 121 | elseif Framework == 'qb' then 122 | return QBCore.Functions.GetPlayerData() 123 | elseif Framework == 'qbx' then 124 | return exports.qbx_core:GetPlayerData() 125 | elseif Framework == 'ox' then 126 | return Ox.GetPlayer() 127 | else 128 | -- Add custom framework here 129 | end 130 | end 131 | 132 | -- Initialize defaults 133 | InitializeFramework() 134 | InitializeInventory() -------------------------------------------------------------------------------- /bridge/server.lua: -------------------------------------------------------------------------------- 1 | -- Initialize global variables to store framework & inventory 2 | Framework, Inventory = nil, nil 3 | 4 | -- Get framework 5 | local function InitializeFramework() 6 | if GetResourceState('es_extended') == 'started' then 7 | ESX = exports['es_extended']:getSharedObject() 8 | Framework = 'esx' 9 | elseif GetResourceState('qbx_core') == 'started' then 10 | Framework = 'qbx' 11 | elseif GetResourceState('qb-core') == 'started' then 12 | QBCore = exports['qb-core']:GetCoreObject() 13 | Framework = 'qb' 14 | elseif GetResourceState('ox_core') == 'started' then 15 | Ox = require '@ox_core.lib.init' 16 | Framework = 'ox' 17 | else 18 | -- Add custom framework here 19 | end 20 | end 21 | 22 | -- Get inventory 23 | local function InitializeInventory() 24 | if GetResourceState('ox_inventory') == 'started' then 25 | Inventory = 'ox_inventory' 26 | elseif GetResourceState('qb-inventory') == 'started' then 27 | Inventory = 'qb-inventory' 28 | elseif GetResourceState('qs-inventory') == 'started' then 29 | Inventory = 'qs-inventory' 30 | elseif GetResourceState('ps-inventory') == 'started' then 31 | Inventory = 'ps-inventory' 32 | elseif GetResourceState('origen_inventory') == 'started' then 33 | Inventory = 'origen_inventory' 34 | elseif GetResourceState('codem-inventory') == 'started' then 35 | Inventory = 'codem-inventory' 36 | else 37 | -- Add custom inventory here 38 | end 39 | end 40 | 41 | -- Get player from source 42 | --- @param source number Player ID 43 | function GetPlayer(source) 44 | if not source then return end 45 | if Framework == 'esx' then 46 | return ESX.GetPlayerFromId(source) 47 | elseif Framework == 'qb' then 48 | return QBCore.Functions.GetPlayer(source) 49 | elseif Framework == 'qbx' then 50 | return exports.qbx_core:GetPlayer(source) 51 | elseif Framework == 'ox' then 52 | return Ox.GetPlayer(source) 53 | else 54 | -- Add custom framework here 55 | end 56 | end 57 | 58 | -- Function to get a player identifier by source 59 | --- @param source number Player ID 60 | function GetIdentifier(source) 61 | local player = GetPlayer(source) 62 | if not player then return end 63 | if Framework == 'esx' then 64 | return player.identifier 65 | elseif Framework == 'qb' or Framework == 'qbx' then 66 | return player.PlayerData.citizenid 67 | elseif Framework == 'ox' then 68 | return player.charId 69 | else 70 | -- Add custom framework here 71 | end 72 | end 73 | 74 | -- Function to get a player's name 75 | --- @param source number Player ID 76 | --- @return string 77 | function GetName(source) 78 | local player = GetPlayer(source) 79 | if not player then return 'Unknown' end 80 | if Framework == 'esx' then 81 | return player.getName() 82 | elseif Framework == 'qb' or Framework == 'qbx' then 83 | return player.PlayerData.charinfo.firstname .. ' ' .. player.PlayerData.charinfo.lastname 84 | elseif Framework == 'ox' then 85 | return player.get('firstName') .. ' ' .. player.get('lastName') 86 | else 87 | -- Add custom framework here 88 | end 89 | return 'Unknown' 90 | end 91 | 92 | -- Returns correct framework money type if needed 93 | --- @param type string Money type 94 | --- @return string 95 | local function ConvertMoneyType(type) 96 | if type == 'money' and (Framework == 'qb' or Framework == 'qbx') then 97 | type = 'cash' 98 | elseif type == 'cash' and (Framework == 'esx' or Framework == 'ox') then 99 | type = 'money' 100 | else 101 | -- Add custom framework here 102 | end 103 | return type 104 | end 105 | 106 | -- Add money to players account 107 | --- @param source number Player ID 108 | --- @param type string Account to add to 109 | --- @param amount number Amount to add 110 | function AddMoney(source, type, amount) 111 | local player = GetPlayer(source) 112 | if not player then return end 113 | if Framework == 'esx' then 114 | if type == 'dirty' then type = 'black_money' end 115 | player.addAccountMoney(ConvertMoneyType(type), amount) 116 | elseif Framework == 'qb' or Framework == 'qbx' then 117 | if type == 'dirty' then 118 | return exports.ox_inventory:AddItem(source, 'markedbills', amount) 119 | end 120 | player.Functions.AddMoney(ConvertMoneyType(type), amount) 121 | elseif Framework == 'ox' then 122 | if type == 'cash' or type == 'money' or type == 'dirty' then 123 | if type == 'dirty' then type = 'black_money' end 124 | exports.ox_inventory:AddItem(source, ConvertMoneyType(type), amount) 125 | else 126 | local accountId = Ox.GetCharacterAccount(source).id 127 | Ox.DepositMoney(source, accountId, amount) 128 | end 129 | else 130 | -- Add custom framework here 131 | end 132 | end 133 | 134 | -- Initialize defaults 135 | InitializeFramework() 136 | InitializeInventory() -------------------------------------------------------------------------------- /config.lua: -------------------------------------------------------------------------------- 1 | Config = {} -- Do not alter 2 | 3 | -- 🔎 Looking for more high quality scripts? 4 | -- 🛒 Shop Now: https://lationscripts.com 5 | -- 💬 Join Discord: https://discord.gg/9EbY4nM5uu 6 | -- 😢 How dare you leave this option false?! 7 | Config.YouFoundTheBestScripts = false 8 | 9 | ---------------------------------------------- 10 | -- 🛠️ Setup the basics below 11 | ---------------------------------------------- 12 | 13 | Config.Setup = { 14 | -- Use only if needed, directed by support or know what you're doing 15 | -- Notice: enabling debug features will significantly increase resmon 16 | -- And should always be disabled in production 17 | debug = false, 18 | -- Do you want to be notified via server console if an update is available? 19 | version = true, 20 | -- Target system, available options are: 'ox_target', 'qb-target', 'qtarget', 'custom' & 'none' 21 | -- 'custom' needs to be added to client/functions.lua 22 | -- If 'none' then TextUI is used instead of targeting 23 | target = 'none', 24 | -- Notification system, available options are: 'ox_lib', 'esx', 'qb', 'okok' & 'custom' 25 | -- 'custom' needs to be added to client/functions.lua 26 | notify = 'ox_lib', 27 | -- If using TextUI (Config.Setup.target = 'none') then what key do you want to open the shop? 28 | -- Default is 38 (E), find more control ID's here: https://docs.fivem.net/docs/game-references/controls/ 29 | interact = 38, 30 | -- 'auto_clear' is a system to automatically clear shops after certain amount of time 31 | auto_clear = { 32 | -- Do you want to enable the auto clearing system? 33 | enable = false, 34 | -- If enable = true, how long (in minutes) should shops be cleared? 35 | interval = 60 36 | } 37 | } 38 | 39 | ---------------------------------------------- 40 | -- 🏪 Create your pawn shops 41 | ---------------------------------------------- 42 | 43 | Config.Shops = { 44 | ['vinewood'] = { -- Unique identifier for this shop 45 | name = 'Vinewood Pawn & Jewelry', -- Shop name 46 | slots = 25, -- How many slots are available 47 | weight = 100000, -- How much weight is available 48 | coords = vec4(-1459.2361, -413.2576, 36.2567, 343.8426), -- Where this shop exists 49 | radius = 1.0, -- How large of a circle zone radius (for targeting only) 50 | spawnPed = false, -- Spawn a ped to interact with here? 51 | pedModel = 'a_m_y_beach_02', -- If spawnPed = true, what ped model? 52 | -- You can limit the hours at which the shop is available here 53 | -- Min is the earliest the shop is available (default 06:00AM) 54 | -- Max is the latest the shop is available (detault 21:00 aka 9PM) 55 | -- If you want it available 24/7, set min to 0 and max to 24 56 | hour = { min = 6, max = 21 }, 57 | account = 'cash', -- Give 'cash', 'bank' or 'dirty' money when selling here? 58 | allowlist = { 59 | -- What items can be sold here 60 | -- Any item not in this list, cannot be sold here 61 | -- ['itemSpawnName'] = { label = 'Item Name', price = sellPrice } 62 | ['water'] = { label = 'Water', price = { min = 50, max = 100 } }, 63 | ['panties'] = { label = 'Knickers', price = 10 }, 64 | ['lockpick'] = { label = 'Lockpick', price = 25 }, 65 | ['phone'] = { label = 'Phone', price = 150 }, 66 | ['armour'] = { label = 'Bulletproof Vest', price = 225 }, 67 | -- Add & remove items here as desired 68 | -- Be sure to follow the same format as above 69 | }, 70 | -- If placeholders = true then the "slots" amount above will be overridden 71 | -- This option will fill the shop with "display" items, and only 72 | -- Display items that are possible to sell here. If false, it will be 73 | -- An empty inventory, and the "slots" amount above will not be overridden 74 | placeholders = true, 75 | blip = { 76 | enabled = true, -- Enable or disable the blip for this shop 77 | sprite = 59, -- Sprite ID (https://docs.fivem.net/docs/game-references/blips/) 78 | color = 0, -- Color (https://docs.fivem.net/docs/game-references/blips/#blip-colors) 79 | scale = 0.8, -- Size/scale 80 | label = 'Pawn Shop' -- Label 81 | } 82 | }, 83 | ['strawberry'] = { 84 | name = 'Strawberry Ave Pawn Shop', 85 | slots = 25, 86 | weight = 100000, 87 | coords = vec4(182.7942, -1319.3451, 29.3173, 244.3924), 88 | radius = 1.0, 89 | spawnPed = true, 90 | pedModel = 'a_m_y_beach_02', 91 | hour = { min = 6, max = 21 }, 92 | account = 'cash', 93 | allowlist = { 94 | ['water'] = { label = 'Water', price = 50 }, 95 | ['panties'] = { label = 'Knickers', price = 10 }, 96 | ['lockpick'] = { label = 'Lockpick', price = 25 }, 97 | ['phone'] = { label = 'Phone', price = 150 }, 98 | ['armour'] = { label = 'Bulletproof Vest', price = 225 }, 99 | }, 100 | placeholders = false, 101 | blip = { 102 | enabled = true, 103 | sprite = 59, 104 | color = 0, 105 | scale = 0.8, 106 | label = 'Pawn Shop' 107 | } 108 | }, 109 | -- Add more pawn shops here as desired 110 | -- Be sure to follow the same format as above 111 | } -------------------------------------------------------------------------------- /client/main.lua: -------------------------------------------------------------------------------- 1 | -- Initalize table to store points & peds 2 | local points, peds = {}, {} 3 | 4 | -- Initalize variables to manage TextUI if applicable 5 | local inRange, showingUI, keyListener = {}, false, false 6 | 7 | -- Used to create blip if enabled 8 | --- @param key string 9 | local function CreateBlips(key) 10 | local data = Config.Shops[key] 11 | local coords = data.coords 12 | local blip = AddBlipForCoord(coords.x, coords.y, coords.z) 13 | SetBlipSprite(blip, data.blip.sprite) 14 | SetBlipColour(blip, data.blip.color) 15 | SetBlipScale(blip, data.blip.scale) 16 | SetBlipAsShortRange(blip, true) 17 | BeginTextCommandSetBlipName("STRING") 18 | AddTextComponentString(data.blip.label) 19 | EndTextCommandSetBlipName(blip) 20 | end 21 | 22 | -- Function used to make numbers prettier (Credits to ESX for the function) 23 | --- @param value number 24 | local function GroupDigits(value) 25 | local left, num, right = string.match(value, '^([^%d]*%d)(%d*)(.-)$') 26 | return left .. (num:reverse():gsub('(%d%d%d)', '%1,'):reverse()) .. right 27 | end 28 | 29 | -- Used to manage key listening 30 | --- @param shopId string 31 | local function KeyListener(shopId) 32 | while keyListener do 33 | Wait(0) 34 | if IsControlJustReleased(0, Config.Setup.interact) then 35 | exports.ox_inventory:openInventory('stash', shopId) 36 | showingUI = false 37 | end 38 | end 39 | end 40 | 41 | -- Used to manage the TextUI if applicable 42 | --- @param shopId string 43 | local function ManageTextUI(shopId) 44 | local pos = Config.Shops[shopId].coords 45 | while inRange[shopId] do 46 | Wait(350) 47 | local distance = #(GetEntityCoords(cache.ped) - vec3(pos.x, pos.y, pos.z)) 48 | if distance < 2.0 then 49 | if not showingUI and not LocalPlayer.state.invOpen then 50 | ShowTextUI(Strings.TextUI.openShop.label, Strings.TextUI.openShop.icon) 51 | showingUI = true 52 | end 53 | if not keyListener then 54 | keyListener = true 55 | CreateThread(function() KeyListener(shopId) end) 56 | end 57 | if LocalPlayer.state.invOpen then 58 | HideTextUI(Strings.TextUI.openShop.label) 59 | showingUI = false 60 | end 61 | else 62 | HideTextUI(Strings.TextUI.openShop.label) 63 | showingUI = false 64 | if keyListener then 65 | keyListener = false 66 | end 67 | end 68 | end 69 | end 70 | 71 | -- Create shops based on configurations 72 | for shopId, data in pairs(Config.Shops) do 73 | local point = lib.points.new(data.coords, 50) 74 | -- Enter function 75 | function point:onEnter() 76 | local hour = GetClockHours() 77 | if hour >= data.hour.min and hour < data.hour.max then 78 | if data.spawnPed then 79 | peds[shopId] = SpawnNPC(data.pedModel, data.coords) 80 | end 81 | if Config.Setup.target == 'none' then 82 | inRange[shopId] = true 83 | CreateThread(function() ManageTextUI(shopId) end) 84 | else 85 | local target = { 86 | name = 'shop' ..shopId, 87 | coords = data.coords, 88 | radius = data.radius, 89 | debug = Config.Setup.debug, 90 | distance = 2, 91 | options = { 92 | { 93 | label = Strings.Target.openShop.label, 94 | icon = Strings.Target.openShop.icon, 95 | distance = 2, 96 | action = function() exports.ox_inventory:openInventory('stash', shopId) end, 97 | onSelect = function() exports.ox_inventory:openInventory('stash', shopId) end 98 | } 99 | } 100 | } 101 | AddCircleZone(target) 102 | end 103 | end 104 | end 105 | -- Exit function 106 | function point:onExit() 107 | if peds[shopId] and DoesEntityExist(peds[shopId]) then 108 | DeleteEntity(peds[shopId]) 109 | end 110 | peds[shopId] = nil 111 | inRange[shopId] = false 112 | if Config.Setup.target ~= 'none' then 113 | RemoveCircleZone('shop' ..shopId) 114 | end 115 | end 116 | points[shopId] = point 117 | end 118 | 119 | -- Callback used to confirm transaction before completion 120 | --- @param shopId string 121 | --- @param item string 122 | --- @param price number 123 | --- @param quantity number 124 | lib.callback.register('lation_pawnshop:ConfirmSale', function(_, shopId, item, price, quantity) 125 | if not shopId or not item or not price or not quantity then return false end 126 | local label = Config.Shops[shopId].allowlist[item].label 127 | if not label then return false end 128 | local confirmation = lib.alertDialog({ 129 | header = Strings.Alert.confirmSale.header, 130 | content = Strings.Alert.confirmSale.content:format(tostring(GroupDigits(quantity)), label, tostring(GroupDigits(price))), 131 | centered = true, 132 | cancel = true 133 | }) 134 | if not confirmation or confirmation == 'cancel' then return false end 135 | return true 136 | end) 137 | 138 | -- Event handler to add blips to the map 139 | AddEventHandler('lation_pawnshop:onPlayerLoaded', function() 140 | while not PlayerLoaded do Wait(0) end 141 | for shopId, data in pairs(Config.Shops) do 142 | if data.blip.enabled then 143 | CreateBlips(shopId) 144 | end 145 | end 146 | end) -------------------------------------------------------------------------------- /server/main.lua: -------------------------------------------------------------------------------- 1 | -- Initialize table to store inventories for hook filter 2 | local inventories = {} 3 | 4 | -- Initialize variable to track removal status of non-stackable items 5 | local waiting = false 6 | 7 | -- Function used to make numbers prettier (Credits to ESX for the function) 8 | --- @param value number 9 | local function GroupDigits(value) 10 | local left, num, right = string.match(value, '^([^%d]*%d)(%d*)(.-)$') 11 | return left .. (num:reverse():gsub('(%d%d%d)', '%1,'):reverse()) .. right 12 | end 13 | 14 | -- Thread to handle removal of non-stackable items 15 | -- A pretty hacky solution, but works nevertheless 16 | --- @param source number 17 | --- @param item string 18 | --- @param count number 19 | local function AwaitRemoval(source, item, count) 20 | local source = source 21 | local wait = 5 -- Increase this number slightly if items failing to remove 22 | while waiting do 23 | Wait(0) 24 | wait = wait - 1 25 | if wait <= 0 then 26 | exports.ox_inventory:RemoveItem(source, item, count) 27 | waiting = false 28 | break 29 | end 30 | end 31 | end 32 | 33 | -- Register necessary shops/stashes 34 | for shopId, data in pairs(Config.Shops) do 35 | if data.placeholders then 36 | local slots, items = 0, {} 37 | for item, _ in pairs(data.allowlist) do 38 | slots = slots + 1 39 | items[#items + 1] = item 40 | end 41 | exports.ox_inventory:RegisterStash(shopId, data.name, slots, data.weight) 42 | for _, item in pairs(items) do 43 | exports.ox_inventory:AddItem(shopId, item, 1) 44 | end 45 | else 46 | exports.ox_inventory:RegisterStash(shopId, data.name, data.slots, data.weight) 47 | end 48 | inventories[#inventories + 1] = shopId 49 | end 50 | 51 | -- Used to handle all movements and final transaction in inventory 52 | --- @param payload table 53 | local function BeginTransaction(payload) 54 | if not payload then return false end 55 | if payload.toType == 'player' then 56 | EventLog('[main.lua]: BeginTransaction: inventory is not a shop, cannot proceed..') 57 | return false 58 | end 59 | if payload.toType == 'stash' and payload.fromType == 'stash' then 60 | EventLog('[main.lua]: BeginTransaction: cannot move items inside the shop, cannot proceed..') 61 | return false 62 | end 63 | local source = payload.source 64 | if not source then 65 | EventLog('[main.lua]: BeginTransaction: source not found, cannot proceed..') 66 | return false 67 | end 68 | local playerName = GetName(source) 69 | local identifier = GetIdentifier(source) 70 | local shop = Config.Shops[payload.toInventory].name 71 | if not shop then 72 | EventLog('[main.lua]: BeginTransaction: unable to find shop in config, cannot proceed..') 73 | return false 74 | end 75 | EventLog('[main.lua]: BeginTransaction: currently interacting with shop: ' ..tostring(shop)) 76 | for shopId, data in pairs(Config.Shops) do 77 | if payload.toInventory == shopId then 78 | local itemAccepted = false 79 | EventLog('[main.lua]: BeginTransaction: this shop accepts the following item(s): ' ..json.encode(data.allowlist, { indent = true })) 80 | for item, info in pairs(data.allowlist) do 81 | if payload.fromSlot.name == item then 82 | if data.placeholders then 83 | if payload.fromSlot.name ~= payload.toSlot.name then 84 | TriggerClientEvent('lation_pawnshop:Notify', source, Strings.Notify.wrongSlot, 'inform') 85 | EventLog('[main.lua]: BeginTransaction: item is not placed in correct slot, cannot proceed..') 86 | return false 87 | end 88 | else 89 | if payload.action == 'swap' then 90 | EventLog('[main.lua]: BeginTransaction: cannot place item on top of non-matching item, cannot proceed..') 91 | return false 92 | end 93 | end 94 | itemAccepted = true 95 | local price = 0 96 | 97 | if type(info.price) == 'table' then 98 | local min, max = info.price.min, info.price.max 99 | if min and max then 100 | price = math.random(min, max) 101 | price = math.floor(price * payload.count) 102 | end 103 | else 104 | price = math.floor((info.price or 0) * payload.count) 105 | end 106 | local quantity = payload.count 107 | local result = lib.callback.await('lation_pawnshop:ConfirmSale', source, nil, shopId, item, price, quantity) 108 | if not result then 109 | EventLog('[main.lua]: BeginTransaction: sale was cancelled by player, cannot proceed..') 110 | return false 111 | end 112 | TriggerClientEvent('lation_pawnshop:Notify', source, Strings.Notify.complete:format(tostring(GroupDigits(price)), data.account, tostring(GroupDigits(quantity)), info.label), 'success') 113 | AddMoney(source, data.account, price) 114 | if Logs.Events.item_sold then 115 | local log = Strings.Logs.item_sold.message 116 | local message = string.format(log, tostring(playerName), tostring(identifier), tostring(GroupDigits(quantity)), info.label, tostring(GroupDigits(price))) 117 | PlayerLog(source, Strings.Logs.item_sold.title, message) 118 | end 119 | if data.placeholders then 120 | if not payload.toSlot.stack then 121 | waiting = true 122 | CreateThread(function() AwaitRemoval(source, payload.fromSlot.name, payload.count) end) 123 | end 124 | end 125 | return true 126 | end 127 | end 128 | if not itemAccepted then 129 | EventLog('[main.lua]: BeginTransaction: transaction failed, this shop does not accept: ' .. tostring(payload.fromSlot.name)) 130 | TriggerClientEvent('lation_pawnshop:Notify', source, Strings.Notify.cantSell, 'error') 131 | return false 132 | end 133 | end 134 | end 135 | return false 136 | end 137 | 138 | -- If auto_clear is enabled, clear shops at specified interval 139 | if Config.Setup.auto_clear.enable then 140 | local interval = Config.Setup.auto_clear.interval * 60000 141 | CreateThread(function() 142 | while true do 143 | for shopId, data in pairs(Config.Shops) do 144 | exports.ox_inventory:ClearInventory(shopId) 145 | if data.placeholders then 146 | for item, _ in pairs(data.allowlist) do 147 | exports.ox_inventory:AddItem(shopId, item, 1) 148 | end 149 | end 150 | end 151 | Wait(interval) 152 | end 153 | end) 154 | end 155 | 156 | -- Register the swapItems hook 157 | exports.ox_inventory:registerHook('swapItems', function(payload) 158 | local result = BeginTransaction(payload) 159 | return result 160 | end, {inventoryFilter = inventories}) 161 | 162 | -- Clear stashes on resource stop 163 | AddEventHandler('onResourceStop', function(resourceName) 164 | if (GetCurrentResourceName() ~= resourceName) then return end 165 | for shopId, _ in pairs(Config.Shops) do 166 | exports.ox_inventory:ClearInventory(shopId) 167 | end 168 | end) 169 | 170 | -- Event handler to clear stashes on server shutdown/restart 171 | AddEventHandler('txAdmin:events:serverShuttingDown', function() 172 | for shopId, _ in pairs(Config.Shops) do 173 | exports.ox_inventory:ClearInventory(shopId) 174 | end 175 | end) -------------------------------------------------------------------------------- /LICENSE.md: -------------------------------------------------------------------------------- 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 | --------------------------------------------------------------------------------