🛒Envi-Shops

Envi-Shops Official Documentation

Preview

Config Preview

236KB

config.lua

1. Config.Debug

Config.Debug = false 

Highly advise having this setting turned on when trying to setup a new shop. VERY USEFUL

2. Initial Setup for a shop

Please note: These items were used as placeholders during development. The script is designed for you to set these items to be existing shop items within your server to provide your players with a unique experience. You only need to add these items if you do not want to set the config up yourself and instead want to use basic items that we used for testing. Please be aware these testing items with have no effects and that will need to be handled via another script.

['24/7 - Strawberry'] = {
    welcomeMessage = 'Welcome to 24/7! - Where dreams come true!',
    mainShopZone = { points = { vec3(33.8501, -1349.2050, 29.4970), vec3(23.2821, -1349.5566, 29.4970), vec3(23.9225, -1337.2926, 29.4970), vec3(34.0443, -1338.5358, 29.4970) } },
    shopKeeper = { location = vec3(24.4608, -1347.2600, 28.4970), heading = 266.0, model = 'mp_m_shopkeep_01', label = 'Shop Keeper', netID = nil},
    baskets = { location = vec3(30.88, -1348.46, 29.0), label = 'Grab/Return Basket', dimensions = { length = 0.5, width = 0.5, height = 1 } },
    maxNoBasketItems = 3,  -- amount of items you can add to your basket without having a basket prop in your hand
    enabled = true, -- THIS LINE IS NEW IN 1.1.0 - set to false to disable the shop (useful if you want to temporarily disable a shop without deleting the whole shop and needed for DisableShop export)
    blip = {
        name = '24/7',
        sprite = 59,
        colour = 25,
        scale = 0.8,
    },
    counter = {
        location = vec3(24.8423, -1346.4615, 29.4970),
        dimensions = { length = 1, width = 4.5, height = 1 },
        distance = 1.2,
        label = 'View Counter',
        anims = { 
            checkedOut = {
                dict = 'gestures@m@car@std@casual@ps',
                anim = 'gesture_hello',
            },
            addCounterItem = {
                dict = 'gestures@m@car@std@casual@ps', 
                anim = 'gesture_hand_left',
            }
        },
        stock = {
            paperbag = { label = 'Paper Bag', price = 2, quantity = 10, metadata = {} },
            cigarettes_redwood = { label = 'Cigarettes', price = 10, quantity = 10, metadata = {} },
            lighter = { label = 'Lighter', price = 10, quantity = 10, metadata = {} },
            rolling_paper = { label = 'Rolling Paper', price = 5, quantity = 20, metadata = {} },
        }
    },

FIRSTLY make sure your name is UNIQUE.

mainShopZone = { points = { vec3(33.8501, -1349.2050, 29.4970), vec3(23.2821, -1349.5566, 29.4970), vec3(23.9225, -1337.2926, 29.4970), vec3(34.0443, -1338.5358, 29.4970) } },

Ensure the Z (3rd co-ordinate) in vector3 is ALWAYS the same across all vec3 listings

shopKeeper = { location = vec3(24.4608, -1347.2600, 28.4970), heading = 266.0, model = 'mp_m_shopkeep_01', label = 'Shop Keeper', netID = nil},

This label never changes just make sure to set the heading and vec3 correctly.

    blip = {
        name = '24/7',
        sprite = 59,
        colour = 25,
        scale = 0.8,
    },
    counter = {
        location = vec3(24.8423, -1346.4615, 29.4970),
        dimensions = { length = 1, width = 4.5, height = 1 },
        distance = 1.2,
        label = 'View Counter',
        anims = { 
            checkedOut = {
                dict = 'gestures@m@car@std@casual@ps',
                anim = 'gesture_hello',
            },
            addCounterItem = {
                dict = 'gestures@m@car@std@casual@ps', 
                anim = 'gesture_hand_left',
            }
        },
        stock = {
            paperbag = { label = 'Paper Bag', price = 2, quantity = 10, metadata = {} },
            cigarettes_redwood = { label = 'Cigarettes', price = 10, quantity = 10, metadata = {} },
            lighter = { label = 'Lighter', price = 10, quantity = 10, metadata = {} },
            rolling_paper = { label = 'Rolling Paper', price = 5, quantity = 20, metadata = {} },
        }
    },

The blip is FULLY customisable to your likings and will stack with others that are the same name. example if you want all 24/7 shops to be the same use the same blip format over ALL of them.

Counter is for setting up your counter products that are set in the stock section above.

By default these are placeholder items make sure to change them to your own items within your city.

3. Shelving setup

shelves = {
            ['Drink Shelf'] = {
                location = vec3(27.5508, -1345.3021, 29.4970), -- Ecole Sprunk can/bottles
                dimensions = { length = 1, width = 2, height = 1 },
                distance = 1.2,
                label = 'View Drinks',
                anims = {
                    noBasket = {
                        dict = 'gestures@m@car@std@casual@ps',
                        anim = 'gesture_hand_left',
                    },
                    basket = {
                        dict = 'gestures@m@car@std@casual@ps',
                        anim = 'gesture_hand_right',
                    }
                },
                stock = {
                    water = { label = 'Water', price = 40, quantity = 50, metadata = { type = 'bottled'} },  -- EXAMPLE OF METADATA ITEM
                    cranberry = { label = 'Fruit Punch', price = 55, quantity = 20, metadata = {} },
                    ecola = { label = 'eCola', price = 50, quantity = 50, metadata = {} },
                    ecoladiet = { label = 'eCola Diet', price = 50, quantity = 50, metadata = {} },
                    sprunk = { label = 'Sprunk', price = 50, quantity = 50, metadata = {} },
                    sprunklight = { label = 'Sprunk Light', price = 50, quantity = 50, metadata = {} },

                }
            },
            ['Savory Shelf'] = { --Rails/Crackles/Tuna/Chickenpot
                location = vec3(28.7508, -1345.3021, 29.4970),
                dimensions = { length = 1, width = 2, height = 1 },
                distance = 1.2,
                label = 'View Shelf',
                anims = {
                    noBasket = {
                        dict = 'gestures@m@car@std@casual@ps',
                        anim = 'gesture_hand_left',
                    },
                    basket = {
                        dict = 'gestures@m@car@std@casual@ps',
                        anim = 'gesture_hand_right',
                    }
                },
                stock = {
                    twerks_candy = { label = 'Twerks Candy', price = 10, quantity = 10, metadata = {} },
                    snikkel_candy = { label = 'Snikkel Candy', price = 10, quantity = 10, metadata = {} }
                }
            },
            ['Cans Shelf'] = { --Tomato/Vegetable soup/ Ketchup/Mayonnaise
                location = vec3(30.3508, -1345.3021, 29.4970),
                dimensions = { length = 1, width = 2, height = 1 },
                distance = 1.2,
                label = 'View Shelf',
                anims = {
                    noBasket = {
                        dict = 'gestures@m@car@std@casual@ps',
                        anim = 'gesture_hand_left',
                    },
                    basket = {
                        dict = 'gestures@m@car@std@casual@ps',
                        anim = 'gesture_hand_right',
                    }
                },
                stock = {
                    mustard = { label = 'Mustard', price = 12, quantity = 20, metadata = {} },
                    jar_coffee = { label = 'Coffee', price = 10, quantity = 20, metadata = {} },
                    sunfloweroil = { label = 'Sunflower Oil', price = 10, quantity = 20, metadata = {} },
                }
            },
            ['Beers Shelf'] = { -- Pride Brew/AM Beer
                location = vec3(31.6508, -1345.3021, 29.4970),
                dimensions = { length = 1, width = 2, height = 1 },
                distance = 1.2,
                label = 'View Shelf',
                anims = {
                    noBasket = {
                        dict = 'gestures@m@car@std@casual@ps',
                        anim = 'gesture_hand_left',
                    },
                    basket = {
                        dict = 'gestures@m@car@std@casual@ps',
                        anim = 'gesture_hand_right',
                    }
                },
                stock = {
                    beer = { label = 'Beer', price = 30, quantity = 40, metadata = {} },
                    ambeer = { label = 'AM Beer', price = 30, quantity = 40, metadata = {} },
                }
            },
            ['Other Shelf'] = { -- Salsa/Chips/Cleaning products
                location = vec3(29.0147, -1342.5839, 29.4970),
                dimensions = { length = 2, width = 1, height = 1 },
                distance = 1.2,
                label = 'View Shelf',
                anims = {
                    noBasket = {
                        dict = 'gestures@m@car@std@casual@ps',
                        anim = 'gesture_hand_left',
                    },
                    basket = {
                        dict = 'gestures@m@car@std@casual@ps',
                        anim = 'gesture_hand_right',
                    }
                },
                stock = {
                    cleaningkit = { label = 'Cleaning Kit', price = 100, quantity = 10, metadata = {} },
                    weed_nutrition = { label = 'Weed Nutrition', price = 180, quantity = 10, metadata = {} },
                }
            },
            ['Main Fridge'] = { -- Milk/Meat/Juice/Frozen
                location = vec3(32.3889, -1342.5952, 29.4970),
                dimensions = { length = 4, width = 0.5, height = 2 },
                distance = 1.2,
                label = 'Open Fridge',
                anims = {
                    noBasket = {
                        dict = 'gestures@m@car@std@casual@ps',
                        anim = 'gesture_hand_left',
                    },
                    basket = {
                        dict = 'gestures@m@car@std@casual@ps',
                        anim = 'gesture_hand_right',
                    }
                },
                stock = {
                    sandwich = { label = 'Sandwich', price = 30, quantity = 30, metadata = {} },
                    pizza = { label = 'Pizza', price = 50, quantity = 30, metadata = {} },
                    fries = { label = 'Fries', price = 10, quantity = 30, metadata = {} },
                }
            },
            ['Beers Fridge'] = { -- Self Explanatory
                location = vec3(33.9137, -1346.6758, 29.4970),
                dimensions = { length = 0.5, width = 4, height = 2 },
                distance = 1.2,
                label = 'Browse Beers',
                anims = {
                    noBasket = {
                        dict = 'gestures@m@car@std@casual@ps',
                        anim = 'gesture_hand_left',
                    },
                    basket = {
                        dict = 'gestures@m@car@std@casual@ps',
                        anim = 'gesture_hand_right',
                    }
                },
                stock = {
                    beer = { label = 'Beer', price = 30, quantity = 1000, metadata = {} },
                    ambeer = { label = 'AM Beer', price = 30, quantity = 100, metadata = {} },
                }
            },
            ['Fruit Stand'] = { -- Self Explanatory
                location = vec3(26.6646, -1348.5793, 29.4970),
                dimensions = { length = 2, width = 1, height = 2 },
                distance = 1.2,
                label = 'Browse Fruits',
                anims = {
                    noBasket = {
                        dict = 'gestures@m@car@std@casual@ps',
                        anim = 'gesture_hand_left',
                    },
                    basket = {
                        dict = 'gestures@m@car@std@casual@ps',
                        anim = 'gesture_hand_right',
                    }
                },
                stock = {
                    apple_red = { label = 'Red Apple', price = 7, quantity = 40, metadata = {} },
                    apple_green = { label = 'Green Apple', price = 7, quantity = 40, metadata = {} },
                    banana = { label = 'Banana', price = 5, quantity = 40, metadata = {} },
                    blueberries = { label = 'Blueberries', price = 8, quantity = 40, metadata = {} },
                }
            },
            ['Drink Station'] = { -- Slush Machine
                location = vec3(26.8147, -1342.5839, 29.4970),
                dimensions = { length = 2, width = 1, height = 1 },
                distance = 1.2,
                label = 'Drink Station',
                anims = {
                    noBasket = {
                        dict = 'gestures@m@car@std@casual@ps',
                        anim = 'gesture_hand_left',
                    },
                    basket = {
                        dict = 'gestures@m@car@std@casual@ps',
                        anim = 'gesture_hand_right',
                    }
                },
                stock = {
                    slushy = { label = 'Slushy', price = 55, quantity = 20, metadata = {} },
                }
            },
            ['Liquor Shelf'] = { -- Self Explanatory
                location = vec3(24.2241, -1343.5574, 29.4970),
                dimensions = { length = 1, width = 1, height = 2 },
                distance = 1.2,
                label = 'Browse Liquor',
                anims = {
                    noBasket = {
                        dict = 'gestures@m@car@std@casual@ps',
                        anim = 'gesture_hand_left',
                    },
                    basket = {
                        dict = 'gestures@m@car@std@casual@ps',
                        anim = 'gesture_hand_right',
                    }
                },
                stock = {
                    vodka = { label = 'Vodka', price = 85, quantity = 20, metadata = {} },
                    whiskey = { label = 'Whiskey', price = 85, quantity = 20, metadata = {} },
                    gin = { label = 'Gin', price = 75, quantity = 20, metadata = {} },
                }
            },
            ['Donut Stand'] = { -- Self Explanatory
                location = vec3(31.0737, -1347.0089, 29.4970),
                dimensions = { length = 1, width = 1, height = 1.5 },
                distance = 1.2,
                label = 'Browse Sweet Treats',
                anims = {
                    noBasket = {
                        dict = 'gestures@m@car@std@casual@ps',
                        anim = 'gesture_hand_left',
                    },
                    basket = {
                        dict = 'gestures@m@car@std@casual@ps',
                        anim = 'gesture_hand_right',
                    }
                },
                stock = {
                    donutbox = { label = 'Donut Box', price = 20, quantity = 10, metadata = {} },
                    donutbox2= { label = 'Donut Box', price = 20, quantity = 10, metadata = {} },
                }
            }
        }
    },

