GMod Quests

Requirements

Icons:

https://steamcommunity.com/sharedfiles/filedetails/?id=3424588083

ULX Access

• quests.manage - Grants access to the admin interface and ability to create new quests.
• quests.reroll - Grants access to the RerollQuests console command

ConVars

• quests_startingQuests [num] - The amount of quests available to a player by default. 1 by default
• daily_reroll_time [HH:mm] - The time the quests get reset. 00:00 by default.

ConCommands:

ttt_quest_menu

Usage: ttt_quest_menu
No parameters. Just toggles the quest menu on and off.

AddQuest

Usage: AddQuest [QuestType] [weight] [finishInOneRound] [parameters] [rewards]

There are (by default) up to 3 rewards in the following order:
Pointshop 2 points, Pointshop 2 premium points, Exp for a proprietary skilltree (You can leave it empty or set it 0. It will still work without it).

The weight determines how likely it is to appear. The higher, the more likely.
Formula: (weight/Sum(allQuestsWeights)) * 100 = Chance in %
So if the quest has a weight of 50, all quests (including this) have a total weight of 200, theres a ((50/200) * 100)% chance for the quest to appear (25% in this example).
finishedInOneRound is a bool (0 and 1). If set then the quest resets if not finished after a round passes.

Killquest parameters:

[requiredKills] [roleToBeKilled] [roleForKiller]

Role ID	Role Name
0	Innocent
1	Traitor
2	Detective

e.g.:

• AddQuest KillQuest 50 0 5 0 1 50000 200 25000

WARNING: Some methds return it as number, but we use it as a string, so it may needs to be converted (I personally just tostring the number)

WalkerQuest parameters:

[requiredSteps]
e.g.:

• AddQuest WalkerQuest 50 0 50 50000 200 25000

SurviveQuest parameters:

[rounds]
e.g.:

• AddQuest SurviveQuest 50 0 5 50000 200 25000

KarmaQuest parameters:

[minKarma] [rounds]
e.g.:

• AddQuest KarmaQuest 50 0 1200 5 50000 200 25000

Development

To add a new quest you must reqister it with:

QuestManager.questTypes = {
    KillQuest = KillQuest,
    WalkerQuest = WalkerQuest
}

e.g. QuestManager.questTypes.CollectQuest = CollectQuest
A quests UI must be registered with vgui.Register(quest.type .. "HUD", PANEL, "EditablePanel")
They are not automatically loaded (unlike quests which are), so make sure you include them in the autorun of your extension.

Hooks

Server

Client

QuestsUpdated

Gets called after the client got a new update for the local player's active quests. This sends a table of Quests as argument.

hook.Add("QuestsUpdated", "UpdateQuestHUD", function(questsTable)
    -- Update your quests HUD
end)

UpdateFinishedQuests

This gets called when a quest finishes and needs to be shown. Also gets called on initial finished quests load.

hook.Add("UpdateFinishedQuests", "UpdateFinishedQuestHUD", function(questsTable)   
    -- Update Finished Quests HUD
end)

sendClaimedRewards

This hook calls with the rewards of the last claimed quest to for example show them in a popup.

hook.Add("sendClaimedRewards", "PointDisplaySystem", function(rewards)
    -- show a popup or sthg
end)

QuestNotEnoughArgs

Gets called when the user tries to input a new quest but doesnt deliver all necessary args

hook.Add("QuestNotEnoughArgs", "uniqueName", function(err)
  -- Display the error here
end)

AvailableQuestsUpdated

Gets called on the client after the server registered a new quest. Server registers quests on startup as well.

hook.Add("AvailableQuestsUpdated", "uniqueName", function(quests)
  -- loop over quests and display them
end)

AddAvailableQuest

The backend listens to this when you want to add a new quest.

hook.Run("AddAvailableQuest", questBase)

UpdateAvailableQuest

The backend listens to this when you want to change an existing quests value. Quests are found via their uniqueId, so thats a mandatory field here.

hook.Run("UpdatAvailableQuest", questBase)`

questBase

Above when changing data I used questBase as a placeholder for a specific object that needs to be passed. That object looks as follows:

base

questBase = {
    args = {
        type = "questType (e.g. KillQuest)",
        weight = 10,
        finishInOneRound = "0 (Yes this bool is a string dont @ me xd)",
        difficulty = 0 -- numeric value 0, 1, 2 - 0 = easy, 1 = medium, 2 = hard
        pointRewards = 10000,
        premPointRewards = 100,
        xpRewards = 1000
    }
}

killQuest

killQuest.args = {
    requiredKills = 10,
    roleToBeKilled = "0",
    roleForKiller = "0",
}

karmaQuest

karmaQuest.args = {
    minKarma = 10,
    rounds = 10
}

surviveQuest

surviveQuest.args = {
    rounds = 10
}

walkerQuest

walkerQuest.args = {
    requiredSteps = 10,
}

Example how to add a new Quest with code:

function AddQuest()
    local questBase.args = {} -- questBase can be named whatever, args is a sensitive key.
    questBase.args.type = "KillQuest"
    questBase.args.weight = 10
    questBase.args.finishInOneRound = "0"
    questBase.args.pointRewards = 10000
    questBase.args.premPointRewards = 100
    questBase.args.xpRewards = 1000
    questBase.args.requiredKills = 10
    questBase.args.roleToBeKilled = "0"
    questBase.args.roleForKiller = "0"
    hook.Run("AddAvailableQuest", questBase)
end

Fields

The fields named above are named the same way in the raw quest object.