Welcome to SG Panning!

This script adds an immersive gold panning mechanic to your server, providing players with a unique and engaging activity. Players can use panning items, varying from bronze gold pans (cheap version) to gold goldpans (expensive version) to pan gold in a river or sea.

Preview

Features

• Comes with predefined strings in the following languages: English, Dutch, German, French, Spanish, Italian, Arabic and Turkish;
• Choose from 3 different types of notifications ór add your own: okok, ox or mythic;
• 3 types of progress: circle, bar and skillcheck (with bar included);
• 3 different kind of gold pans: bronze gold pan, iron gold pan and gold goldpan;
• Possibility to make the pan break (can also be turned off) and includes configuration for break chance for all 3 types of pans;
• Multiple locations to pan gold;
• Possibility to have a chance to pan nothing (can also be turned off) and includes configuration for pan nothing chance;
• Possibility to have a chance to pan money (can also be turned off) and includes configuration for chance of panning money but also minimum and maximum amount of money to be panned;
• Configuration of items (what item, what chance, how many) you get for panning with all 3 types of gold pans;
• Possbility of earning gold nuggets (turn off/on and amount of gold nuggets) while panning with all 3 types of pans;
• Enable or disable both shop and swap shop;
• Enable or disable the blips from both shop and swap shop;
• Configuration of blips for both swap shop (for example: sprite, color, scale, label); - Configuration of icons and colors for the shop & swap shop;

Config

In SG Panning, you have a lot of configurable options. We made a seperation between the shared config-side, client config-side and the server config-side.

Shared-side

  Language = 'en', -- Choose from 'en', 'nl', 'de', 'fr', 'es', 'it', 'ar', 'tr'

  Notify = 'ox', -- 'okok', 'qb', 'ox' or 'mythic'

  Location = {
    [1] = {coords = vec3(2387.26, 4591.33, 29.86), radius = 2, debug = false}, -- Grapeseed (2035)
    [2] = {coords = vec3(-1583.50, -1228.13, 0.66), radius = 2, debug = false}, -- Pier/Beach (8001)
    [3] = {coords = vec3(3843.17, 4479.66, 0.14), radius = 2, debug = false} -- El Gordo Drive (2059)
  },

  Pans = {
    low = 'bronze_goldpan',
    mid = 'iron_goldpan',
    high = 'gold_goldpan',
  },

Client-side

    Target = {
        Type = 'ox',
        Icon = 'fas fa-coins',
        IconColor = '#FEEFC6',
        Distance = 3.0,
    },

    Progress = 'skillcheck', -- 'skillcheck', 'bar', 'circle'

    Location = {
        [1] = {coords = vec3(2387.26, 4591.33, 29.86), radius = 2, debug = false}, -- Grapeseed (2035)
        [2] = {coords = vec3(-1583.50, -1228.13, 0.66), radius = 2, debug = false}, -- Pier/Beach (8001)
        [3] = {coords = vec3(3843.17, 4479.66, 0.14), radius = 2, debug = false} -- El Gordo Drive (2059)
    },
    
    Blip = {
        enableblip = true, -- true or false        
        sprite = 272,
        color = 71,
        scale = 1.0,
        label = 'Panning',
    },
  
    -- Panning shop
    Shop = {
        enable = true,
        enableblip = true,
        sprite = 272,
        color = 71,
        scale = 1.0,
        label = 'Pan Shop',
      
        Ped = "a_m_m_golfer_01", -- Choose from https://docs.fivem.net/docs/game-references/ped-models/
        vector = vector4(412.3106, 314.5237, 103.0212 - 1, 204.8877),
        Heading = 100,
        Icon = 'fas fa-coins',
        IconColor = '#FEEFC6',
        BuyIcon = "fas fa-money-bill-wave",
        BuyIconColor = '#FEEFC6',
      
        SellIcon = "fas fa-money-bill-wave",
        SellIconColor = '#FEEFC6',
        },
      
    -- Swap shop
    SwapShop = {
        enable = true,
        enableblip = true,
        sprite = 272,
        color = 71,
        scale = 1.0,
        label = 'Swap Shop',
          
        Ped = "a_m_m_golfer_01", -- Choose from https://docs.fivem.net/docs/game-references/ped-models/
        vector = vector4(-1316.2986, -383.7783, 36.6692 - 1, 119.6023),
        Icon = 'fas fa-shuffle',
        IconColor = '#FEEFC6',
    }

