🎣 FX-FISHING

Advanced fishing system for RedM with rod upgrade system, XP progression, minigame support, and full framework compatibility.

---

📦 INSTALLATION

ensure fx-fishing

• Place the script inside resources/fx-fishing • Add ensure fx-fishing to your server.cfg • Restart your server • Make sure oxmysql starts before this script

---

⚙️ DEPENDENCIES

dependencies {
    'oxmysql'
}

• Required for database operations • Script will not work without it • You can use tools like HeidiSQL or phpMyAdmin to manage your database

---

🗄️ SQL INSTALLATION (VORP)

-- fx-fishing-vorp.sql

• Required for storing fishing data • Includes fish items, pearls, upgrade items • Must be executed before using the script

---

📦 RSG ITEM INSTALL

['fishingrod'] = {
    name = 'fishingrod',
    label = 'Fishing Rod',
    weight = 100,
    type = 'item',
    image = 'fishingrod.png',
    unique = true,
    useable = true,
}

• Required if using RSG framework • fishingrod must be unique = true • useable must be enabled

---

⚙️ BASIC CONFIG

Config.Language = "en"
Config.Mode = false
Config.FishingrodMovement = false
Config.RemoveBaitOnFailed = false
Config.ShowFishWhenUseFish = true

• Language → system language • Mode → enables minigame system • FishingrodMovement → rod movement mechanic • RemoveBaitOnFailed → removes bait if failed • ShowFishWhenUseFish → shows fish when used

---

🎮 MINIGAME SYSTEM

Config.Mode = "minigame"

• Enables fishing minigame • If false → direct catch system • Requires compatible minigame resource

---

🐟 FISH SYSTEM

Config.FishData = {
    {
        model = "A_C_FISHBLUEGIL_01_MS",
        bigFish = false,
        worthyFish = true,
        xpCount = 5,
        luck = 70,
    },
}

• Defines all fish types • model → ped model of fish • bigFish → large fish flag • worthyFish → valuable fish • xpCount → XP reward • luck → catch probability

---

🎯 FISH ITEM MAPPING

Config.ItemNameByFishName = {
    ["A_C_FISHBLUEGIL_01_MS"] = "a_c_fishbluegil_01_ms",
}

• Maps fish models to inventory items • Required for giving correct item • Must match database item names

---

🏷️ FISH LABEL SYSTEM

Config.FishLabels = {
    ["A_C_FISHBLUEGIL_01_MS"] = "Blue Gil (Medium)",
}

• Defines display names of fish • Used in notifications and UI

---

🐟 FISHING SETTINGS

Config.Settings = {
    distance = 20,
    fishSpeed = 0.5,
    fishTimeout = 20,
}

• distance → fishing detection range • fishSpeed → minigame difficulty • fishTimeout → max catch time

---

🧱 UPGRADE NPC SYSTEM

Config.UpgradeNPCS = {
    ["valentine"] = {
        model = "cs_charlessmith",
        coords = vector4(-364.5, 802.8, 116.80, 120.2352),
        showblip = true,
    },
}

• NPC used for rod upgrades • Players interact to upgrade rods • Supports job restrictions

---

📊 ROD LEVEL SYSTEM

Config.FishingRodLevel = {
    [1] = 1000,
    [2] = 2000,
}

• Defines XP required per rod level • Higher level → better fishing chance

---

🎲 UPGRADE SUCCESS SYSTEM

Config.FishingRodUpgradeLucky = {
    [1] = 100,
    [2] = 95,
}

• Upgrade success chance per level • Lower value → harder upgrade

---

💎 UPGRADE MATERIALS

Config.FishingRodUpgradeItems = {
    [1] = {
        {name="whitepearl",count=1},
    },
}

• Required items for upgrading rod • Each level has different requirements

---

🧪 UPGRADE STONES

Config.UpgradeStones = {
    ["rituel10"] = {
        lucky = 10,
        drop_level_if_failed = false,
    },
}

• Adds bonus success chance • Some items reduce failure penalty

---

🎁 PEARL SYSTEM

Config.PearlLuckys = {
    ["whitepearl"] = 30,
}

• Defines pearl drop chances • Used for upgrade system

---

🔔 NOTIFY SYSTEM

Notify({
  text = "Fishing Started",
  type = "success"
})

• Framework-based notification system • Supports VORP / RSG • Customizable

---

⚙️ SERVER CONFIG

SV_Config.Webhook = {
    url = "",
    logo = "",
    banner = "",
}

• Used for logs and webhook integrations • Optional but recommended

---

🎯 COMMAND SYSTEM

fishEvent 2

• Activates global fishing bonus • Multiplies fish and XP • Example → 2 = 2x reward

---

⚠️ IMPORTANT NOTES

• fishingrod must be unique item • ItemNameByFishName must match database • oxmysql must be running • Upgrade items must exist • SQL must be installed

---

🚨 COMMON MISTAKES

• Missing fishingrod item • Wrong item names • Missing SQL import • Not setting rod as unique • Missing bait item

---

🏁 SUMMARY

FX-Fishing provides:

• Advanced fishing system • Rod upgrade & XP system • Minigame support • NPC interaction system • Full framework compatibility

---

© Fixitfy Development