Evolent Boosting: Creating Custom Missions

By default we already provide 5 out of box missions: 3 low tier, 1 mid tier, and 1 high tier missions.

The main mission classes are indexed by Tier Level (e.g., Missions[1] is the lowest tier, Missions[6] is the highest). The index where you place your mission matters for difficulty and reward scaling.

Key Concepts for Customizing

Data Sharing (contract.data): This server-side table holds data that needs to be passed to the client-side for use in location markers or UI updates.
Client-Side Definition (Contracts[data.contractId]): This table holds the client-side mission logic and actions, and is linked to the server-side definition by the mission's unique ID.
Standard Steps: The wrapper functions GetBoostVehicle and DeliverVehicle are highly recommended as the first and last steps of your custom mission.
Validation: All progression and security checks should be validated using the contract.leaderId.

Create Your Own Mission

Step 1: Create Server-Side Mission Logic

Create a new file in server/missions/ (e.g., test.lua). This file defines the sequence of steps, server-side validation, and required items.

local missionModule = require('modules.mission')
local Mission = missionModule.Mission
local Step = missionModule.Step
local GetBoostVehicle = require 'server.missions.GetBoostVehicle' -- Import standard steps
local DeliverVehicle = require 'server.missions.DeliverVehicle'
 
return Mission:new({
    steps = {
        GetBoostVehicle, -- Standard Step 1: Locate and retrieve the vehicle
        Step:new({
            title = "Step 2: Locate the Drop-off",
            locations = { -- Optional locations that the client can use
                { x = 123.4, y = 567.8, z = 90.1, radius = 5.0, heading = 180.0 }
            },
            disableGps = true,
            isComplete = function(self, contract)
                -- SERVER VALIDATION FOR COMPLETION (e.g., checking if the item was delivered)
                return true
            end,
            complete = function(self, contract)
                -- EXECUTE SOME ACTION WHEN STEP GETS COMPLETED (e.g., spawning an NPC, or giving a temporary reward)
            end,
            preparation = function(self, contract, location)
                -- THIS GETS EXECUTED ONLY ONCE WHEN THE STEP STARTS (e.g., setting a variable in contract.data)
            end
        }),
        DeliverVehicle -- Standard Final Step: Deliver the vehicle for payment
    },
    requiredItems = {
        -- Items needed to start the mission
        advancedlockpick = 1 
    }
})

Step 2: Add Server-Side Mission to Tier List

Import your new mission module in server/missions/missions.lua and add it to the appropriate mission class list. The key you use must match the module name (e.g., test).

-- ... (Existing imports)
local TestMission = require 'server.missions.test'
 
-- ... (Missions[1] through Missions[3])
 
Missions[4] = { -- Example of adding a new Mid-Tier mission
    ["tower"] = TowerMission,
    ["test"] = TestMission, -- <--- Your new mission added here
}
 
-- ... (Missions[5] and Missions[6])

Step 3: Create Client-Side Mission Logic

Repeat the naming process in client/missions/ (e.g., test.lua). This file handles client-specific logic like creating blips, markers, and UI feedback. Note: The preparation function here runs for all group members.

local Mission = require('modules.mission')
 
Mission:registerClient('test', { -- Use the same mission key ('test')
    preparation = function(self, contract, location)
        -- CODE TO RUN WHEN THE MISSION STARTS ON THE CLIENT SIDE
    end,
    onStart = function(self, contract)
        -- CODE TO RUN WHEN THE CURRENT STEP STARTS (e.g., displaying a marker)
    end,
    onComplete = function(self, contract)
        -- CODE TO RUN WHEN THE CURRENT STEP IS COMPLETED (e.g., removing a marker)
    end,
    onLocation = function(self, contract, location)
        -- CODE TO RUN WHEN A LOCATION IS ACTIVE
    end
})

Step 4: Add Client-Side Mission to Tier List

Import your new mission module in client/missions/missions.lua and add it to the appropriate mission class list. The key you use must match the module name (e.g., test).

-- ... (Existing imports)
local TestMission = require 'client.missions.test'
 
-- ... (Missions[1] through Missions[3])
 
Missions[4] = { -- Example of adding a new Mid-Tier mission
    ["tower"] = TowerMission,
    ["test"] = TestMission, -- <--- Your new mission added here
}
 
-- ... (Missions[5] and Missions[6])

Config Commands