Documentation menu

Docs/Plugins/Quests

Quests

Server quests over games, the economy, and everyday activity, paid in coins, XP, or a role and claimed by the member.

Set a goal, pick a reward, and members work toward it. A quest can watch almost anything that happens on your server: casino outcomes, fishing, the economy, messages, voice time, level ups, and starboard stars. Members run quests to see their progress and claim what they have finished.

Quests are built on the dashboard's Setup - Quests page. There is one member command and nothing to set up in chat.

Two features control what you get:

  • Quests switches the plugin on. Without it nothing is tracked.
  • Quests Pro raises the limit from 5 quests to 25 and unlocks XP and role rewards. Coin rewards additionally need the Games feature, because coins are the games economy.

Setup checklist

  1. Make sure your server has the Quests feature. The Setup - Quests page says when it is missing.
  2. If your quests will pay coins, confirm the Games feature is on and the games plugin is set up, since that is where coins live.
  3. Open Setup - Quests and press Add quest. Give it a name; the id is filled in for you and should not change afterwards.
  4. Pick what counts. Choose an event, then how it is measured, then the number. The sentence under the quest name always describes exactly what you have built - read it back before saving.
  5. Start small for the first test: something you can finish in a minute, such as "Send a message x1", with a small coin reward.
  6. Set Resets to Daily and leave the announcement on "Reply where it happened".
  7. Turn the quest on and save. Do the action, watch for the completion message, then run quests and press the claim button.
  8. Once that works, raise the numbers and add the quests you actually want.

What a quest can watch

Games: a game played, a game finished (including the exact outcome, the payout, and the multiplier), a fish caught (rarity, species, pond, shiny, trophy), server bets placed and won, and investments sold.

Economy: faucet claims (daily, work, crime, rob, including the daily streak), coins earned, coins spent, shop purchases, and chat drops.

Activity: messages sent, minutes in voice, level ups, and stars received.

Message and voice progress uses the same anti-spam rule leveling uses, so sending ten messages in a row does not count ten times.

How it is measured

Every step is one of four shapes:

  • Do it N times - a straight counter. "Catch 100 fish."
  • N times in a row - a streak. It only breaks when you do the same kind of thing and fail the test: catching a common breaks a rare streak, but playing blackjack or going to bed does not.
  • Reach a value - a threshold on a number. "Cash out a crash round at 30x or more."
  • A specific outcome - an exact match. "Win with a natural blackjack."

A quest can have several steps. They can be finished in any order, or you can require them to be done in the authored order.

Worked examples

Quest How to build it
Fish 1000 times Fish caught, do it N times, 1000
Catch 3 rares in a row Fish caught, N times in a row, 3, only when rarity is rare
Get a 30x crash Game finished, reach a value, only when game is crash, measure Multiplier, at least 30
Win with a natural 21 Game finished, a specific outcome, only when game is blackjack and outcome is blackjack

Resets and seasons

A quest is one of:

  • One time only - completed once per member, ever.
  • Daily, weekly, or monthly - resets on that boundary in your configured timezone.
  • Season - runs between two dates and does not reset in between.

Rewards and claiming

A quest can pay coins, XP, a role, or any combination. Rewards are claimed, not paid automatically: the member is told when a quest is finished, then runs quests and presses the claim button. A completion stays claimable until its period resets, so a daily quest finished at 23:58 should be claimed that night.

A quest pays once per member per period. Nothing else limits payouts, so keep an eye on the size of the rewards you set relative to how fast a quest can be finished.

Restricting a quest

A quest can name a required role. Members without that role never see it and never make progress on it.

Common problems

  • Nothing is tracked: the server is missing the Quests feature, the quest is disabled, or it is beyond your quest limit. The dashboard marks quests that are over the limit.
  • A quest completed but paid nothing: it pays a reward this server cannot grant, such as coins without the Games feature or XP without Quests Pro. Diagnostics lists these.
  • A role reward was skipped: the role is in locked_roles, and locked roles are never granted by the bot.
  • Everyone's progress reset: a step or a target changed. Editing what is measured resets progress on purpose; renaming a quest or changing its reward does not.
  • A streak keeps breaking: streaks only survive if you do not fail the same action. Check the quest sentence to see exactly what counts.

Commands

Arguments in {curly braces} are required. Arguments in [square brackets] are optional.

Command What it does
/quests See your quests, your progress, and claim finished ones.