Usage

How to create your guides

Creating your first guide

• Go to dynamicguides/config.lua

• Copy this layout and add inside Config.Guides

--[[
[''] = {
    markBlip = vector2(0.0, 0.0),
    spots = {
        {
            pos = -- Use /getcam in-game to get this.
            title = '',
            text = '',
            time = 10000
        },
    }
},
]]--

Now create your guide according to the example below

['mechanic-job'] = { -- Unique tutorial name
        markBlip = vector2(-354.87, -128.04), -- This coords will be set as player waypoint on guide end.
        spots = {
            {
                pos = {coords = vec3(-393.66, -117.74, 50.88), rot = vec3(-29.65, 0.00, -90.51)}, -- Spot position, use /getspot while in-game to get this.
                title = 'Mechanic Job Guide', -- Title
                text = 'Welcome to the mechanic job guide, here you will learn how to do the job and what you can do as a mechanic.', -- Description
                img = 'https://cdn.discordapp.com/attachments/1125564934135230595/1125666510095003689/Towtruck-GTAV-front.webp', -- Small image URL if you want to show anything (optional)
                time = 10000, -- Time in ms (1s = 1000ms) that this spot will stay
                peds = { -- Peds that will be created during this spot (optional)
                    { 
                        model = 'a_m_m_skater_01', -- Ped model
                        coords = vector4(-371.2, -122.09, 37.68, 87.25), -- Ped coords (vector4)
                        anim = { -- Anim that the pet is doing (optional)
                            dict = 'anim@amb@casino@mini@dance@dance_solo@female@var_b@', -- Anim dict
                            name = 'high_center', -- Anim name
                        }
                        -- scenario = '' -- You can use scenario too, but don't use both anim and scenario.
                    },
                    {
                        model = 's_m_y_dockwork_01', -- Ped model
                        coords = vector4(-352.86, -119.92, 39.43, 70.82) -- Ped coords
                    }
                },
                vehicles = { -- Vehicles that will be created during this spot (optional)
                    {
                        model = 'flatbed', -- Vehicle model
                        coords = vector4(-371.46, -107.61, 38.77, 70.45) -- Vehicles coords (vector4)
                    },
                    {
                        model = 'towtruck', -- Vehicle model
                        coords = vector4(-356.12, -115.64, 38.78, 161.08) -- Vehicles coords (vector4)
                    },
                    {
                        model = 'sadler', -- Vehicle model
                        coords = vector4(-363.7, -137.13, 38.44, 70.72) -- Vehicles coords (vector4)
                    }
                },
                objects = { -- Objects that will be created during this spot (optional)
                    {
                        model = 'prop_carjack', -- Object model
                        coords = vector3(-354.44, -125.78, 38.43), -- Object coords (vector3)
                        rotation = vector3(0.0, 0.0, 0.0) -- Object rotation
                    },
                    {
                        model = 'prop_carjack', -- Object model
                        coords = vector3(-355.85, -129.32, 38.43), -- Object coords (vector3)
                        rotation = vector3(0.0, 0.0, 0.0) -- Object rotation
                    }
                },
            },
            {
                pos = {coords = vec3(-383.50, -256.21, 39.11), rot = vec3(-18.98, 0.00, 163.89)}, -- Spot position, use /getspot while in-game to get this.
                title = "What's the job?", -- Title
                text = 'The mechanic job is a job where you can repair and tow vehicles. You can also do custom jobs for people, such as paint jobs, engine swaps, and more.',
                vehicles = { -- Vehicles that will be created during this spot (optional)
                    {
                        model = 'towtruck', -- Vehicle model
                        coords = vector4(-383.03, -267.31, 34.68, 233.81) -- Vehicles coords (vector4)
                    },
                    {
                        model = 'sultan', -- Vehicle model
                        coords = vector4(-387.97, -263.81, 34.44, 231.5) -- Vehicles coords (vector4)
                    }
                },
                peds = { -- Peds that will be created during this spot (optional)
                    {
                        model = 'mp_m_waremech_01', -- Ped model
                        coords = vector4(-382.06, -265.99, 34.68, 87.65), -- Ped coords
                        anim = { -- In this example we're using anim, you can use scenario too. (optional)
                            dict = 'random@hitch_lift', -- Anim dict
                            name = 'idle_f', -- Anim name
                        }
                    }
                },
            },
            {
                pos = {coords = vec3(-359.76, -112.65, 39.08), rot = vec3(-0.63, 0.00, -19.57)},
                title = 'That is all!',
                text = 'Now you know how to work as mechanic, good joob!',
                peds = {
                    {
                        model = 'mp_m_weapwork_01',
                        coords = vector4(-359.21, -108.02, 38.7, 158.82),
                        anim = {
                            dict = 'anim@amb@nightclub_island@dancers@beachdance@',
                            name = 'hi_idle_a_m03',
                        }
                    },
                    {
                        model = 'mp_m_waremech_01',
                        coords = vector4(-358.48, -108.42, 38.7, 159.37),
                        anim = {
                            dict = 'anim@amb@nightclub@mini@dance@dance_solo@female@var_a@',
                            name = 'high_center',
                        }
                    },
                    {
                        model = 'mp_m_weapwork_01',
                        coords = vector4(-357.56, -108.13, 38.7, 159.73),
                        anim = {
                            dict = 'anim@amb@nightclub@mini@dance@dance_solo@male@var_a@',
                            name = 'high_center',
                        }
                    }
                }
            }
        }
    }

How to start this guide

Now that the guide is ready in config.lua you have some ways to start it.

-- Exports option:
exports.dynamicguides:start('name') -- Replace name with the guide name defined in config.lua

-- Event option (Client Side)
TriggerEvent('dynamicguides:start', 'name') -- Replace name with the guide name defined in config.lua

-- Event option (Server Side)
TriggerClientEvent('dynamicguides:start', source, 'name') -- Replace name with the guide name defined in config.lua