Server-side

 
  -- Panning
  Cooldown = 60, -- in seconds
  EnablePanNothing = false, -- true or false
  PanNothingChance = 50,

  EnablePanMoney = false, -- true or false
  PanMoney = {
    chance = 100,
    min = 100,
    max = 200,
    notification = true, -- true or false
  },


  EnablePanBreak = true,
  BronzeBreakChance = 100,
  IronBreakChance = 60,
  GoldBreakChance = 30,


  DiscordWebhook = '',

  -- Common items you can get with the Bronze Gold pan
  CommonItems = {
    chance = 100,
    min = 1,
    max = 1,
    enablegoldnuggets = true,
    goldnuggets = 1,
    items = {'seaweed'},
    notification = true, -- true or false
  },

  -- Unique items you can get with the Iron Gold pan
  UniqueItems = {
    chance = 100,
    min = 1,
    max = 1,
    enablegoldnuggets = true,
    goldnuggets = 3,
    items = {'gold_earrings', 'gold_ring'},
    notification = true, -- true or false
  },

  -- Special items you can get with the Gold Gold pan
  SpecialItems = {
    chance = 100,
    min = 1,
    max = 3,
    enablegoldnuggets = true,
    goldnuggets = 5,
    items = {'gold_watch', 'gold_necklace'},
    notification = true, -- true or false
  },

  -- Shop
  buyitems = {
      { title = 'Bronze Gold pan', icon = 'fas fa-coins', iconColor = '#FEEFC6', description = 'Price: €100', item = 'bronze_goldpan', buyprice = 100},
      { title = 'Iron Gold pan', icon = 'fas fa-coins', iconColor = '#FEEFC6', description = 'Price: €1000', item = 'iron_goldpan', buyprice = 1000},
      { title = 'Gold Gold pan', icon = 'fas fa-coins', iconColor = '#FEEFC6', description = 'Price: €5000', item = 'gold_goldpan', buyprice = 5000},
  },

  sellitems = {
      { title = 'Seaweed', icon = 'fas fa-coins', iconColor = '#FEEFC6', description = 'Price: €15', item = 'seaweed', sellprice = 15},
      { title = 'Gold earrings', icon = 'fas fa-coins', iconColor = '#FEEFC6', description = 'Price: €100', item = 'gold_earrings', sellprice = 100},
      { title = 'Gold ring', icon = 'fas fa-coins', iconColor = '#FEEFC6', description = 'Price: €125', item = 'gold_ring', sellprice = 125},
      { title = 'Gold watch', icon = 'fas fa-coins', iconColor = '#FEEFC6', description = 'Price: €200', item = 'gold_watch', sellprice = 200},
      { title = 'Gold necklace', icon = 'fas fa-coins', iconColor = '#FEEFC6', description = 'Price: €200', item = 'gold_necklace', sellprice = 200},
  },

  -- Swap Shop
  swapitems = {
    { title = 'Gold necklace', icon = 'fas fa-shuffle', iconColor = '#FEEFC6', description = 'Price: 5x Gold nuggets', sellprice = 5, item = 'gold_necklace'},
  },

  currencyswapitem = 'gold_nuggets',

Dependencies

• QBCore/QBX
• ox_lib

Recommended

• ox_target: SG Panning is build with ox_target in mind. You can edit and make your own target system work by editing the client files.
• ox_inventory: SG Panning is build with ox_inventory in mind. You can edit and make your own target system work by editing the bridge server files.

Links

Scripto Goat Documentation
Scripto Goat Tebex - €24.20 incl. taxes / $25 USD