๐น๏ธQuests
Last updated
Last updated
The quest module in our Discord bot offers an immersive experience for both server managers and community members. Server managers can customize the Quest UI embed, add new quests, delete existing ones, edit quest details, and review submitted quests for approval. Community members can explore quest details, browse available quests, submit new quests for consideration, track completed quests, and monitor the status of pending or rejected quests. View the full list of commands below:
Click each command to expand for more information on how to use it.
/quest-ui - Set Quest Room UI embed.Server managers can use this command to set up an embed UI for quest room in a specific channel. The Quest Room UI will allow users to navigate through the module without the need of using any commands. This is completely optional as users can always use the commands to view the /quests.
This command allows the following customizations:
channel - The channel you'd like to post the Quest Room UI embed .
quest_ui_image_url - [Optional] URL of a custom image/gif you'd like to place on the Quest Room UI's embed to personalize it for your server.
quest_ui_embed_text - [Optional] Custom text you'd like to add to the Quest Room UI's embed.
/add-quest - Add a new quest.Server managers can use this command to add a new quest into the Quest Room for community members to complete. This command has the following customization parameters:
quest_name - The name of the quest.
quest_description - The description of the quest.
quest_reward - The reward to be given out upon completion of the quest.
allowed_role - [Optional] The role a user requires to do this quest.
max_approvals - [Optional] The maximum approvals allowed for this quest (Default value: unlimited).
For example, using the command above will add a new quest called "Find the easter egg" and the reward upon quest completion is 500.
IMPORTANT: If user tries to add a new quest with the same name as an already existing quest, the following message will be prompted instead:
/delete-quest - Delete a quest from the server.Server managers can use this command to delete an existing quest from the quest room. Once the quest is deleted, it can no longer be completed. This command has the following mandatory parameter:
quest_name - The name of the quest.
For example, using the command above will delete the quest called "Find the easter egg" from the quest room.
IMPORTANT: If user misspells the quest name or tries to delete a non-existing quest, the following message will be prompted instead:
/edit-quest - Edit an existing quest in the server.Server managers can use this command to edit an existing quest in the quest room. This command has the following customization parameters:
quest_name - The name of the quest.
quest_description - [Optional] The description of the quest.
quest_reward - [Optional] The reward to be given out upon completion of the quest.
allowed_role - [Optional] The role a user requires to do this quest.
max_approvals - [Optional] The maximum approvals allowed for this quest (Default value: unlimited).
For example, using the command above will edit the reward of "Find the easter egg" to become 1000 (from 500) and the maximum approvals to become 100 (from unlimited).
IMPORTANT: If user attempts to edit a quest without editing one of the optional quest parameters, the following error message will be prompted:
/review-quests - Review submitted quests.Server managers can use this command to review all the submitted quests and subsequently approve or reject them. This command has the following optional parameters:
quest_name - [Optional] Filter by quest name
user_name - [Optional] Filter by user
User can run the command without the above parameters to review all the submitted quests without applying any filter.
In the Quest Review embed, user can either approve, directly reject or reject the submission by providing a reason. User can also navigate to the next or previous submissions by using the Previous or Next button.
Alternatively, user can also run the command with the optional parameters listed above to filter the submissions based on quest name or user instead of reviewing all.
/logs-channel - View/Set logs channel for quest approval/rejection notifications.Set a logs channel for quest approval/rejection notifications.
Click each command to expand for more information on how to use it.
/quest-info - View quest details.Community members can use this command to directly view the details of a specific quest without having to navigate the Quest Room UI. This command has the following mandatory parameter:
quest_name - The name of the quest.
For example, using the command above will display the details of the "Find the easter egg" quest.
IMPORTANT: If user misspells or tries to search for a non-existent quest, the following message will be prompted instead:
/submit-quest - Submit a quest.Community members can use this command to submit a quest that they want to complete. This command has the following mandatory parameters:
quest_name - The name of the quest.
image - The image of a screenshot or proof of quest completion
For example, using the command above will submit a quest submission for "Find the easter egg".
IMPORTANT: If the previous quest submission got rejected, user can resubmit again until it is finally approved (assuming there is no maximum approvals). Once the quest submission has been approved, this means that the quest has been completed and user can no longer perform another submission for that particular quest.
/completed-quests - View quests that were approved by admins.Community members can use this command to view all of their completed quests. This command has the following optional parameters:
user - [Optional] The user who you want to check. Only Server managers can use this parameter.
page - [Optional] The specific page of your completed quest list (each page can show a maximum of 20 completed quests)
User can run the command without the above parameters to just view his/her own list of completed quests.
Alternatively, user can also run the command with the optional parameters listed above to either view a specific page or view another user's completed quests (example shown below).
/pending-quests - View quests that you submitted but is pending review.Community members can use this command to view all of their pending quests. A pending quest refers to quest that has been submitted but not yet reviewed. This command has the following optional parameters:
user - [Optional] The user who you want to check. Only Server managers can use this parameter.
page - [Optional] The specific page of your pending quest list (each page can show a maximum of 20 completed quests)
User can run the command without the above parameters to just view his/her own list of pending quests.
Alternatively, user can also run the command with the optional parameters listed above to either view a specific page or view another user's pending quests (example shown below).
/rejected-quests - View quests that were rejected by admins.Community members can use this command to view all of their rejected quests. A rejected quest refers to quest that has been rejected by the admin with an optional rejection reason. This command has the following optional parameters:
user - [Optional] The user who you want to check. Only Server managers can use this parameter.
page - [Optional] The specific page of your rejected quest list (each page can show a maximum of 10 completed quests)
User can run the command without the above parameters to just view his/her own list of rejected quests.
Alternatively, user can also run the command with the optional parameters listed above to either view a specific page or view another user's rejected quests (server manager only).
