Bring a complete fishing experience to your RedM server**. Classic fishing minigame, ** bait and lure items and attraction settings, legendary fish spawn, compendium tracking, fishing ranks, shops, deliveries.
Features
Classic fishing minigame brought to RedM - It uses defaut fishing game controls
Fillet making system
VORP and RSG support
Bait and lure item support
Legendary fish spawns
Legendary fish map item
Fishing compendium
Fishing rank and XP progression
Rank rewards
Fishing shop system
Buy lures, bait, and fishing items
Sell fish at configured shops
Convert fish into shop materials
Shop production and goods system
Boat-based delivery missions
Optional sirevlc_boats integration
Optional posse delivery support
Configurable shop NPCs, blips, prices, rewards, and delivery points
Configurable fish prices, material values, bait preferences, and legendary zones
Item images and menu integration with sire_menu
==================================================
--INSTALLATION--
==================================================
### Installation Instructions
## 1. Link your server to CFX Portal
Make sure your server is properly linked to your **CFX Portal** account.
## 2. Install a MySQL resource
Ensure **oxmysql** is installed and working correctly on your server.
## 3. Download sire_menu
Download **sire_menu** from the Tebex email or from our Discord file section.
## 4. Download notifications resource and images
Download **sirevlc_notifications** and the **images provided via Tebex email**.
The images are also available in our Discord file channel.
## 5. Download required granted assets (cfx.re portal)
From your **cfx.re portal -> Granted Assets**, download the required resources.
Make sure you are using the **correct versions for your framework**, then place them directly into your server's **resources folder**.
## 6. Required resources:
- `sire_menu`
- `sirevlc_notifications`
- `sirevlc_fishing`
Optional resources:
- `sirevlc_boats` if `Config.USE_SIREVLC_BOATS = true`
- `sirevlc_posse_system` if `Config.USE_SIREVLC_POSSE_SYSTEM = true`
- your weather sync resource if `Config.WEATHER_SYNC = true`
Use an archive extractor such as **WinRAR** and FTP software such as WinSCP.
Make sure WinSCP transfer mode is in **BINARY MODE**.
Ensure the **.fxap files** are correctly imported for:
- `sirevlc_fishing`
`.fxap` files are required for **cfx.re authentication**.
## 7. Ensure resources in the correct order
In your `server.cfg` or `resources.cfg`, ensure the resources in the following order:
```cfg
ensure oxmysql
ensure \
ensure sire_menu
ensure sirevlc_notifications
ensure sirevlc_boats
ensure sirevlc_posse_system
ensure sirevlc_fishing
```
Important:
* `sire_menu` must be ensured before all other sire resources.
* If you do not use `sirevlc_boats`, set `Config.USE_SIREVLC_BOATS = false`.
* If you do not use `sirevlc_posse_system`, set `Config.USE_SIREVLC_POSSE_SYSTEM = false`.
* Do not ensure these resources as subfolders, as this can break the ensure order.
## 8. Select your framework
Open `CONFIG/MAIN.lua` and select your framework:
```lua
Config.VORP = true
Config.RSG = false
```
Only one framework should be enabled at a time.
For RSG, also check:
```lua
Config.RSG_CASH_MONEY_TYPE = "cash"
Config.RSG_GOLD_MONEY_TYPE = "bloodmoney"
```
## 9. Import the database file
Import the following file into your database:
```text
sirevlc_fishing.sql
```
The script also tries to create missing fishing tables at runtime, but importing the SQL file manually is recommended.
## 10. Set up fishing items
Open `fish_item_instructions.txt` from **sirevlc_fishing** and follow the instructions for your framework.
This file contains:
- fish inventory items
- bait items
- lure items
- legendary fish map item
- VORP SQL item definitions
- RSG `items.lua` item definitions
Make sure the following usable items exist if you use the default config:
```text
upgrade_fsh_bait_bread
upgrade_fsh_bait_corn
upgrade_fsh_bait_cheese
upgrade_fsh_bait_worm
upgrade_fsh_bait_cricket
upgrade_fsh_bait_crayfish
upgrade_fsh_bait_lure_river
upgrade_fsh_bait_lure_lake
upgrade_fsh_bait_lure_swamp
upgrade_fsh_bait_leg_lure_river
upgrade_fsh_bait_leg_lure_lake
upgrade_fsh_bait_leg_lure_swamp
upgrade_fsh_bait_spinner_freshwater_leg
document_map_legendary_fish
```
## 11. Install item images
Copy the **image files only** (not the folder itself) into:
```text
sire_menu/html/items
```
The fishing shop menu uses image paths configured in:
```text
CONFIG/SHOPS.lua
```
Main image settings:
- `Config.FishingShopMenuImages`
- `Config.FishingShopLures`
- `Config.FishInventoryItems`
- `Config.FishingRank`
## 12. Configure fishing
Main configuration files:
```text
CONFIG/MAIN.lua
CONFIG/FISH.lua
CONFIG/COMPENDIUM.lua
CONFIG/ROLE.lua
CONFIG/SHOPS.lua
```
Useful config sections:
- `Config.Baits` controls which fish like which bait.
- `Config.RegisteredFishingBaitItems` controls usable bait items.
- `Config.RegisteredFishingMapItems` controls usable map items.
- `Config.LegendaryFishManualSpawns` controls legendary fish zones.
- `Config.FishingRank` controls XP, ranks, and rank rewards.
- `Config.FishingShopSalePoints` controls fishing shop NPCs, blips, and delivery points.
- `Config.FishingShopLures` controls shop lure and map purchases.
- `Config.FishingShopFishSellPrices` controls fish sale prices.
- `Config.FishingShopFishMaterials` controls fish material conversion.
- `Config.FishingShopDeliveryPosse` controls posse delivery support.
## 13. Optional boat integration
If `Config.USE_SIREVLC_BOATS = true`, delivery boats are read from `sirevlc_boats`.
If set to `false`, the fishing resource uses its own boat table:
```text
sirevlc_fishing_boats
```
## 14. Optional posse integration
If `Config.USE_SIREVLC_POSSE_SYSTEM = true`, fishing deliveries can use `sirevlc_posse_system`.
The script will:
- open a mission lobby for posse deliveries
- mark delivery members busy during the mission
- clear their busy state when the delivery completes, fails, or is cancelled
## 15. Enjoy!
==================================================
--REQUIREMENTS--
==================================================
x- VORP or RSG framework
x- sire_menu
x- sirevlc_notifications
x- oxmysql or ghmattimysql
x- sirevlc_fishing
Optional:
x- sirevlc_boats
x- sirevlc_posse_system
x- weather sync resource