Each shelf has its own UNIQUE name. With Config.Debug turned on these can easily be seen and allow you to make minor adjustments to get them to position where you see fit. Good practice is to stand central to the position you are trying to use and to take your vec3 position from there.

4. Exports guide

The Envi-Shops resource provides several exports that allow other scripts to interact with the shop system. Below are the available exports and their usage:

DisableShop Disables a specific shop by its ID.

Usage:

exports['envi-shops']:DisableShop(shopID, cooldownTime)

Parameters:

• shopID (string): The ID of the shop to disable.

• cooldownTime (number): The cooldown time in seconds before the shop is auto-enabled again.

EnableShop Enables a specific shop by its ID.

Usage:

exports['envi-shops']:EnableShop(shopID)

Parameters:

• shopID (string): The ID of the shop to enable.

DisableAllShops Disables all shops.

Usage:

exports['envi-shops']:DisableAllShops(cooldownTime)

Parameters:

• cooldownTime (number): The cooldown time in seconds before the shops are auto-enabled again.

• EnableAllShops Enables all shops. Usage: exports['envi-shops']:EnableAllShops()

Example Usage

Here is an example of how you might use these exports in another script:

Disabling a specific shop

• exports['envi-shops']:DisableShop('24/7 - Strawberry') -- Disables '24/7 - Strawberry' until it is enabled again.

Disabling a specific shop with a cooldown

• exports['envi-shops']:DisableShop('24/7 - Strawberry', 300) -- Disables '24/7 - Strawberry' for 300 seconds (5 mins)

Enabling a specific shop

• exports['envi-shops']:EnableShop('24/7 - Strawberry')-- Enables '24/7 - Strawberry' if it is disabled

Disabling all shops

• exports['envi-shops']:DisableAllShops() -- Disables ALL Shops until they are enabled again.

Disabling all shops with a cooldown

• exports['envi-shops']:DisableAllShops(600) -- Disables ALL Shops for 600 seconds (10 mins)

Enabling all shops

• exports['envi-shops']:EnableAllShops()-- Enables All Shops