Skip to main content

Create Quests

In this guide, we will explain how quests work and how you can create your own quests.

Registered Quests​

The registeredQuests table allows you to register all quests available for the Battle Pass. Each quest must have the following properties:

  • name: A unique identifier for the quest.

  • label: A name for the quest to display in the UI.

  • description: A description of the quest.

  • xp: The amount of experience points (XP) awarded to the player upon completing the quest.

  • premium: A boolean value that indicates whether the quest is only available to premium players.

  • untilAvailable: A Unix timestamp that indicates the time until the quest is available. Use 0 for always available quests. You can use the command /gettime to get the current Unix timestamp.

  • showProgress: A boolean value that indicates whether the player's progress towards completing the quest should be displayed.

Random Quests​

The randomQuests table allows you to enable random quests. The table has the following properties:

  • enabled: A boolean value that indicates whether random quests are enabled.

  • maxActiveQuestAmount: The maximum amount of active quests a player can have at the same time. Set to -1 for no limitation.

  • newQuestsPerDay: The amount of new quests a player can receive per day.

  • quests: A list of registered quest names that are eligible for random selection.

Default Quests​

The defaultQuests table allows you to set the quests that a player receives upon first spawning on the server. The table is a list of registered quest names.

Weekly Quests​

The weeklyQuest table allows you to set possible weekly quests. The table is a list of registered quest names. This feature is disabled if the table is empty.