Store

The fishing store system allows players to purchase fishing rods, baits, tackle, and fishing nets from a merchant NPC.

General Configuration

enabled = true
enabledrequiredboolean
true
Allows you to enable or disable the entire fishing store system. When set to false, the merchant NPC won't spawn, and players won't be able to purchase fishing items.

Merchant Configuration

The merchant section defines the NPC who sells fishing equipment:

merchant = {
    coords = vec4(-1686.44, -1072.52, 12.15, 84.42),

    model = 'a_m_y_beach_01',
    scenario = 'WORLD_HUMAN_STAND_FISHING',

    blip = {
        enabled = true,
        sprite = 371,
        display = 4,
        scale = 0.7,
        colour = 3,
        label = 'Fishing Store'
    }
}
merchant.coordsrequiredvector4
The coordinates where the merchant will spawn (x, y, z, heading).
merchant.modelrequiredstring
'a_m_y_beach_01'
The model name of the NPC merchant who sells fishing equipment.
merchant.scenariorequiredstring
'WORLD_HUMAN_STAND_FISHING'
The animation scenario the merchant will use.

Merchant Blip Configuration

The merchant.blip section controls how the merchant appears on the map:

blip = {
    enabled = true,
    sprite = 371,
    display = 4,
    scale = 0.7,
    colour = 3,
    label = 'Fishing Store'
}
merchant.blip.enabledrequiredboolean
true
Whether to show the merchant's location on the map.
merchant.blip.spriterequirednumber
371
The blip sprite ID to use on the map.
merchant.blip.displayrequirednumber
4
The blip display mode on the map.
merchant.blip.scalerequirednumber
0.7
The size of the blip on the map.
merchant.blip.colourrequirednumber
3
The blip color ID to use on the map.
merchant.blip.labelrequiredstring
'Fishing Store'
The text label shown on the map for the merchant.

Currency Configuration

currency = 'money'
currencyrequiredstring
'money'
The inventory item name used as currency for purchases at the fishing store.

Categories and Items Configuration

The categories section defines the different categories of items available in the store:

categories = {
    {
        id = 'rods',
        label = 'Fishing Rods',
        icon = 'fish',
        items = {
            {
                name = 'fishing_rod',
                tier = 0,
                price = 15000
            }
        }
    },
    {
        id = 'baits',
        label = 'Fishing Baits',
        icon = 'worm',
        items = {
            { name = 'earthworm', price = 5 },
            { name = 'bread', price = 5 },
            { name = 'corn', price = 8 },
            { name = 'maggots', price = 8 },
            { name = 'minnow', price = 12 },
            { name = 'nightcrawler', price = 15 },
            { name = 'bloodworm', price = 20 },
            { name = 'squid', price = 25 },
            { name = 'magnet', price = 50 }
        }
    },
    {
        id = 'tackle',
        label = 'Fishing Tackle',
        icon = 'fish-fins',
        items = {
            { name = 'bobber', price = 2000 },
            { name = 'spinner', price = 3500 },
            { name = 'sinker_set', price = 6000 },
            { name = 'premium_tackle', price = 8500 }
        }
    },
    {
        id = 'nets',
        label = 'Fishing Nets',
        icon = 'boxes',
        items = {
            { name = 'fishing_net', price = 20000 }
        }
    }
}
categoriesrequiredarray
An array of categories that group similar types of fishing items.

Category Configuration

Each category in the categories array has the following properties:

idrequiredstring
A unique identifier for the category.
labelrequiredstring
The display name for the category shown in the UI.
iconrequiredstring
The icon used to represent the category in the UI. Uses Font Awesome icon names.
itemsrequiredarray
An array of items available in this category.

Item Configuration

Each item in a category's items array has the following properties:

namerequiredstring
The inventory item name of the product.
pricerequirednumber
The price of the item in the currency specified by the global currency setting.
tiernumber
For tiered items like fishing rods, specifies the tier level of the item. Only required for tiered items.