# Analytics (/docs/analytics)
Every community gets a dashboard, with no setup and nothing to connect.
## Dashboard sections [#dashboard-sections]
| Section | What it answers |
| ------------------- | ----------------------------------------------------------------------------------------- |
| Member growth | How many fans you have, how fast that is changing, and what share of them are active |
| Engagement | Quest completions and items distributed over the period |
| Activity patterns | When your community is actually in the app, by hour and by day |
| Per fan averages | Quests completed and items owned per fan, plus retention and the active share |
| Feature performance | Which quests convert and which templates fans finish, so you can build more of what works |
The **timeframe selector** applies to the whole dashboard. Compare the same window week on week rather than reading one number in isolation, because a single day reflects one match.
Check which templates your fans actually finish before you plan the next twenty quests.
## Exports and the Data API [#exports-and-the-data-api]
| Need | Use |
| ------------------------------------------------ | ------------------------------------------------------------------------------------ |
| One quest's completions and the fans behind them | The per quest export in [Managing quests](/docs/quests/managing#per-quest-analytics) |
| A snapshot of every fan and their totals | The [member export](/docs/members#exporting-the-member-list) |
| The same data on a schedule, in your own systems | The [Data API](/docs/integrations/data-api) |
## Web analytics [#web-analytics]
Google Analytics and Google Tag Manager can be added to your app. See [Analytics integrations](/docs/analytics).
# Battlepass (/docs/battlepass)
A ladder of rewards that unlocks as a fan earns XP, with a free side everyone climbs and a paid side that only members can claim.
Quests pay per action. The battlepass pays for the total, so the thirtieth quest is worth doing even when the reward on it is small.
## Seasons [#seasons]
A season is a real object in the admin panel. You create one, fill it with tiers, and run it.
| Action | What it does |
| --------- | --------------------------------------------------------------------------------------- |
| Draft | Build a season without fans seeing it |
| Duplicate | Copy last season's structure and change the rewards, rather than rebuilding forty tiers |
| Edit | Change a season, including a live one |
| Close | End a season and archive it |
Dates are optional. A season with no dates runs until you close it, which suits a permanent progression ladder. A season with a start and an end runs for a fortnight around a tournament, shows fans a countdown, and closes itself.
Fans switch between seasons in the app, so a closed season is still visible rather than deleted.
Migrating a battlepass that was built the old way, as a set of hand made check level quests, means deleting it and building it again as a season. There is no in place upgrade. Do it between seasons, never in the middle of one, because rebuilding mid season takes progress and claims away from fans who were part way up the ladder. Passes built the old way keep rendering exactly as they did, so there is no deadline and no pressure to move before a natural break.
## Tiers [#tiers]
A tier is one rung: a level, and the reward waiting at it.
Tiers unlock on XP, using the same total that drives [levels](/docs/levels) and the [leaderboard](/docs/leaderboards). There is no second currency to track and no separate battlepass score to explain. A fan who reaches level 12 has unlocked every tier up to 12.
That also means your level thresholds and your battlepass are the same design problem. Levels spaced too far apart give a fan one tier a month.
Any reward can sit on a tier, including prizes and loot boxes. See [Rewards](/docs/rewards).
## The free track and the premium track [#the-free-track-and-the-premium-track]
Two tracks, side by side, at every level.
The free track is claimable by everyone. The premium track is gated on membership tier: a fan sees exactly what is waiting on it and what they need to hold to claim it, and the rewards bank rather than expire. A fan who upgrades at level 20 gets everything they passed on the way up.
Hide the premium rewards and nobody buys the membership. Make the free track worthless and nobody climbs far enough to care about the premium one.
## Premium membership [#premium-membership]
A paid tier fans buy inside your app. It is what gates the premium battlepass track, and it works on its own whether or not you run a battlepass at all.
| Setting | How it works |
| -------------------- | ---------------------------------------------------- |
| Payments | Stripe, connected to your account |
| Model | A recurring subscription or a single one off payment |
| Price and currency | Yours to set |
| Revenue | Yours to keep. It does not pass through us |
| Benefits | Yours to define |
| Where fans manage it | In the app, under Settings |
Benefits are whatever you decide to put behind the tier. The ones partners use:
* Exclusive quests, visible only to members
* Better rewards on the quests everyone can see
* The premium battlepass track
* Gated posts on the [newsfeed](/docs/newsfeed)
* Store items members can buy and others cannot
* A custom badge on their leaderboard row and their profile
The badge is the only benefit other fans can see, and being visibly a member in front of the community is a large part of what people are buying.
Price it against what a fan is already spending with you rather than against other apps. And write the benefit list before you set the price, because a tier that is one battlepass track and nothing else is a hard sell in month two. What this changes in your commercial arrangement with us is on [What it costs](/docs/getting-started/pricing).
# Changelog (/docs/changelog)
Fixes and small polish are left out unless they change how you would use something.
**Battlepass is its own thing now.** It used to be a set of hand made check-level quests. It is a proper section of the admin panel, with seasons you can draft, duplicate, edit and close. A season carries a free track and a premium track, and optional dates, so it can run forever or for a fortnight.
* Existing battlepasses keep working and keep rendering as they did
* Migrating one means rebuilding it as a season, so plan it between seasons rather than mid-flight
**Store items can be personalisation items**, so profile pictures and borders can be bought rather than only won.
**Shopify order creation** entered testing. A fan spends points in your store, and a real order appears in your Shopify with a shipping address and a per fan purchase limit.
**The SDK.** Two packages that put quests, rewards and fan accounts inside your own site, with your design and no iframe. Quests, rewards and sign-in are live in the packages. [Your own front end](/docs/getting-started/integration-paths#your-own-front-end).
**Reddit style comments on the newsfeed.** Replies nest, threads collapse, fans can edit and delete their own, and every comment has a permalink.
**Two more Shopify reward rules.** Reward every purchase regardless of what was bought, and reward per unit of currency spent. Both join the original tag based rule.
**Resource decay** got a countdown and a clearer pre-claim display, so a fan can see what they are losing by waiting.
**Multi-step quests.** A sequence that used to need several chained and gated quests now lives in one card with one reward. Every step is visible up front. Fans were dropping off after the fourth quest in a chain they could not see the end of.
**Custom profile pictures, borders and backgrounds.** Upload your own, hand them out through quests, events, the store and loot boxes. They render on the leaderboard, profiles, comments and the navigation bar.
**Resource decay.** A reward that shrinks the longer a fan waits to claim it. Set a starting value, a decay rate and a floor.
**Store upgrades.** A featured carousel on the shop front, tags with fan facing filters, custom ordering, and in-stock filtering.
**Quest card images**, so every quest on the board carries its own artwork.
**Public API access.** API keys for organisations pulling their community's data into their own infrastructure. [Data API](/docs/integrations/data-api).
Read only endpoints with per community API keys, issued on request: members, member deletions, activity, resource balances, item holdings, loot box openings, and headline analytics. Documented with Swagger, rate limited, and incremental with `updatedSince` so you can sync rather than re-download.
**A predictions quest template.** Ask fans to call a match, a roster move or anything else with an outcome. Options carry their own images, entries lock at a time you set, and rewards distribute automatically on resolution with a notification.
Free to enter. No staking and no wagering, so there is no way for a fan to lose anything.
**On-chain minting and burning of collectibles was retired** when the provider behind it shut down. Collectibles still exist, are still earned and still shown. Wallet sign-in and on-chain quests are unaffected.
**Usernames now work like Discord.** A display name plus a hidden four digit suffix, so two fans can both be `sniper` and neither has to be `sniper_2847`.
**Bulk download of quest submissions.** Every image and text submission for a quest as a zip, plus a CSV of who submitted what.
**Bulk resource grants** by CSV upload, and self-service creation of a secondary spendable currency. Both used to be a request to an engineer.
**Light mode.** Set per community: dark, light, or both with a toggle for fans. Dark stays the default. Ask us before choosing both, because two themes is two of everything to check.
**Custom navigation.** Rename and reorder the sections, hide the ones you do not use, and add your own links out to your website or store.
**A clearer review flow.** Quests awaiting manual review are labelled as pending on the quest board, and quests with unclaimed rewards are easier to find.
**Store items gated by level or membership tier**, visible but locked, so progression has something to pull towards.
**Spotify.** Account linking plus three quest templates: follow an artist, follow a playlist, and check a fan's top artists.
**Rename the features.** Quests can be missions, events can be tournaments, and the new name applies everywhere in the app.
**Google Analytics and Tag Manager** on your app.
**Per page background images** for the quest board, store, leaderboard, profile and the rest, plus custom fonts.
**Shopify single sign-on.** Fans sign in with the account they already have at your store. No second registration, and their purchases and their points sit under one identity. [Shopify](/docs/integrations/shopify).
**Levels and tiers** with custom names and icons, shown on the leaderboard and profiles, with a custom badge per membership tier.
**Two rewards on one quest**, allocated together.
**A new loot box opening animation** on quests, events and the battlepass.
**Solana wallet linking** with Phantom, Solflare and Backpack, plus an NFT ownership quest template.
**Discord bot announcements.** Post to a channel when a quest goes live, an event starts, or an event ends.
**Premium badges** shown on the leaderboard and profiles, configurable per tier.
**A serious mobile pass** over the newsfeed, store and navigation.
# Events (/docs/events)
An event is a quest board with a clock and a leaderboard around it. Fans join, compete for a fixed period, and are paid by where they finish.
## Setting it up [#setting-it-up]
| Field | What it does |
| ------------------- | ----------------------------------------------------------------------------------------------- |
| Title | The name on the event card and at the top of the event page. |
| Description | What fans are competing at, and how they win. |
| Banner | The artwork on the event card. |
| Event window | When the event starts and ends. |
| Registration window | When fans can join. |
| Requirements | Who is allowed in: a level, a Discord role, a collectible, another quest, or a membership tier. |
| Max participants | A cap on how many fans can join. Leave it empty for no cap. |
Registration is a separate window from the event. If registration closes the moment the event opens, every fan who hears about the event on day two is locked out. Unless you are running a fixed bracket, close registration when the event closes.
## Choosing the type [#choosing-the-type]
The type decides how fans score, and it cannot be changed later.
| Type | How it works | When to use it |
| ------------- | ----------------------------------------------------------------------------------------------------------------------------------- | ---------------------------------------------------------------------------------------------------------------------------- |
| Basic | You pick quests from the template library. Fans complete them, each completion is worth points, and the leaderboard ranks by total. | Anything not tied to a game: a launch week, a sponsor activation, a merchandise drop. Works for every community. |
| Score based | Gaming only. Scoring is dynamic and follows real play, so each kill or each win is worth points rather than a single completion. | A tournament, a play-along during a match, anything where you want performance to matter rather than participation. |
| Collaborative | One shared goal for the whole community. Everyone who took part is rewarded when it is reached. | Reaching a number together: submissions collected, matches won across the community, a milestone you want to hit as a group. |
Score based events need every participant to have linked the relevant gaming account before they can score. Say so in the description, and expect the link step to cost you participants if the event is short. See [sign-in and account linking](/docs/settings/sign-in).
Collaborative events are the ones to reach for when your community is small enough that a leaderboard would be discouraging.
## Rewards by position [#rewards-by-position]
Rewards are attached to finishing positions, and a position can be a range. First place gets one thing, second to fifth get another, sixth to fiftieth get another again.
Cover more than the podium. An event where only three fans are paid is an event that ninety percent of your community stops watching on day two. A small reward down to fiftieth keeps the middle of the leaderboard competing.
Collaborative events pay everyone who took part the same thing, so there is one reward rather than a ladder of them.
Rewards come from the same set as quests: XP, spendable currency, prizes, collectibles and loot boxes. See [Creating a quest](/docs/quests/creating) for what each one is.
## After publishing [#after-publishing]
Only the **title** and the **description** can be edited once an event is published. The window, the type, the requirements and the rewards are fixed.
If one of those is wrong, duplicate the event, correct the copy, and unpublish the original before fans notice two of them. Do it early: an event with participants already registered cannot be replaced quietly.
## Exporting participants [#exporting-participants]
Export the participant list as a CSV, during the event or after it, including from an archived event.
This is what you send a sponsor, and it is what you use to fulfil prizes that need a person in the loop. Custom rewards with a shipping address or an email requirement are tracked separately in [Custom rewards](/docs/rewards/custom-rewards).
What events are for, and the three types from a fan's point of view, is [Events](/docs/events).
# Introduction (/docs)
FanBase gives your community a place to earn something for paying attention. Fans sign in, complete quests, climb a leaderboard, spend what they earn, and collect things worth keeping.
Building it into your own site in code is the FanBase SDK, a separate site.
## Three ways to run it [#three-ways-to-run-it]
The same platform underneath. What changes is who owns the front end.
We host it on your domain. Your colours, logo and layout. Live in days.
The SDK inside your site. You own every pixel and every route.
We design and build it with you. For organisations with their own requirements.
Most partners start hosted and move to their own front end later. The admin panel, the fans and their progress carry across, because only the front end changed.
## Mechanics your team runs [#mechanics-your-team-runs]
Everything a fan sees is configured in the admin panel. A quest goes live the moment someone publishes it, with no deploy in between.
Follow, play, predict, answer, submit, buy. More than 150 templates.
Points, prizes, loot boxes, collectibles, Discord roles.
Seasons with a free track and a premium one.
Fans spend what they earn. Connects to your Shopify.
# Leaderboards (/docs/leaderboards)
One board, all time, everyone in the community on it. It costs you nothing to set up, and fans open it without being prompted.
## The ranking basis [#the-ranking-basis]
Two bases, and you choose one per community. It is set when we build your community, so tell us which you want during [onboarding](/docs/getting-started/onboarding).
| Basis | Ranks by | What it rewards |
| ---------------- | ---------------------------------------------------------- | ---------------------------------------------------------------- |
| XP | Total XP earned, the same number that drives levels | Effort, weighted by what you decided each quest was worth |
| Quests completed | The count of quests finished, regardless of what they paid | Breadth. Doing everything, rather than doing the valuable things |
Pick XP unless you have a reason not to. Ranking on quests completed makes a fan who ticked off thirty one minute quests beat a fan who ground out three hard ones, and it makes your reward pricing meaningless as a signal. It is the right choice when your board is deliberately flat and you want participation rather than intensity.
There is no way to run both at once, and changing the basis later reorders the board under fans who had earned their place on it.
## Event leaderboards are separate [#event-leaderboards-are-separate]
Every event has its own leaderboard, scoped to that event, living on the event page rather than here. It ranks only participants, counts only what the event counts, and ends when the event ends.
A fan who joined last week can win an event without first overtaking a year of accumulated XP. See [Events](/docs/events).
## Streaks [#streaks]
Streaks belong to quests rather than to the leaderboard. Set a quest to renew daily or weekly, and a fan who completes it on consecutive renewals earns a growing reward until it hits the cap you set. Miss one and it resets.
The full behaviour, including the reward cap and what happens when a fan misses a day, is in [Quests](/docs/quests/creating#set-the-advanced-properties).
For a short, self contained competition that newer fans can win, build an [event](/docs/events): it lets you scope who is competing and what counts, on a board that ends.
## Resetting balances [#resetting-balances]
A reset zeroes every fan's balance and level, so the board starts empty and the colleagues who tested your quests stop sitting at the top of it on day one.
Reset balance cannot be undone, so run it once, after testing and before you invite anyone. What it clears and what it keeps is [Reset balance](/docs/rewards/resources#reset-balance).
## Seasonal history [#seasonal-history]
Exploring
Today a reset clears the standings and nothing keeps a record of who was where. Keeping past seasons, so a fan can point at having finished top ten in a season that has since been wiped, is on the list. Ask your FanBase contact where it stands before you plan a season around it, and see [Feature status](/docs/status).
# Levels (/docs/levels)
Levels are the one setting fans notice you changing. Get the ladder right before launch and you never touch it again.
## Creating a level [#creating-a-level]
**Create level**, then four fields. Three are required and the icon is optional.
| Field | What it does |
| ----- | ---------------------------------------------------------------------------------------------------- |
| Order | The position in the ladder: 1, 2, 3. Decides what comes after what. |
| Name | What fans call it. Numbers work. So do Rookie through Legend, or your own ranks. |
| XP | The total XP a fan needs to reach it. Cumulative, not the gap from the level below. |
| Icon | Optional. The badge shown next to a fan's name on the leaderboard, in comments and on their profile. |
## Managing the ladder [#managing-the-ladder]
* **Reorder** a level to move it up or down the ladder.
* **Rename** a level. Fans see the new name immediately.
* **Adjust XP** on any threshold. Fans are re-evaluated against the new numbers, so lowering a threshold promotes people and raising it demotes them.
* **Reset** the whole ladder, either to our default levels and thresholds or to a custom one you build from scratch.
## Best practice [#best-practice]
### Finalise before launch [#finalise-before-launch]
Fans anchor on the ladder the day they see it. Someone who has been three hundred XP from Contender for a week and finds Contender now costs twice as much reads that as the goalposts moving.
### Align XP per quest with your thresholds [#align-xp-per-quest-with-your-thresholds]
Decide how long the first few levels should take, then count the quests on your board and the XP they pay.
A distribution that works on the default ladder:
| Quest difficulty | XP | Examples |
| ---------------- | --- | ---------------------------------------------------------------------- |
| Simple | 10 | Visit a link, follow an account, join the Discord |
| Moderate | 25 | Watch a stream for an hour, answer a quiz, complete a daily for a week |
| Difficult | 50 | Hit a rank, play a number of hours, submit real work |
| Special | 100 | A campaign finale, an event win, something that happens once |
Two ways this goes wrong. Too much XP per quest and fans hit the top level in a week, the leaderboard stops moving because everyone is capped, and you have nothing left to give the people who care most. This is the more common failure, and the one you cannot fix without a [balance reset](/docs/rewards/resources#reset-balance). Too little XP per quest and the progress bar never visibly moves: fans complete four quests, see nothing happen, and stop.
A rough test before launch: take the quests a committed fan could finish in their first session, add up the XP, and see which level that lands on. If it is the top one, your rewards are too large. If it is not the second one, they are too small.
Recurring quests need counting too, because a daily paying 10 XP is 3,650 XP a year on its own. [Reward caps on streaks](/docs/quests/creating#set-the-advanced-properties) are what keep that in bounds.
# Members (/docs/members)
One row per fan, and the row is the whole record: how they signed in, what they linked, what they earned, what they own.
## Finding a fan [#finding-a-fan]
Search by their in-app handle. Handles are Discord style, a display name plus a four digit suffix, so several fans can share a name without ambiguity in the panel.
When the only thing you have is a social handle, for example the X username of the person complaining, search on that instead. It matches against linked accounts and returns the fan behind them.
## Reading a record [#reading-a-record]
Select a fan, then **Edit**.
| Section | What it shows |
| --------------- | ---------------------------------------------------------------------------------------------- |
| Linked accounts | Every social, gaming and wallet account they have connected, and which one they signed up with |
| Stats | Their level, balances, quests completed, items owned, events joined and referrals |
| Danger zone | Delete or ban |
Deleting or banning a fan is permanent and cannot be undone. Deleting removes the account and its progress. Have a second person confirm before you use either, and keep a note of why outside the panel.
Editing a record is for corrections rather than routine work. Adjusting one fan's balance by hand is fine; adjusting fifty is what the bulk upload below is for.
## Exporting the member list [#exporting-the-member-list]
**Export** produces a CSV of every fan in the community.
| Column | What it holds |
| ------------ | ------------------------------------------------------------------------------------------------- |
| User ID | The fan's unique identifier. The column to join on if you are matching this against your own data |
| Handle | Their in-app username |
| Email | Their email address, where they gave one |
| Discord | Their Discord handle, if linked |
| X | Their X handle, if linked |
| XP | Total accumulated XP |
| Level | Their current level |
| Total quests | Quests completed |
| Total items | Items owned |
| Referred | How many fans they successfully referred |
| Joined at | When they joined |
| Left at | When they deleted their account, if they did |
The export is a snapshot. It is the right tool for a one off: drawing a winner or briefing a sponsor.
This file is personal data. Treat it the way you treat your own customer list: keep it in the systems your privacy policy covers, and delete the copy in your downloads folder when you are done with it.
## Bulk grants and debits [#bulk-grants-and-debits]
A currency can be granted or debited across many fans at once from a CSV. Upload the file and the panel runs it.
Use it for a compensation payout after an outage, a migration of balances from a system you ran before, or the prize list from a competition judged outside the app.
Ask for a sandbox run first with five rows, because a bulk debit is as fast as a bulk grant. And write down what you sent and why, since the balances change without any explanation attached to them for the fans who receive them.
# Newsfeed (/docs/newsfeed)
Every post goes out under a publisher, so create your publishers before you write the first post.
## Publishers first [#publishers-first]
A publisher is who a post comes from, and every post has one.
Creating one takes a name and a profile image.
Most teams want more than one. An esports org posts as the org for announcements and as each pro player for their own content, and fans filter the feed by publisher to follow the player they care about.
Set them all up at the start. Adding a publisher later does not backdate the posts already published under another name.
## Creating a post [#creating-a-post]
| Element | What it does |
| --------- | ----------------------------------------------------------------------------------------------------------------------------- |
| Images | One or several per post. |
| Video | Uploaded and played in the feed. |
| Rich text | Headings, bold, lists and links in the body. |
| Links | A link to X, YouTube or Twitch renders as an embed rather than a bare URL, so the post shows the video or the tweet in place. |
The embed is the reason to post here rather than only on social: the fan watches the clip without leaving the app, and everything else on the page is a quest.
## Gating a post [#gating-a-post]
Restrict a post to fans who have earned the right to see it.
| Requirement | Who gets in |
| ------------------ | ----------------------------------------------------------------------------------------- |
| Level | Fans at or above a level you choose |
| Discord role | Fans holding a role in your server. Needs [Discord](/docs/integrations/discord) connected |
| Collectible | Fans who own a specific item |
| Premium membership | Fans on a paid tier. See [Premium membership](/docs/battlepass#premium-membership) |
Gated content is one of the few rewards that costs you nothing to produce twice. Behind-the-scenes footage or an early team announcement: post it gated and it does more work than the same clip posted publicly.
Do not gate everything. A feed a new fan cannot read gives them no reason to come back and earn their way in.
## Pinning and featuring [#pinning-and-featuring]
Pin holds a post at the top of the feed. Feature lifts a post out of the feed so it is showcased on its own. Feature is for evergreen posts, the ones worth reading in three months: how the community works, what the seasons are, where to start.
Both are for one post at a time. A feed with four pinned posts has no top.
Take the pin off when the moment passes. A pinned match preview for a match that finished last week tells fans the feed is not being kept up to date.
## Comments [#comments]
Fans reply to posts, and the replies thread, so a conversation stays readable rather than becoming a flat list. Fans can edit and delete their own comments, and long threads collapse. An edited comment is marked as edited. A deleted one leaves the replies underneath it intact.
Every comment has a permalink, so you can link one directly instead of describing where to scroll.
You moderate from the panel: remove a comment that breaks your rules, and deal with the fan in [Members](/docs/members) if it is a pattern rather than a one off.
Decide who is moderating before you launch, and decide it for the worst day rather than an average one. Match nights and roster news generate comments faster than anything else in the app, and a feed where the loudest reply has stood for three days sets the tone for the next month.
Comment voting, up and down with sorting by score, is built but switched off by default. Ask us to enable it if you want it. It suits a large community where the best replies need surfacing. In a smaller community, leave it off.
# Predictions (/docs/predictions)
A prediction asks fans to pick an outcome before it is known. A match result, a roster move, a scoreline, the coin toss at a live event. Entries close at a time you set, and when the thing happens you mark what was right and the platform pays everyone who chose it.
It is free to enter. Nothing is staked, nothing is wagered, and there is no way for a fan to end up worse off than before they answered.
## What you fill in [#what-you-fill-in]
| Field | Required | What it does |
| --------- | -------- | ------------------------ |
| Options | Yes | What a fan can pick |
| Lock time | Yes | The moment entries close |
Every option carries three things, and two of them are yours to use or ignore.
| Per option | Required | What it is for |
| ----------- | -------- | -------------------------------------------------- |
| Label | Yes | The plain answer. This is what you resolve against |
| Image | No | Drawn at 40px beside the label |
| Description | No | One line under the label |
**Keep the label plain and put the interesting part in the description.** The label is the thing you will later mark correct, so it has to survive being read back weeks after you wrote it. "Home white" resolves. "The one everyone wants" does not. The line underneath is where "unbeaten in it since March" goes, and that line is what makes a fan pick one over the other.
**Images earn their place when the options are things you recognise faster than you read.** A colourway, a sleeve, a city. At 40px there is room for one shape and two or three colours, so a photograph of a crowd becomes a smudge and a product render stays legible. They are wasted on a scoreline, where the label already is the thing.
## Who can enter [#who-can-enter]
A prediction is a quest, so it takes the same audience rules every other quest
takes. Gate it and the card still appears, but it will not open for anyone who
does not qualify, and the fan is told why rather than left pressing a dead card.
A prediction takes every condition in [Gating](/docs/settings/gating), and the
gate covers the whole card rather than the submit: a fan who picks an outcome
and only then learns they were never eligible has done the work twice.
Two are worth singling out here. **Activated users**, because the entry is free
and something worth winning is exactly what a throwaway account turns up for.
**Membership**, because it changes what the tally means: a members only
prediction tells you what your paying fans think, which is a different question
from what everyone thinks, and usually the more useful one.
## The lock [#the-lock]
Entries close at the lock time and the options stop responding. Before it the card says when it locks. After it, it says entries closed and gives the time.
**Set the lock before the outcome can be known.** This is the one thing that goes wrong. A fan watching the match can answer with the result in front of them, so a lock set for full time is not a prediction, it is a free reward. Kick-off is usually the right moment, and earlier is safer than later.
The platform enforces this by the clock, not by your resolution. Once the lock passes nobody new can enter, whether or not you have marked an answer.
## What a fan sees [#what-a-fan-sees]
One pick. The choice is final the moment they submit, and the card says so rather than letting them try again. A fan who has already answered sees what they picked.
**The split is visible before they enter**, which is the one place a prediction behaves differently from a [poll](/docs/quests/templates/submission#poll). A poll hides its result until you have voted, so that what other people think cannot pull your answer. A prediction shows it from the start, because being with the crowd or against it is most of the reason to enter.
The total number of entries sits above the options, and a fan's own entry joins it. On a prediction with a few thousand people in it one more entry moves that total rather than the percentages, which is the honest thing for the card to show.
## Resolving it [#resolving-it]
You mark the option that turned out to be correct. That is the whole action.
Everyone who chose it is paid the reward automatically and notified that they were right. Everyone who chose anything else is notified that they were not. Nobody loses anything they had.
Until you resolve it the quest sits there, locked and unpaid. There is no automatic resolution, because the platform has no way to know what happened at your event.
## When to use one [#when-to-use-one]
Predictions earn their keep around a fixture, because they give a fan a reason to be in the app before it starts and a reason to come back after it ends. One before kick-off and the result posted to the [newsfeed](/docs/newsfeed) afterwards is the shape that works.
They are weak as evergreen content. A prediction with no event behind it has no deadline anyone cares about and nothing to resolve against.
## What it is not [#what-it-is-not]
It is not betting. There is no stake, no odds and no payout that scales with how many people were wrong. Everyone who is right gets the same reward, and it is the reward you set on the quest like any other.
It is not a poll. Put the same options in both and only the question changes: a poll asks which colourway you want and pays everyone who answers, a prediction asks which one drops on Friday and pays the fans who called it. One is research. The other has a right answer you already know.
# Feature status (/docs/status)
Anything not on this page is live. The SDK ships features later than the hosted app, because a feature has to exist before it can be packaged, and FanBase SDK feature status tracks that separately.
## Live [#live]
Everything in this table is in production on the hosted app. The second column is a separate question: whether the same feature is packaged in the SDK yet, tracked on the FanBase SDK feature status page. It deliberately does not reuse the four status words above, because a row reading "Planned" inside a table headed Live is read as not built.
| Feature | In the SDK | Notes |
| ------------------------ | -------------- | ------------------------------------------------------------------------------------------------------------ |
| Fan accounts and sign-in | Yes | Google, Discord, X, Twitch, and Shopify. [Sign-in methods](/docs/settings/sign-in) |
| Quests | Yes | More than 150 templates across in-app, social, gaming and on-chain. [Templates](/docs/quests/templates) |
| Multi-step quests | Yes | Several steps inside one card, one reward. [Quests](/docs/quests/creating#multi-step-quests) |
| Predictions | Not yet | Free to enter, with a lock time. You mark the outcome and it pays. [Predictions](/docs/predictions) |
| Rewards and loot boxes | Yes | Points, prizes, collectibles, loot boxes, Discord roles. [Rewards](/docs/rewards) |
| Resource decay | Yes | Rewards that shrink as fans claim them. [Rewards](/docs/rewards#decaying-rewards) |
| Events | Not yet | Basic, score based and collaborative. [Events](/docs/events) |
| Leaderboards | Not yet | All time, by points or by quests completed. [Leaderboards](/docs/leaderboards) |
| Battlepass with seasons | Being packaged | Free and premium tracks, seasons you can duplicate. [Battlepass](/docs/battlepass) |
| Store | Being packaged | Spend earned currency, gated by level or membership. [Store](/docs/store) |
| Newsfeed | Not yet | Posts, reactions, threaded comments. [Newsfeed](/docs/newsfeed) |
| Premium membership | No | Stripe subscriptions or one off, priced by you. [Battlepass](/docs/battlepass#premium-membership) |
| Profile personalisation | Yes | Profile pictures, borders and backgrounds as rewards. [Profile personalisation](/docs/rewards/collectibles) |
| 3D avatars and wearables | No | An add-on, not enabled on every app. [3D avatars](/docs/rewards/avatars-3d) |
| Shopify sign-in | Not applicable | Fans use their store account. [Shopify](/docs/integrations/shopify) |
| Shopify reward rules | Not applicable | Reward any purchase, tagged purchases, or per unit spent. [Shopify](/docs/integrations/shopify#reward-rules) |
| Discord announcements | Not applicable | Quests and events announced to your server. [Discord](/docs/integrations/discord) |
| Data API | Not applicable | Read your community's data with an API key. [Data API](/docs/integrations/data-api) |
| Analytics | Not applicable | Members, engagement and quest performance. [Analytics](/docs/analytics) |
| Theming and navigation | Not applicable | Colours, fonts, backgrounds, light and dark, nav order and labels. [Settings](/docs/settings/general) |
| Languages | Yes | Five locales. See [General settings](/docs/settings/general#languages). |
## In build [#in-build]
| Feature | Notes |
| -------------------------------------- | --------------------------------------------------------------------------------------------------------------------------------------------------------------------------- |
| In-app purchases create Shopify orders | A fan will be able to buy with points, and a real order will appear in your Shopify, with a shipping form and a per fan purchase limit. The most requested feature we have. |
| Code distribution | Upload a batch of discount or gift codes and hand them out as rewards, delivered by email. |
| Store variants and SKUs | Sizes and colours on store items, mapped to Shopify variants. |
| Admin panel refresh | A visual pass over the admin panel. No change to how anything works. |
| SDK: store and battlepass | Both are live on the platform and being packaged for the SDK. |
| More Discord announcements | Newsfeed posts, store changes and event winners, joining the quest and event announcements that already exist. [Discord](/docs/integrations/discord) |
## Planned [#planned]
Roughly in priority order. Dates are not committed until something moves to In build.
| Feature | Notes |
| ----------------------------------------------- | -------------------------------------------------------------------------------------------------------------------------------------------------------------- |
| Achievement badges | Milestones a fan earns and pins to their profile, separate from levels. |
| Point and XP boosts | Time limited multipliers, sold in the store or given out through quests. |
| Downloadable rewards | Wallpapers and asset packs delivered on claim, without a person in the loop. |
| Decay over time | Rewards that shrink with the clock and show a countdown, alongside the per claim decay that is live today. [Rewards](/docs/rewards#decaying-rewards) |
| Calendar | Your match and event schedule inside the app. |
| Store housekeeping | Archiving items, infinite scroll, bulk buying, purchase caps per fan. |
| Self-serve community creation | Sign up, configure, and get your keys without us in the loop. |
| SDK: predictions, newsfeed, leaderboard, events | In that order, after store and battlepass. |
| More quest templates | Instagram like and follow verification first, then more Discord and more Twitch templates. [Templates](/docs/quests/templates#asking-for-a-template-or-a-game) |
## Exploring [#exploring]
| Item | Notes |
| ------------------------------- | -------------------------------------------------------------------------------------------------------------------------- |
| Shopify App Store listing | Installing FanBase from Shopify directly. We run custom Shopify apps per store today, which works well at current numbers. |
| An assistant in the admin panel | Asking for a quest or a report in plain language instead of filling a form. |
| Webhooks | Pushing events to your systems as they happen, rather than you polling the Data API. |
| Seasonal leaderboard history | Keeping past seasons after a balance reset, instead of only the current standings. |
## Retired [#retired]
Gone from the product.
| Feature | What happened |
| -------------------------------------------- | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ |
| Embeddable widgets and iframes | Replaced by the SDK, which does the same job without a fixed appearance or an iframe. See [Choosing an integration](/docs/getting-started/integration-paths#widgets). |
| On-chain minting and burning of collectibles | Retired in mid 2026 when the underlying provider shut down. Nothing a fan owned was lost: collectibles are still earned, owned, displayed and usable as quest requirements, held in your community rather than on a chain. No setting puts them back on one, and there is no marketplace outside the app. Wallet linking, wallet sign-in and on-chain quests are unaffected. See [On-chain quests](/docs/quests/templates/on-chain). |
| Creator link-in-bio pages | Trialled, then retired. |
| YouTube subscribe and like verification | Withdrawn because verifying them needs far more access to a fan's account than we are willing to ask for. Visit and watch templates remain. See [YouTube](/docs/quests/templates/social/youtube). |
## Asking for something [#asking-for-something]
Tell your FanBase contact which features matter to you. We keep an internal priority list and partner needs are what shape it, so telling us what you are waiting on is what moves something up it.
That goes for anything not on this page too. If you have an idea, share it. It is usually not a question of whether something can be built, but of when it could feasibly be live, and knowing you want it is how it gets a date.
# Store (/docs/store)
If you run a spendable currency, give fans somewhere to spend it. Fans notice within about a week whether their balance buys anything. Everything on this page is configured in the admin panel.
## Items you can list [#items-you-can-list]
| Item | What the fan gets |
| ------------------------- | ------------------------------------------------------------------------------------------------------------ |
| Prizes and custom rewards | Something outside the app: a gift card, a code, merchandise, a ticket. Claimed the same way as a quest prize |
| Collectibles | An item they own |
| Personalisation items | A profile picture, border or background they can equip |
| Loot boxes | A chance at whatever is inside |
Every type is described in [Rewards](/docs/rewards). The store adds a second route to the same items: earning them, or buying them.
## Pricing [#pricing]
Items are priced in your spendable currency, not in money. You set the number per item.
Price against what a fan earns rather than against what the item costs you. Work out roughly what an engaged fan earns in a week, then decide how many weeks the cheapest item should take. If everything on the shelf is a month away, fans stop opening the store. If everything is affordable on day two, the shelf is empty by day three and you have taught fans that points are worthless.
Leave headroom at the top. One item almost nobody can afford gives the fans at the top of your leaderboard something to save for.
## Gating [#gating]
Two requirements, and they stack.
| Requirement | Passes when the fan |
| --------------- | -------------------------------------------------------------------------------- |
| Level | Has reached a level you choose |
| Membership tier | Is on a paid tier. See [Premium membership](/docs/battlepass#premium-membership) |
A locked item stays visible, with the reason it is locked.
## Stock and limited supply [#stock-and-limited-supply]
Set a quantity and the item sells out. Fans can filter the shelf down to what is still in stock.
Two things to plan before you list something scarce. Decide whether you would rather it went to the fastest fan or the most invested one, because unlimited stock plus a level gate is a different outcome from limited stock and no gate. And check your fulfilment: fifty physical items sold in a morning is fifty addresses for someone on your team to work through.
## Tags and filters [#tags-and-filters]
Tag items and fans get filters on the shop front. Apparel, Digital, Sponsor, Match day. Fans can also sort and filter by price and by what is in stock.
Tag by the shape of the thing rather than the subject, the same way you tag [quests](/docs/quests/tags). Six tags a fan understands beat twenty that describe your internal categories.
## Sorting and the featured carousel [#sorting-and-the-featured-carousel]
Fans can sort by cheapest, most expensive and newest. The default is your own order: you arrange the shelf in the admin panel and that is what a fan sees first.
Use it. The default sort is the most valuable placement you have, and left alone it puts whatever you happened to create first at the top.
Above the shelf sits a **featured carousel**. Each slide carries a background image, a headline, a short description and a call to action, and the carousel rotates on its own. It is the right home for a drop, a sponsor activation or the one item you actually want fans to buy this week.
## Purchase history [#purchase-history]
Every purchase is recorded, and fans can see their own under Settings. Your side of it is in the admin panel, alongside the claims from quests and events, so one list tells you what to fulfil regardless of whether a fan earned it or bought it. See [Rewards in the admin panel](/docs/rewards/custom-rewards).
## Variants and SKUs [#variants-and-skus]
In build
Sizes and colours will sit on a single store item, mapped to the matching variants in your Shopify catalogue. Today a medium and a large are two listings, each with its own stock.
## Connecting your store [#connecting-your-store]
The store above runs entirely on the platform. Connecting Shopify links it to the shop you already have, in two directions that are independent of each other.
**Purchases in your Shopify pay out in the app.** This is live. A fan buys something in your real store and reward rules hand them XP, currency or a collectible with nobody in the loop. You choose whether that fires on tagged products, on any purchase, or in proportion to what they spent.
**Spending points in the app will create a real Shopify order.** In build
A fan will be able to buy a store item with points, and a real order will appear in your Shopify against their customer record, with a shipping form and a per fan purchase limit. It is the feature partners ask for most, see [Feature status](/docs/status). It will need a permissions re-authorisation on your store when it lands.
Both are covered field by field in [Shopify](/docs/integrations/shopify).
# Agents and AI tools (/docs/integrations/agents)
Every page on this site has a Markdown twin, because a good share of the traffic here is not human.
## These docs, read by a machine [#these-docs-read-by-a-machine]
Four ways in, all generated at build time, none of them a separate product.
[/llms.txt](/llms.txt) is an index of every page with its description, small enough to paste into a prompt. [/llms-full.txt](/llms-full.txt) is the entire site as one Markdown file, and it is the one you hand to an agent.
The other two are for reaching a single page. Every page's source sits at `/llms.mdx/docs//content.md`, and every page header carries a **Copy Markdown** button that fetches it. Ask for any docs URL with an `Accept: text/markdown` header and you get the Markdown back instead of a page of HTML to scrape.
The old documentation served Markdown for every page and partners' agents came to depend on it. That is why it still works here.
## Uses today [#uses-today]
Configuration questions get answered without anyone reading the site. Point Claude, Cursor or Codex at `/llms-full.txt` and ask the question you would otherwise ask us. How do I set up a daily quest with a streak cap, what does hidden if locked actually do, which templates need an account linked first. The answers are all in there.
Reports arrive without your team building them. Hand an agent the [Data API](/docs/integrations/data-api) reference and a key, then ask for the thing you actually want. The fans who completed a quest last month but have not opened the app since, as a CSV. It writes the calls, pages the results and gives you the file. It needs nothing from us.
Both are read-only work on your side, and neither one needs a feature to be built first.
## Building the fan experience with an agent [#building-the-fan-experience-with-an-agent]
If you are putting FanBase into your own product rather than running the hosted app, the agent path is how the SDK is meant to be installed. The packages carry the files an agent reads, a bootstrap prompt and a thin agent skill, so the reference material arrives in the repo alongside the code.
Paste two prompts, and the order matters: sign-in first, questing second. Combining them produces something that looks finished and has a stubbed login. Integrate with an agent has both prompts and the list of things worth checking by hand afterwards.
## An assistant in the admin panel [#an-assistant-in-the-admin-panel]
Exploring
The idea is that you would ask for the thing instead of filling in the form. Create a daily quest worth fifty XP with a streak cap, and it would draft it for you to approve. Show me quest completions by tag for last month, and it would pull the report.
It is under discussion rather than scheduled. If it would change how your team works, tell your FanBase contact: knowing a partner wants it is what gets it a date.
## Agents connect by reading files, not by MCP [#agents-connect-by-reading-files-not-by-mcp]
Not for this platform, today. An agent that reports otherwise is guessing, and there is nothing to install or connect.
The supported pattern is to give the agent files to read and an API key when it needs one. It works with any tool that can read a file.
# Data API (/docs/integrations/data-api)
Read-only HTTP access to your own community's members, activity, balances and item holdings, authenticated with a key. It never touches the fan experience.
## Scope and first uses [#scope-and-first-uses]
The three things partners built with it first:
* A CRM segment. Members and their balances joined onto the email list, so a campaign can go to fans above level ten rather than to everybody.
* A warehouse table. A nightly pull of members and activity into the same place the store data already lands, so app engagement and revenue can be looked at in one query.
* A dashboard your leadership already reads. Headline totals into the BI tool that shows every other number, rather than one more login for one more panel.
## Getting a key [#getting-a-key]
Ask your FanBase contact for a key.
It is shown once, at creation and never again. Put it straight into a password manager or your secret store. If it is lost, the fix is a new key.
A key can carry an expiry. Ask for one on anything short-lived, like a contractor's integration or a one-off migration. A key with no expiry is a key that outlives the person who asked for it.
Tell us when a key should stop working and we revoke it.
This is a server to server API. The key must never go into a browser, a mobile app, a front end build or anything else a fan can read. The key reads your whole community, and a fan who finds it can read it too. Put it on a server, in a scheduled job, or in your warehouse's connector.
If what you are building is fan facing, use the SDK instead. It authenticates as the fan and returns only that fan's data. See the FanBase SDK API reference.
## Calling it [#calling-it]
Send the key in an `x-api-key` header. The base URL is `https://api.gamerbase.gg`.
```bash
curl -H "x-api-key: $FANBASE_API_KEY" \
"https://api.gamerbase.gg/v1/data/members?limit=100&offset=0"
```
No OAuth dance and no token refresh.
## Resources you can read [#resources-you-can-read]
| Resource | What it is for |
| ----------------- | ----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- |
| Members | One row per fan in your community. The join key for everything else here, and the table your CRM segments against. |
| Member deletions | Fans who deleted their account. The only way to honour a deletion in your own systems too, because a deleted fan stops appearing in members, and in the member export, with nothing to mark the absence. |
| Activity | What fans did and when. The event log underneath every number on the dashboard, and the source for retention and cohort work. |
| Resource balances | One balance per fan per resource, so XP and every spendable currency your community has created. What you segment on when you want your top thousand rather than all of them. |
| Item holdings | Which collectibles and inventory items each fan owns. Useful for checking who actually holds the thing a campaign was built around. |
| Loot box openings | Every opening and what came out of it. Reconciliation, and answering the fan who says the odds are wrong. |
| Analytics totals | Headline counts for the whole community, `totalMembers` and `totalQuestsCompleted` among them. The full set is in [the reference](https://api.gamerbase.gg/api). The cheap call for a status board that does not need per fan rows. |
| Quest catalogue | Your published quests. Public, and the only part of this that needs no key at all. |
## Paging and syncing [#paging-and-syncing]
Every list response has the same shape: `data` holds the rows, `total` holds how many rows match in full, and `offset` says where the page you are holding starts. You page with `limit` and `offset`. The current maximum for `limit` is in [the reference](https://api.gamerbase.gg/api), which is generated from the API and is the value to code against.
Use `updatedSince`. Pass a timestamp and you get back only rows that changed after it. Your first run pulls the whole community. Every run after that pulls the handful of rows that moved since the last one.
Two things to get right when you build that loop.
Store the time the run started. Rows can be written while you are paging, so a cursor set to the last row you saw skips them. Anchor on the run start, overlap the next run by a few minutes, and a row written mid-sync still gets picked up. Write your rows so that seeing the same one twice is harmless, and the overlap costs you nothing.
Read member deletions on the same schedule as members. A deleted fan stops appearing in members, and an incremental sync built on `updatedSince` alone has no way to notice an absence. It keeps the stale row in your CRM permanently, and keeps emailing someone who asked to be forgotten. Deletions is a separate resource precisely so you can pull it and act on it.
## Rate limits [#rate-limits]
The limit is per minute, per key, and it is set high enough that a well built incremental sync will never come close. Every response carries `X-RateLimit-*` headers with the live numbers, and those headers are the authority. A client that reads them and backs off when the remaining count gets low stays inside the limit without any tuning from you.
If you are hitting the limit, the cause is almost always a full re-download on a schedule.
## The interactive reference [#the-interactive-reference]
Every endpoint, every parameter and every response shape is at [api.gamerbase.gg/api](https://api.gamerbase.gg/api), and you can call them from the page with your key. It is generated from the API, so it is the current shape rather than a copy of one. Point your engineers, and your coding agent, at it first.
## Webhooks [#webhooks]
Exploring
Today you poll. Webhooks would invert that: you would register a URL, and the platform would post to you when something happened, so a quest completion could reach your CRM in seconds rather than at the next sync.
It is under discussion rather than scheduled. If a real time reaction is what your campaign depends on, tell your FanBase contact: knowing a partner needs it is what gets it a date.
# Discord (/docs/integrations/discord)
Five separate features share the name Discord, and turning one on does not turn on the others.
| What you want | What it actually is | Where it is set up |
| ----------------------------------------------------------- | ------------------- | ------------------------------------------------------- |
| Fans sign in with their Discord account | A sign-in provider | Per community, by us |
| Fans attach Discord to an account they already have | Account linking | Per community, by us |
| Your server gets a post when you publish something | The FanBase bot | **Settings**, then **Automation** |
| A quest that checks a fan joined the server or holds a role | Two quest templates | [Discord quests](/docs/quests/templates/social/discord) |
| A Discord role given for completing something | A reward type | [Rewards](/docs/rewards) |
## Sign-in and account linking [#sign-in-and-account-linking]
These are two different things and they are configured independently.
**Sign-in** is Discord as a way into your app. A fan taps **Continue with Discord** and they are in, with no separate password. It sits alongside Google, X, Twitch and Shopify, and you choose which of those appear.
**Account linking** is a fan who is already signed in attaching their Discord account afterwards, from their profile. It is on by default, because a fan who signed in with Google still needs a linked Discord account before any Discord quest can be checked.
Linking is the one that matters for quests. A fan who signed in with Discord is linked automatically, but a fan who signed in another way is not, and their Discord quests stay blocked until they link. The card handles that itself. See [Templates that need a linked account](/docs/quests/templates#templates-that-need-a-linked-account).
Tell your FanBase contact which sign-in methods you want and whether Discord linking should be available, and it is a config change rather than a build. [Sign-in methods](/docs/settings/sign-in) has the full list.
In-app usernames look like `name#1234`. That is a FanBase handle in a Discord-like shape, and it is unrelated to the fan's Discord account.
## Announcements in your server [#announcements-in-your-server]
The bot posts to one channel in your server when something happens in the app. The announcement goes out whether or not anyone on your team remembers to write one.
| Trigger | What the server sees |
| -------------------- | --------------------------------------------- |
| A quest is published | A post with the quest and a way through to it |
| An event starts | A post when the event opens |
| An event ends | A post when it closes |
Each notification type has its own toggle, so you can announce quests and stay quiet about everything else. More types are being added: newsfeed posts, store changes and event winners are the ones being worked on. In build
### Setting it up [#setting-it-up]
### Get the bot into your server [#get-the-bot-into-your-server]
Go to **Settings**, then **Automation**. Press **Connect** on the Discord card. Discord asks you to pick the server and approve the bot, then returns you to the admin panel.
Whoever clicks it needs **Manage Server** on that Discord server, so get that person in the room before you start. If the card already offers **Disconnect**, the bot is in and you can skip this step.
### Choose the channel [#choose-the-channel]
Give the channel ID of the channel you want the posts in. A dedicated channel is worth making: announcements in a busy general chat scroll away in minutes.
### Choose a role to mention, or none [#choose-a-role-to-mention-or-none]
Optional. Pick a role and every post pings it. Leave it empty and the post is quiet.
Pinging everyone on every quest is how a server learns to mute your announcement channel. If you want a mention, make an opt-in role for fans who asked for it.
### Turn on the notifications you want [#turn-on-the-notifications-you-want]
Toggle them one at a time and leave the rest off. You can come back and add more once you know what the volume looks like.
### Publish something and watch the channel [#publish-something-and-watch-the-channel]
The only real test.
### Getting the IDs [#getting-the-ids]
Both IDs sit behind Discord's Developer Mode, which [Finding the IDs](/docs/quests/templates/social/discord#finding-the-ids) turns on.
| ID you need | How to get it |
| ----------- | --------------------------------------------------------------------------------- |
| Channel ID | Right-click the channel in the channel list, then **Copy Channel ID** |
| Role ID | Right-click the role in **Server Settings**, then **Roles**, and **Copy Role ID** |
Check the bot's role can view the channel and send messages in it. A channel the bot cannot post in looks exactly the same as a bot that is not working, and it is the first thing to rule out.
## Discord as a source of quests [#discord-as-a-source-of-quests]
Two templates read your server rather than write to it.
**Join the server** asks a fan to be a member of a server you name, and checks it. **Hold a role** asks for a specific role and checks that too, which is how you reward the people who already earned something in Discord.
Both need the fan's Discord account linked, and both need the server ID. Every field is in [Discord quests](/docs/quests/templates/social/discord).
A Discord role is also a gate rather than a quest: you can hide a quest, or block it, until a fan holds a role. That is in [Hidden quests and gating](/docs/quests/creating#set-the-advanced-properties).
## A Discord role as a reward [#a-discord-role-as-a-reward]
The other direction. A fan completes a quest and the bot puts a role on them in your server, with nobody in the loop.
This is what backs the pattern most partners want: level ten in the app buys you a colour in Discord. It needs the bot connected, and the bot's own role has to sit above the role it is assigning in your server's role list. Discord will not let a bot grant a role ranked higher than its own. Check that ordering first if a role is not being assigned.
The reward types you can attach to a quest are in [Rewards](/docs/rewards).
# Shopify (/docs/integrations/shopify)
Connecting Shopify does two independent things: fans sign in with their store account, and purchases in your store pay out XP, currency or collectibles in the app.
## Sign-in [#sign-in]
A fan taps **Sign in with Shopify**. They go to your store through an app proxy URL, which looks like `https://yourstore.com/apps/proxy-redirect`. They authenticate with the account they already have, or create one, and they come back signed in.
It works with standard Shopify accounts and with Shop, Shopify's own login. Either way the fan arrives as one identity: their purchases and their points are the same person.
One thing to know before you brief support. When a fan creates a brand new Shopify account during this flow, Shopify does not return them to your app afterwards. They land back on your store, sign in once more, and everything works from then on. Fans who already have an account never see this.
Whether Shopify appears alongside Google, Discord, X and Twitch, or replaces them entirely, is a per community setting. Some partners run Shopify as the only way in, so that a fan account and a customer account are the same thing by construction.
## Installing it [#installing-it]
The install is a custom Shopify app for your store, which means it is a handful of messages rather than a listing you search for.
### Send us your `.myshopify.com` domain [#send-us-your-myshopifycom-domain]
The original one, ending in `.myshopify.com`.
Find it in your Shopify admin under **Settings**, then **Domains**. The `.myshopify.com` address is listed there even when a custom domain is your primary.
Your custom domain will not work. The install is keyed to the original Shopify domain, and the wrong one costs a week rather than an afternoon.
### We whitelist it and send you an install link [#we-whitelist-it-and-send-you-an-install-link]
The link is unique to your store and expires in about a week. If it lapses, ask for another one.
### Log in to the admin panel before you click it [#log-in-to-the-admin-panel-before-you-click-it]
Open [admin.gamerbase.gg/admin](https://admin.gamerbase.gg/admin) and sign in first, in the same browser. The install finishes by handing you back to the admin panel, and it cannot do that if you are not already authenticated there.
### Approve the permissions in Shopify [#approve-the-permissions-in-shopify]
The link takes you to Shopify's authorisation screen. Read what the app is asking for, then install it.
### Land back in the admin panel [#land-back-in-the-admin-panel]
You are redirected back and the installation completes on its own. Nothing else to fill in.
### Verify it [#verify-it]
In the admin panel, go to **Settings**, then **Automations**. Shopify should show as connected. If it does not, the install did not finish, and the usual cause is step three.
Sandbox and production are separate apps, and they do not cross. A sandbox app connects to a Shopify development store only, and the production app connects to your live store only. Create a development store for testing rather than pointing the sandbox at your real one. It is free and already in test mode.
## Reward rules [#reward-rules]
A reward rule watches your store and pays out when an order matches it. Create them in the Shopify section of the admin panel. Every rule takes a name, a description and a recurrence.
| Field | What it does |
| ----------- | ----------------------------------------------------------------------------------------- |
| Name | What you call the rule internally. |
| Description | What the rule is for, for whoever inherits it. |
| Recurrence | **One time** pays a given fan once, ever. **Recurring** pays every time an order matches. |
| Reward | What the fan gets. See the note on reward types below. |
There are three rule types.
### Tagged purchase [#tagged-purchase]
Rewards an order that contains products carrying a tag you choose. You pick the tags, and you pick whether an order has to match **any** of them or **all** of them.
This is how you reward a category without listing products. Tag the jerseys, write one rule, and every jersey you add later is covered.
### Any purchase [#any-purchase]
Rewards every order regardless of what was bought. The simplest of the three, and the right one for "shopping with us at all earns points".
### Amount spent [#amount-spent]
The reward scales with the order total. You set a rate per unit of your shop currency, and the payout is the rate multiplied by the order total, rounded down. There is no cap on a single order today, so pick the rate with a large order in mind.
### Reward types [#reward-types]
XP, your spendable currency and collectibles. A prize or a loot box for a purchase is a manual reward for now. [Rewards](/docs/rewards) covers the difference between the types.
### Two things to plan for [#two-things-to-plan-for]
Orders created by in-app redemptions are skipped. When the platform itself places an order in your store, no rule fires on it. Without that, a fan could spend points to buy something and earn points for the purchase, and loop.
There is no in-app notification when a purchase pays out. The fan's balance goes up and nothing in the app says where it came from. Partners cover this by mentioning the reward in the Shopify order confirmation email they already send. An in-app notification is on the list.
## Spending points back into Shopify [#spending-points-back-into-shopify]
In build
A fan will be able to buy a store item with points inside the app, and a real order will appear in your Shopify against their customer record. The flow will include a shipping address form and a per fan purchase limit, so a single fan cannot clear the stock.
This is the feature partners ask for most, see [Feature status](/docs/status). Ask your FanBase contact where it stands before you plan a campaign around it.
One piece of planning to do now: when it lands, your store will need a permissions re-authorisation, because creating orders needs write access that the current install does not have. It is a single approval, and we will tell you when.
## Code distribution [#code-distribution]
In build
Discount and gift codes handed out as a reward. See [Rewards](/docs/rewards/custom-rewards#code-distribution).
# Choosing an integration (/docs/getting-started/integration-paths)
The platform is the same in all three. Fans, quests, verification, rewards and the admin panel do not change. What changes is who owns the front end, and that decides how fast you launch and how far you can take the design.
## Hosted app [#hosted-app]
We run the application and serve it on your domain, and you configure it in the admin panel so it looks like you: logo, cover art and per page background images, an accent colour that carries through the interface, fonts, corner radius and spacing, which features appear and in what order in the navigation, what each feature is called so quests can be missions, light or dark, and which languages are offered. The layout of a page and the shape of the components on it stay ours, and a design system that has to be matched exactly is what moves a partner to the next path. Configuration itself is days, two to four weeks once content, artwork and a launch plan are counted, and two to three months at larger organisations with legal review and custom onboarding screens. It suits a fan hub that is its own destination, run by a community team with no engineering time available.
## Your own front end [#your-own-front-end]
You build the interface in your own codebase with the FanBase SDK and host it yourself. Two npm packages give you the API client, the quest state machine, the display strings and unstyled React components, so everything a fan sees lives in your own routes and components, rendered by your design system, with no FanBase stylesheet and no iframe. Verification, reward allocation and the rules about when a quest can be submitted stay on the platform, so you are not reimplementing whether someone really followed the account. A first build of sign-in, a quest list, a detail view and a claim is about a day of developer time, or roughly an hour if you hand the SDK's own prompts to a coding agent and review the diff. It suits engagement inside a site you already have, a campaign that should live on one page, or any team whose design system is not negotiable.
Everything technical is on FanBase SDK. [Build it into your own site](/docs/getting-started/integration-paths) explains when to move and what carries over.
## Bespoke build [#bespoke-build]
We design and build the experience with you, on the same platform, with a team assigned to your account. It suits organisations with their own brand guidelines, procurement, accessibility requirements and a roadmap they want influence over. Talk to your FanBase contact before assuming this is the right path, because the two above cover most cases at a fraction of the effort.
## Comparing them [#comparing-them]
| What changes | Hosted app | Your own front end | Bespoke build |
| --------------------------- | --------------------------------------- | ---------------------------------------------------- | --------------- |
| Who writes the front end | Us | You | Us, with you |
| Engineering needed from you | None | A developer, briefly | None |
| Design control | Themeable | Total | Total |
| Time to first launch | Days to weeks, months with legal review | Hours to days | Weeks to months |
| Lives on your existing site | No | Yes | Either |
| Admin panel | Yes | Yes | Yes |
| Every feature available | Yes | The ones in the packages, see [status](/docs/status) | Yes |
## Running more than one [#running-more-than-one]
Supported, and increasingly the normal answer. Keep the hosted app as the fan hub, and use the SDK to put three quests on a product launch page or a match centre.
Same community, same fans, one progress record. A fan who signs in on either surface is the same fan with the same points.
## Widgets [#widgets]
Widgets are not part of the product. The SDK does the same job without a fixed appearance, and without putting an iframe between you and your fans.
If you are on an older agreement that mentions widgets, talk to your FanBase contact about moving to the SDK.
# Launch strategy (/docs/getting-started/launch-strategy)
How you launch matters more than the launch date. The four below combine well, and your FanBase contact can plan the content calendar around whichever you pick.
## Build a waitlist first [#build-a-waitlist-first]
A landing page with a signup form, two to four weeks ahead. It tells you how big the audience is before you commit to a launch date, and it leaves you with an email list. The wait itself makes the app feel like something worth turning up for.
Put the page up early and promote it everywhere you already are: socials, newsletter, stream, the website. Offer waitlist members something real for signing up early, and keep them updated while they wait so the list does not go cold.
Team BDS collected over five thousand waitlist signups by promoting their app during match broadcasts and on social.
## Gated early access [#gated-early-access]
Open to a small group first, on a signup page gated by single use links. You get feedback while the audience is forgiving, and your most loyal fans get to feel early.
Most esports teams and gaming communities we have launched chose this. It is the safest option: you learn which quests need clearer wording and which rewards fans actually want while fifty people are looking rather than fifty thousand.
Early access fans are not a representative sample. They are your most engaged fans and they will finish everything you publish in a day. Have a second wave of content ready.
## Launch on a moment [#launch-on-a-moment]
Tie the launch to something already pulling attention. A tournament, a season opener, a roster reveal, an anniversary, a big match.
Team Liquid launched during the Race to World First and pulled thousands of fans in a few days by pointing at the app during their streams. It worked because someone with an audience told fans to go there, repeatedly, while they were already watching.
A moment gives you a spike. Have daily and weekly quests live so the people who arrive have a reason to come back on Tuesday.
## Bring partners and sponsors [#bring-partners-and-sponsors]
Your app is inventory. Sponsors can fund rewards, brands can supply prizes, and both extend your reach beyond the audience you already have.
| Route | What it brings |
| ------------------------- | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- |
| Sponsor activations | Co-branded quests, sponsor products as rewards, discount codes for their store. |
| Your players and creators | A pro player pointing at the app during a stream converts better than any post you will write. Give them a reason: a quest about them, a reward they picked, a leaderboard they care about. |
| Other communities | Cross promotion with teams, tournaments and platforms in your ecosystem. |
Ninjas in Pyjamas ran a Fila partnership that gave exclusive branded collectibles to the first three thousand early access fans. Signups rose during the promotional window, and the partnership set up further campaigns.
## Whichever you pick [#whichever-you-pick]
* Have enough content that a fan cannot finish it on day one, which means [twenty to thirty quests](/docs/quests/designing-a-board#publish-twenty-to-thirty-at-launch)
* Have a daily quest, so there is a reason to return
* Decide who reviews image and text submissions, and how fast
* Test on a phone, because most of your fans are on one
* [Reset balances](/docs/rewards/resources#reset-balance) after internal testing and before fans arrive
* Have the second wave of content ready before the first lands
# Onboarding (/docs/getting-started/onboarding)
Launching takes anywhere from a few days to a few months. The platform work is days. Everything else is content, artwork, legal review and deciding what you actually want fans to do.
A named FanBase contact runs the sequence below with you. Each step says which side owns it.
## What we need from you [#what-we-need-from-you]
Gather these early. Every one of them has blocked a launch at some point.
| What we need | Detail |
| -------------------- | ----------------------------------------------------------------------------------------------------------------------------------------------------------------- |
| Domain | The address the app lives on, for example `hub.yourclub.com`. You add a DNS record we specify. |
| Brand assets | Logo, cover image, background art, accent colour. Sizes are in [General settings](/docs/settings/general). |
| Sign-in methods | Which of Google, Discord, X, Twitch and Shopify fans use to get in. |
| Shopify store domain | If you are connecting a store, the original `.myshopify.com` address, not your custom one. |
| Languages | Which of the supported locales you want offered. |
| Leaderboard basis | XP or quests completed. It is set when we build your community and reordering it later moves fans who earned their place. See [Leaderboards](/docs/leaderboards). |
| Admin team | Names and email addresses of everyone who needs access, and the role each of them needs. |
| Legal pages | Your privacy policy and terms, or a decision to use ours. |
| Existing fan list | If you are migrating people in, a CSV. Ask us for the format before you export. |
## What we send you [#what-we-send-you]
| What you get | Detail |
| ---------------------------- | ------------------------------------------------------------------------------------------------------------------------- |
| Admin panel access | On a sandbox first, then production. |
| Your community's identifiers | Tenant (the id for your organisation on the platform), community slug and app id. Your developer needs these for the SDK. |
| A sandbox environment | A full copy of your app to break safely. |
| Shopify install link | If you are connecting a store. It expires in about a week, so use it when it arrives. |
| Data API key | On request, for pulling your community's data into your own systems. See [Data API](/docs/integrations/data-api). |
## The steps [#the-steps]
### Kickoff and a panel demo [#kickoff-and-a-panel-demo]
A demo of the platform, then the admin panel open in front of your team. Bring the people who will run it day to day, not only the person who signed. The teams that launch well are the ones whose community manager has already built ten quests before launch day.
We agree the milestones and a target launch date here.
### We build your community [#we-build-your-community]
We create your community and its configuration. We connect your sign-in providers. We hand you a sandbox.
This is a manual setup on our side today, so allow a couple of days and tell us early if the domain is unusual. Self-serve creation is planned. See [status](/docs/status).
### You configure and fill it [#you-configure-and-fill-it]
The part that takes real time, and the part only you can do.
Set your branding and navigation. Decide your economy: what XP is called, whether you run a spendable currency, and what a level means. Build your first quests. Tag them. Set up your rewards. Stock the store. Write the copy fans read.
Aim for [twenty to thirty quests at launch](/docs/quests/designing-a-board#publish-twenty-to-thirty-at-launch) across a mix of difficulty.
### Connect what you already run [#connect-what-you-already-run]
[Shopify](/docs/integrations/shopify), so purchases pay out and points are worth something. [Discord](/docs/integrations/discord), so quests and events announce themselves. [Google Analytics or Tag Manager](/docs/analytics#web-analytics), so sign-ups can be attributed to the campaign that paid for them.
### Test, then reset [#test-then-reset]
We test in production before anyone is invited. You should too, with your own team, on a phone and a laptop, in both light and dark if you offer both.
Then wipe the balances your testing created, before fans arrive rather than after. See [Reset balance](/docs/rewards/resources#reset-balance).
### Launch [#launch]
Gated early access or a public launch. [Launch strategy](/docs/getting-started/launch-strategy) covers the options and which ones have worked.
We monitor the platform through launch day and can co-market it.
### After launch [#after-launch]
Your FanBase contact stays on the account. Most partners keep a regular call for content ideas and campaign planning, because a steady stream of new quests and posts is what keeps fans coming back.
## Timelines [#timelines]
Honest numbers from real launches rather than a best case.
| Phase | How long |
| ------------------------------------------------------------------------- | ------------------- |
| Platform setup on our side | One to three days |
| Configuration and content by you | One to three weeks |
| A club with custom onboarding screens, legal review and a store migration | Two to three months |
| A community with no custom work, reusing an existing setup | Under a day |
The variable is almost never the software. It is artwork, approvals and deciding what a quest should reward.
## If you are building your own front end [#if-you-are-building-your-own-front-end]
Steps one, two, four and seven are the same. You skip the app configuration and your developer takes over after step two with the identifiers we send.
Point them at the FanBase SDK quickstart. Quests are still built in the admin panel, so your community team still needs step three.
# What it costs (/docs/getting-started/pricing)
Pricing is quoted per engagement, because the three integration paths carry very different amounts of work on our side. The base and the add-ons are below, so a quote arrives without surprises.
For a number, [book a call](https://calendly.com/gauthier-/meet). A standard hosted app can usually be priced on that first call.
## Included in every plan [#included-in-every-plan]
| Included | What it covers |
| ---------------------- | --------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- |
| The platform | Every engagement feature in these docs. Quests, events, leaderboards, rewards, loot boxes, battlepass, store, newsfeed and the full template library. Features ship to everyone as they land, at no extra cost. |
| The admin panel | Unlimited quests and events, your whole team as admins, role based access, analytics and data export. |
| Hosting and operations | Infrastructure, custom domain, certificates, monitoring and updates. Nothing to deploy and nothing to patch. |
| Support | A named contact, monitoring with prioritised fixes by severity, and a Discord or Slack channel with our team in it. |
| The partnership | Onboarding and launch support, content strategy, quest ideas and campaign planning. Partners who use this get better numbers than partners who do not. |
## The variables in a quote [#the-variables-in-a-quote]
| Variable | How it moves the price |
| ---------------- | ---------------------------------------------------------------------------------------------------------- |
| Integration path | Hosted is the base. Your own front end shifts effort to you and prices accordingly. Bespoke is a build. |
| Community size | Priced on active fans rather than followers or signups. |
| Commitment | Longer terms price better. Short campaign engagements are available and do not need a multi year retainer. |
| Add-ons | The list below. |
Short engagements are worth asking about. A single tournament, a product drop or a summer campaign does not need an annual contract, and the SDK made that cheap enough for us to offer.
## Add-ons [#add-ons]
Priced separately because not everyone wants them.
| Add-on | What it covers |
| ------------------------ | -------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- |
| 3D avatars and wearables | A fan avatar that collects branded items, unlocked through quests, events and loot boxes. There is a standard avatar and the option of a custom character built for you. Wearables are produced by our 3D team on a monthly cadence. IP terms differ between the standard avatar and a custom one, so get them in writing. |
| Design and creative | Custom onboarding flows, bespoke screens and branded artwork beyond the standard configuration. |
| Community management | Content calendar planning, campaign ideation and reporting, run with your team. |
| Migration | Importing an existing fan base with their balances. |
Avatars and wearables are an add-on and are not enabled on every app. Before building a season around them, confirm with your FanBase contact that they fit your plan and your timeline.
## Fan facing revenue [#fan-facing-revenue]
Separate from what you pay us, and yours to keep.
You can sell a premium membership inside your app through Stripe, as a subscription or a one off, in your currency and on your schedule. Premium fans can get exclusive quests, better rewards, gated posts and a badge. You set the price and the benefits. See [Membership](/docs/battlepass#premium-membership).
Connecting your store is the other side of it. Fans earn points for buying and spend points on things worth having, and that loop pays for itself. See [Shopify](/docs/integrations/shopify).
{/* Hidden, pending a decision on whether this section stays.
## Common questions
For a standard hosted app, no. Bespoke builds and migrations are quoted as projects.
Community size is a factor in the quote rather than a meter that surprises you. Ask your FanBase contact where the bands sit for your plan.
You move to your own front end with the SDK. The community, the fans, their progress and the admin panel all stay. Only the front end changes, so it is a project rather than a migration.
Yes. Export your members and their activity from the admin panel at any time, or pull it continuously with the [Data API](/docs/integrations/data-api).
Terms vary. Multi year retainers are not required, and campaign length engagements exist. Ask for the shortest term that fits what you are actually trying to prove.
*/}
# Creating a quest (/docs/quests/creating)
Building a quest is seven decisions. Two of them cannot be changed once the quest is saved.
## The form, field by field [#the-form-field-by-field]
### Choose a template [#choose-a-template]
The template is the verification. It decides what the platform checks before it pays a fan, and it is the first thing the form asks for.
| Category | What it covers | Fields |
| ----------------------- | ----------------------------------------------------------------------------------------------------- | ---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- |
| Actions | Visit a link, reach a level, hold a balance, complete another quest, refer a friend, join an event | [Action](/docs/quests/templates/action) |
| Answers and submissions | Upload an image, write an answer, take a quiz or a poll, call an outcome, submit an email or a wallet | [Submission](/docs/quests/templates/submission) |
| Social | Follow, like, repost, check a bio, join a server, watch a stream, follow an artist | [X](/docs/quests/templates/social/x), [Discord](/docs/quests/templates/social/discord), [YouTube](/docs/quests/templates/social/youtube), [Twitch](/docs/quests/templates/social/twitch), [Facebook, Instagram and TikTok](/docs/quests/templates/social/meta), [Spotify](/docs/quests/templates/social/spotify) |
| Gaming | Win matches, hit a rank, play for hours, reach a stat line | [Steam](/docs/quests/templates/gaming/steam), [Counter-Strike 2](/docs/quests/templates/gaming/cs2), [Dota 2](/docs/quests/templates/gaming/dota-2), [FACEIT](/docs/quests/templates/gaming/faceit), [Riot Games](/docs/quests/templates/gaming/riot-games) |
| On-chain | Hold a token or an NFT, or acquire one | [On-chain](/docs/quests/templates/on-chain) |
The template cannot be changed once the quest is saved. See [Managing quests](/docs/quests/managing#editable-and-locked-fields).
Every template is listed field by field in [Quest templates](/docs/quests/templates).
### Fill the template's own fields [#fill-the-templates-own-fields]
Each template asks for what it needs to verify. A visit link quest wants the URL. A quiz wants the options and the correct answer. A Discord role quest wants the role. A CS2 quest wants the number of kills.
The provider has to be enabled for your community, or fans can open the quest and never finish it. See [sign-in and account linking](/docs/settings/sign-in). And the target has to exist: a post that gets deleted takes its quest down with it.
### Set the properties [#set-the-properties]
| Field | What it does |
| -------- | -------------------------------------------------------------------------------------------------------------------------------------------------------------------------- |
| Featured | Pins the quest to the top of the board. Use it for the campaign you are running now, and un-feature the last one. Five featured quests is the same as none. |
| Tag | The label fans filter by, and the way you bundle a campaign. Pick an existing tag or create one here. Untagged quests fall under **Other**. See [Tags](/docs/quests/tags). |
| Ordering | Where the quest sits on the board: **First**, **Last**, or **Custom**, which lets you place it against the quests you already have. |
### Set the advanced properties [#set-the-advanced-properties]
**End date.** When the quest closes. Leave it empty for an evergreen quest.
**Requirements.** What a fan must already have before they can complete it.
| Requirement | Passes when the fan |
| --------------- | ---------------------------------------------------------------------------------- |
| Level | Has reached a level you choose |
| Discord role | Holds a role in your server. Needs [Discord](/docs/integrations/discord) connected |
| Collectible | Owns a specific item |
| Another quest | Has completed a quest you name |
| Membership tier | Is on a paid tier. See [Battlepass](/docs/battlepass#premium-membership) |
**Visibility.** Separate from requirements. A requirement decides whether a fan can complete the quest; visibility decides whether they can see it.
| Visibility | What a fan sees |
| ---------------- | ------------------------------------------------------------------------------------------------ |
| Visible | The quest, locked or not |
| Hidden | Nothing. It exists and is reachable by direct link, which is how a QR code at a live event works |
| Hidden if locked | Nothing until they pass the requirement, then the quest appears |
**Recurrence.** Once, daily or weekly.
| Recurrence | What happens |
| ---------- | --------------------------------------------------------------------------- |
| Once | The default. A fan completes it a single time. |
| Daily | Renews every day. The usual home for a small, trivial, unmissable reward. |
| Weekly | Renews every week. Fits anything that takes real effort, like hours played. |
Anything other than once turns on streaks, which adds two more fields. A **streak boost** is the amount the reward grows by on each consecutive completion, and a **reward cap** is the ceiling it stops growing at. Miss a renewal and the streak restarts at the beginning.
Set the cap too high and a fan who never misses a day earns more from one daily quest than from your whole board. Set it too low and the boost is decorative. Where the cap has to land against your XP thresholds is in [Levels](/docs/levels).
**Expiry.** How the quest closes on its own: **none**, by **date**, or by **participants**. Participant expiry unpublishes the quest once a number of fans have completed it, which is how you run a first fifty campaign without watching the counter.
Count what a brand new fan can see before you publish a board full of hidden-if-locked quests. It makes a board open up as fans progress, and a board built mostly from them looks empty on day one.
### Write the content [#write-the-content]
| Field | What it does |
| ----------- | ------------------------------------------------------------------------------------------------------------------------------------ |
| Language | Which locale you are writing this version in. Add a version for every language you offer, or fans on that language see your default. |
| Title | The line on the card. Say the action: "Follow us on X", not "Social quest 4". |
| Description | How to complete it, in the order a fan does it. This is the field support tickets come from when it is vague. |
| Image | The quest artwork. Optional, and worth it for anything featured or campaign related. A board of thirty text rows is hard to scan. |
### Choose the rewards [#choose-the-rewards]
| Reward | What a fan gets |
| ------------------ | -------------------------------------------------------------------------------------------------------------------------------- |
| XP | Progress towards the next level and a place on the leaderboard |
| Spendable currency | Balance to spend in the store |
| Prize | A custom reward that leaves the app: merchandise, a gift card, an experience. See [Custom rewards](/docs/rewards/custom-rewards) |
| Collectible | A profile picture, border, background or wearable. See [Collectibles](/docs/rewards/collectibles) |
| Loot box | A box the fan opens for a randomised item |
| Discord role | A role assigned in your server automatically |
You can attach several rewards to one quest, so a campaign finale can pay XP, currency and a collectible together.
**Decay** makes the reward shrink as fans claim it. You set the starting amount, how much it drops with each claim, and a floor it never goes below. It rewards speed rather than volume. Use it on a launch or a match day drop rather than on a quest that runs all season.
The reward cannot be changed once the quest is saved. See [Managing quests](/docs/quests/managing#editable-and-locked-fields).
### Publish, schedule, draft or archive [#publish-schedule-draft-or-archive]
| Action | What happens |
| ------------- | ---------------------------------------------- |
| Publish | The quest appears on the board now. |
| Schedule | It publishes on a date you choose. |
| Save as draft | It stays in the panel and no fan sees it. |
| Archive | Closes the quest and moves it out of the list. |
**Timezones.** The panel reads your computer's clock and stores everything in UTC. A scheduled quest publishes at the start of the chosen day in your local time, whatever hour you filled in on the form. If your community sits in another timezone, schedule against theirs: a quest set for Saturday in Europe lands on Friday evening in the Americas.
## Multi-step quests [#multi-step-quests]
Several steps inside one card, with a single reward at the end. The fan sees every step from the start and works down the list.
Build it as one quest with steps rather than as a chain of quests hidden behind each other. The chain pattern worked, and fans abandoned it at the fourth link because they could not see how much was left.
Use it for anything that is one job in a fan's head. Link your accounts, then follow, then join the server. Watch the match, then predict the next one, then post about it.
# Designing a quest board (/docs/quests/designing-a-board)
Every quest is three decisions: what you ask for, how the platform proves it happened, and what the fan gets. You make the first and third. This page is about the board they add up to.
## Mix the difficulty [#mix-the-difficulty]
Roughly half the board should be finishable in under a minute, a third should take real effort, and a handful should be genuinely hard. Boards made only of easy quests are finished and abandoned in an afternoon. Boards made only of hard ones look like homework.
## Publish twenty to thirty at launch [#publish-twenty-to-thirty-at-launch]
A launch board with four quests looks empty on day two, and there is no recovering the fans who saw it that way.
Twenty to thirty is the range partner launches have settled on: enough that a committed fan cannot clear the board in one session, few enough that your team can write them all before launch day. Count what a brand new fan can actually see, not the total in the panel.
## Run exactly one daily [#run-exactly-one-daily]
One small thing that renews every day is what brings fans back on a Tuesday, and it takes two minutes to set up. More than one daily and the habit becomes a chore.
## Make the reward worth the effort [#make-the-reward-worth-the-effort]
A fan who spends twenty minutes on a submission for the same reward as clicking a link learns what your quests are worth. Price effort honestly, and use [decaying rewards](/docs/rewards#decaying-rewards) when you want speed rather than volume.
## Leave room for the second wave [#leave-room-for-the-second-wave]
Whatever you publish at launch, your most engaged fans will finish it in a day. Have the next batch written before the first one lands.
## Where the rest of it lives [#where-the-rest-of-it-lives]
| What you want | Page |
| ------------------------------------------------------------ | ------------------------------------------------- |
| Every field on the quest form | [Creating a quest](/docs/quests/creating) |
| What each template asks for, and which need a linked account | [Quest templates](/docs/quests/templates) |
| Editing, scheduling and archiving a published quest | [Managing quests](/docs/quests/managing) |
| Grouping quests and giving fans a filter | [Tags](/docs/quests/tags) |
| Approving image and text submissions | [Reviewing submissions](/docs/quests/submissions) |
# Managing quests (/docs/quests/managing)
Two fields are locked the moment a quest is saved.
## Editable and locked fields [#editable-and-locked-fields]
| Field | After the quest is saved |
| --------------------------------------- | ------------------------ |
| Template | Locked |
| Reward | Locked |
| Title, description and image | Editable |
| Tag and order on the board | Editable |
| End date and expiry | Editable |
| Visibility and requirements | Editable |
| Recurrence, streak boost and reward cap | Editable |
| Featured | Editable |
Two fields are locked. Every other field on the form stays editable, so a confusing description can be fixed while fans are working through the quest.
The reason is fairness. Fans have already completed the quest under the terms you published, and changing what it verifies or what it pays would mean two fans doing different work for different pay under the same title.
At creation time, the template and the reward are the two fields to check twice. Everything else you can fix later. If you get one wrong, duplicate the quest, correct it, and archive the original. The completion history stays with the original.
A quest saved as a draft has already fixed its template and reward.
## Unpublishing [#unpublishing]
The quest comes off the board.
* Fans can no longer see it or complete it.
* A fan who was mid quest loses it. This matters most for gaming quests, where progress accumulates over hours of play: the card disappears and the hours do not count.
* Fans who already completed it keep it in their quest history, with the reward they were paid.
Unpublish a quest whose target broke, for example a deleted post or a dead link. For a quest that has run its course, an end date is kinder, because fans see it closing rather than vanishing.
## Duplicating [#duplicating]
Duplicate copies every field into a new draft, including the template and reward you could not otherwise change.
It is how you fix a mistake, and it is how you run the same quest again next month without rebuilding it. Rename the copy before you publish. Two quests with the same title on one board is a support ticket.
## Per quest analytics [#per-quest-analytics]
Open a quest to see how it performed.
| Measure | What it tells you |
| ------------------ | ---------------------------------------------------------------------------------------------------------------- |
| Completions | How many fans finished it |
| Attempts | How many tried. The gap between attempts and completions is the quest's real difficulty |
| Completion history | A graph over time, which shows whether a quest is still earning attention or was finished in the first afternoon |
| Fan detail | Who completed it, how many attempts they took, and when |
| Timeframe | Today, the last seven days, or all time |
## The Audience column [#the-audience-column]
The quest board carries an Audience percentage. It is the share of your whole community that has finished the quest:
```
completions / total members x 100
```
So a quest sitting at 4% in a community of fifty thousand has been completed by two thousand fans. Judge it against the tab it sits under and against your other quests, never against 100. A daily quest and a quest that asks for a photo will never produce comparable numbers, and expecting them to is the fastest way to retire something that was working.
Export the fan detail as a CSV for anything you need outside the panel, like drawing a winner or briefing a sponsor.
A high attempt count with a low completion count usually means the instructions are wrong rather than the quest being hard. Read your own description again before you change the reward.
For community wide numbers rather than one quest, see [Analytics](/docs/analytics). For pulling this into your own systems continuously, see [Data API](/docs/integrations/data-api).
# Reviewing submissions (/docs/quests/submissions)
Image and text quests cannot be verified by a machine, so a person has to look at them.
## The queue [#the-queue]
Two tabs. **Pending** holds everything waiting on a decision, with the count next to the tab name. **History** holds every decision already made, so you can check what was approved and by whom.
Open a submission to see the image or the text, the fan who sent it, and the quest it belongs to.
Approving is permanent. The reward pays out immediately and there is no undo. Read the submission before you press it, and be careful with the keyboard when you are working through a long queue.
## The fan's view [#the-fans-view]
While a submission waits, the quest card shows **Pending review**. The fan knows it arrived and knows nothing was paid yet.
Rejecting lets you leave feedback, and the fan can submit again. Use it. "Rejected" on its own reads as a judgement on the fan; "the photo needs to show the whole jersey" reads as an instruction, and it usually comes back correct.
## Bulk export [#bulk-export]
Download every submission on a quest in one go: a zip of the images and text files, plus a CSV listing who submitted what.
The CSV carries the fan id, their handle and the submission, and files are named after the quest and the handle, so a folder of two hundred entries is still sortable.
This is how you run a design contest or a photo campaign without opening two hundred cards one at a time. Export, judge offline with the people who need to judge, then come back and approve.
## Cadence [#cadence]
* Decide who reviews and when, before you publish the quest.
* Review at the same time every day. A fixed slot, morning or midday, is enough. Fans learn when decisions happen and stop refreshing.
* Assign a second reviewer for campaigns. Anything you promoted will produce more submissions in a day than the rest of the board does in a month.
A slow queue is the fastest way to make fans stop submitting. A design contest with a two week turnaround on approvals reads as a broken quest, and the fans who gave you real work are the ones who notice first. If you cannot review within a day, do not publish the quest yet.
Submission templates and their fields are in [Submission quests](/docs/quests/templates/submission).
# Tags (/docs/quests/tags)
A tag does two jobs at once: it is the filter fans use on the quest board, and it is how you bundle a campaign so you can find it again.
## Creating a tag [#creating-a-tag]
**Create tag**, then three fields.
| Field | What it does |
| ----- | ------------------------------------------------------------------------------------------------------------------------- |
| Label | What fans see on the filter. |
| Slug | The identifier in the URL when a fan selects the tag. Defaults to the label, and **cannot be changed afterwards**. |
| Order | Where the tag sits in the filter row. Lower numbers come first, and two tags on the same number are ordered oldest first. |
The slug is the only field here you cannot repair. Set it to something short and stable, and keep the campaign year out of it: `daily` survives, `daily-2026` does not.
You can also create a tag while building a quest, on the Tag field. It lands in this list with the same three properties.
## Managing tags [#managing-tags]
| Action | What happens |
| ------ | ------------------------------------------------------------------------------------------------------------------------------------------ |
| Edit | Changes the label and the order. Not the slug. |
| Merge | Moves every quest under one tag into another, and removes the original. Merging Social into Community leaves every quest tagged Community. |
| Delete | Removes the tag permanently. Its quests are not deleted; they fall under **Other**. |
**Other** is the fallback for any quest without a tag, whether it never had one or its tag was deleted. It is not a tag you manage.
## Using them well [#using-them-well]
| Do this | Why |
| -------------------------- | ---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- |
| Tag by shape | Daily, Social, Gaming, Sponsor. Fans filter to find something they can do now. A tag called Champions League Semi Final is a campaign, and a campaign is what the [featured](/docs/quests/creating) flag is for. |
| Keep the row short | Six tags fit on a phone. Twelve wrap onto a second line and stop looking like a filter. |
| Set the order deliberately | The first tag is the one most fans press. Put the tag holding your easy repeatable quests first. |
| Merge instead of deleting | Deleting drops quests into Other, where fans will not find them. Merging keeps them somewhere a fan is looking. |
# Automations (/docs/settings/automations)
Shopify sits here, and so does the Discord bot.
## Shopify [#shopify]
Where a connected store shows as connected. If you have run the install and Shopify does not appear here, the install did not finish. The usual cause is not being signed in to the admin panel in the same browser when you clicked the install link.
Reward rules themselves are configured in the Shopify section rather than here. See [Shopify](/docs/integrations/shopify).
## The Discord bot [#the-discord-bot]
Our bot posts into a channel you choose when something happens in the app.
| Trigger | What it posts |
| ------------------- | ---------------------------------------------------------- |
| New quest published | The quest title, its description and a link into your app. |
| New event published | The event title, its window and a link. |
| Event ends | That the event has finished, pointing at the results. |
More triggers are being added, including newsfeed posts, store changes and event winners. See [Feature status](/docs/status).
### Setting it up [#setting-it-up]
We install the bot in your server and give it permission to post. After that, each trigger takes two decisions in the panel.
| Field | What it does | What goes wrong |
| --------------- | ---------------------------------------- | ---------------------------------------------------------------------------------------------------------------------- |
| Channel | Where the message lands. | A quiet announcements channel gets the message seen once. A busy general channel buries it in four minutes. |
| Role to mention | Optional. The role pinged with the post. | Pinging `@everyone` for a daily quest is the fastest way to get your bot muted server wide. Make a role fans opt into. |
Turn triggers on one at a time and watch the server for a week. A community that publishes twenty quests at launch with the new quest trigger on posts twenty messages in an hour, and the twenty first is muted.
The full setup, including the permissions the bot needs and how Discord role quests work, is [Discord](/docs/integrations/discord).
# Gating (/docs/settings/gating)
Almost everything you publish can sit behind a condition: quests, predictions, the steps inside a multi-step quest, store listings. The thing still appears, it just will not open for a fan who does not meet the condition.
The same set turns up wherever gating does, so learning them once covers the lot. The admin panel offers whichever of them the thing you are editing supports. They stack, so two conditions on one item means both have to be true.
## The conditions [#the-conditions]
| Condition | Opens for | Reach for it when |
| ------------------------ | -------------------------------------------------------------- | --------------------------------------------------- |
| **Activated users only** | Fans who have connected accounts and complete quests regularly | Anything free with a prize behind it |
| **Membership** | Premium members, at a tier you pick | The point is to make membership worth paying for |
| **Level** | Fans who have reached a level you set | You want it earned rather than bought |
| **Quest** | Fans who finished a particular quest | One thing has to happen before the next makes sense |
| **Wearable** | Fans who own a particular wearable | The audience already exists as collectors |
| **Discord** | Fans holding a role in your server | You are already assigning that role by hand |
**Activated users is the one most people underuse.** It does not mean anyone with an account. It means a fan who has connected accounts and keeps completing quests, so a throwaway that signed up for the reward does not qualify and a real fan already does. An open quest with something worth winning is exactly what those accounts turn up for, which makes this the cheapest filter you have and the only one that costs a genuine fan nothing.
## What a fan sees [#what-a-fan-sees]
The item stays visible, because a fan who cannot see what they are missing has no reason to qualify for it.
What changes is what the item says when they try to open it. A condition the fan can still meet states how to meet it: a membership gate offers the upgrade, a quest gate names the quest to complete, a level gate gives the level to reach. A condition they cannot act on reads as locked, with no further instruction.
# General (/docs/settings/general)
Almost everything a fan sees before they do anything is on this screen. Which accounts a fan can sign in with and link is [Sign-in](/docs/settings/sign-in).
## Basics [#basics]
| Field | What it does |
| ----------- | ------------------------------------------------------------------------------------------------------------------------- |
| Name | The community name in the header, in the browser tab and in the link preview when someone shares your app. |
| Description | The one line under the name, and the text in that same link preview. Write it for someone who has never heard of the app. |
## Important links [#important-links]
The links fans see in your app: **Website**, **X**, **Discord**, **YouTube**, **Twitch**, **Instagram** and **TikTok**. Fill in the ones you actually run and leave the rest empty. An empty field hides the icon rather than showing a dead one.
These are display links. Announcing quests to Discord is [Automations](/docs/settings/automations), and a Discord role check on a quest needs [the Discord integration](/docs/integrations/discord).
## Visual customisation [#visual-customisation]
| Setting | What it does | What goes wrong |
| ---------------- | --------------------------------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------------------------ |
| Accent colour | The single brand colour carried through the app: buttons, progress bars, active states, highlights. | A pale accent on a dark background makes buttons look disabled. Check a button, not a swatch. |
| Logo | 240x240 recommended, 5 MB max. Sits in the header and on the sign-in screen. | Anything with padding baked in looks small next to other apps. Crop tight. |
| Cover image | 1920x1080 recommended, 5 MB max. The banner at the top of the app. | Detail near the centre gets cropped on a phone. Keep faces and text away from the edges. |
| Page backgrounds | A separate background per section: quests, events, store, leaderboard, newsfeed, battlepass, profile, settings. | Busy artwork behind a quest board makes the card text unreadable. Test with the board full, not empty. |
| Fonts | A primary typeface and an alternate for headings. | A font with no bold weight flattens every heading in the app. |
| Corner radius | Base, large, compact or none, applied to every card and button. | |
| Spacing scale | Base, large or compact. Compact fits more on screen, large reads more calmly on a phone. | |
Changes save immediately and appear on the next page load for fans. There is no publish step here, so make branding changes when nobody is mid quest.
## Theme [#theme]
| Option | What fans get |
| ------ | -------------------------------------------- |
| Dark | The default, and what most communities ship. |
| Light | Light only. |
| Both | A toggle in the app, remembered per fan. |
Pick one and stay there unless you have a reason. **Both** doubles what you have to check. Every quest image, every background, every logo and every custom colour has to work on two grounds. If your brand is built on a dark palette, ship dark.
## Navigation [#navigation]
The order and the labels of the sections in your nav bar.
* **Reorder** the sections so the one you care about most is first. Most communities lead with quests.
* **Rename** a section, so Store can read as Shop.
* **Hide** a section you do not use. Hiding it removes it from the nav rather than deleting the content behind it.
* **Add a custom link** out to your main site, your ticket shop or your Discord. It sits alongside the built-in sections.
A nav bar with nine entries reads as a settings menu. Six is plenty on a phone.
## Feature labels [#feature-labels]
Rename a whole feature across the app rather than only in the nav. Quests become Missions, events become Tournaments, the store becomes the Shop.
You choose the singular and the plural, and the label is applied everywhere the word appears: page titles, empty states, buttons, notifications. Tell your FanBase contact the words you want and we apply them.
Rename before launch. Changing the word after fans have learned it costs you more than the better word gains you.
## Languages [#languages]
English, French, Portuguese, Italian and Indonesian. Tell us which ones you want and we enable them on your community.
Enabling a language does not translate your content. Quest titles, descriptions and event copy are written per language in the admin panel, and a quest missing a translation falls back to your default language rather than disappearing. If you offer French, budget for someone writing every quest twice.
# Roles and access (/docs/settings/roles)
Everyone who touches the app needs their own login. Shared accounts make the audit trail useless and cost you an afternoon when someone leaves.
## Inviting an admin [#inviting-an-admin]
**Invite admin**, then the email address. They get an invitation and set up their own account.
Invite the people who will run the community day to day.
## Roles [#roles]
| Role | What it can reach |
| --------------- | --------------------------------------------------------------------------------------------------------------------------------------------- |
| Admin | Quests, events, submissions, members, rewards, the store and the newsfeed. The normal role for a community manager. |
| Content Creator | Posts and settings only. Built for a creator or a social manager who publishes to the newsfeed and should not be able to change your economy. |
Put at least two people on Admin, so a holiday does not block a launch.
Sub-roles narrow this further when you want a reviewer who only handles submissions or a marketer who only touches the newsfeed. Ask us for the split you want.
## Actions we run on request [#actions-we-run-on-request]
A few changes sit outside those roles and we make them on your community when you ask. Tell your FanBase contact what you need and we run it. Ask for the turnaround when you ask for the change, because it varies with the action.
| Action | Where it applies |
| ------------------------------ | ------------------------------------------------ |
| Rename features across the app | [General](/docs/settings/general#feature-labels) |
| Issue and revoke API keys | [Data API](/docs/integrations/data-api) |
If a button you expected is not there, this table is the first place to look.
## Finding people [#finding-people]
The admin list carries each person's in-app username, their Discord handle and the date they joined. Search by username, or filter by join date to find whoever was added during a campaign and never removed.
Review the list every quarter. Agencies rotate staff, and an admin account nobody remembers creating is the one that publishes a draft by accident.
# Sign-in (/docs/settings/sign-in)
Two separate things, set independently.
**Sign-in** is how a fan gets an account. **Account linking** is what they connect afterwards so gaming and social quests can be verified.
Providers are enabled per community by us, so tell your FanBase contact which ones you want. The panel shows what your community has, and the table below is what is possible rather than what is on.
## What each provider supports [#what-each-provider-supports]
| Provider | Sign-in | Account linking |
| ------------- | ------- | --------------- |
| Google | Yes | |
| Discord | Yes | Yes |
| X | Yes | Yes |
| Twitch | Yes | Yes |
| Shopify | Yes | |
| Steam | | Yes |
| Riot | | Yes |
| FACEIT | | Yes |
| Battle.net | | Yes |
| Epic | | Yes |
| YouTube | | Yes |
| Spotify | | Yes |
| EVM wallet | | Yes |
| Solana wallet | | Yes |
A fan cannot unlink the account they signed up with, because it is the account. Everything else they can disconnect and reconnect, within limits that exist to stop one person farming rewards across accounts.
## Lead time [#lead-time]
Ask for the providers you need during [onboarding](/docs/getting-started/onboarding) rather than the week you planned the campaign. Some carry real lead time. Shopify needs a custom app built for your store, wallets sit behind a flag, and several of the gaming providers need approval on their side before they work for your community at all.
A quest cannot be completed if its provider is not enabled for your community. Publishing a Steam quest with Steam linking off gives fans a card they can open, read and never finish. Check the provider before you build the quest.
# 3D avatars (/docs/rewards/avatars-3d)
A character a fan owns and dresses in collectible wearables earned through the app.
The 3D avatar is an add-on. It is not enabled on every app and it is priced separately. Confirm with your FanBase contact that it is part of your plan before you build a season, a campaign or a reward calendar around it.
## Wearables [#wearables]
Each one occupies a slot on the avatar and carries a rarity tier, so a mythic jacket is visibly rarer than a common one. They are earned the same way personalisation items are: quests, events, the store and loot boxes.
Three slots, so three things a fan can be wearing at once.
Ownership can also be used as a gate. A quest, an event or a post can require a specific wearable, which is how a legendary item earned last season becomes the key to something this season.
## Standard or custom [#standard-or-custom]
The standard avatar is a human character that every community using the add-on shares, dressed in wearables designed for your brand. A custom character is your own: a mascot, a different body, a different visual language, with an item set made for it.
Both are produced by our 3D team on a cadence agreed with you. A custom character is a build with its own timeline, and the intellectual property terms differ between the two, so get them in writing before work starts. See [What it costs](/docs/getting-started/pricing).
# Collectibles and personalisation (/docs/rewards/collectibles)
Personalisation items and avatar wearables share this screen. You upload the first yourself, and our 3D team produces the second.
## Personalisation items [#personalisation-items]
Profile pictures, borders and backgrounds that a fan equips on their profile. You upload these yourself, and they appear across the app: on the leaderboard, in comments, next to their name in the nav.
| Item | Where it shows |
| --------------- | ------------------------------------------------------ |
| Profile picture | Everywhere a fan's avatar appears |
| Border | Layered on top of the profile picture, around its edge |
| Background | Behind their profile |
Upload as many as you like. Animated files work.
Borders sit on top of the picture rather than behind it, so leave the middle of a border transparent and design it as a frame. A border that fills its square hides the avatar under it.
## Avatar wearables [#avatar-wearables]
Items worn by a 3D avatar: clothing, accessories, kit. These are produced by our 3D team to your brand guidelines and published into your panel ready to configure.
Avatars are an add-on. If your community does not have them, this section is personalisation items only. See [3D avatars](/docs/rewards/avatars-3d).
## Rarity [#rarity]
Every item carries a rarity tier. It changes how the item is presented in the app, and it is the shorthand fans use with each other.
Decide the ladder before you upload the first batch, and keep the top of it genuinely scarce. Rarity is a promise about how many exist. A legendary item on a daily quest teaches fans that the word means nothing, and you cannot take it back.
## Routes to a fan [#routes-to-a-fan]
| Route | Set it up in |
| ----------------- | ----------------------------------------- |
| Quest reward | [Creating a quest](/docs/quests/creating) |
| Event prize | [Events](/docs/events) |
| Store listing | [Store](/docs/store) |
| Loot box contents | [Rewards](/docs/rewards) |
The same item can be used on all four. A collectible that is both a store item and a loot box drop is fine, and it gives fans who missed the drop a way to get one.
Items are held in your community rather than on a chain. See [Feature status](/docs/status#retired).
# Custom rewards (/docs/rewards/custom-rewards)
A custom reward is anything you hand over yourself: a jersey, a signed shirt, a gift card, a ticket, a call with a player. The platform tracks who won it and collects what you need to deliver it.
## Creating one [#creating-one]
| Field | What it does |
| ------------ | ------------------------------------------------------------------------------------------------------------ |
| Title | What fans see when they win it. Be specific: "Signed 2026 home shirt", not "Merch prize". |
| Description | What it is and what happens next. Say how long delivery takes, because the fan has no other way to find out. |
| Image | The picture on the reward card. |
| Requirements | What the fan must give you before you can fulfil it. |
Each requirement adds a form the fan fills in when they claim.
| Requirement | Ask for it when |
| -------------- | ----------------------------------------------- |
| Email address | You are sending a code, a link or an invitation |
| Postal address | You are shipping something physical |
| Wallet address | You are sending something on-chain |
Ask for the least you need. A fan who is asked for a postal address to receive a discount code assumes something has gone wrong, and some of them close the form.
## Editing and deleting [#editing-and-deleting]
Every detail of a reward that has not been distributed can be edited.
Deleting is permanent. If a reward has already been distributed, the record of it stays in the panel after the delete. It lists everyone who earned it and what they submitted, so you can still fulfil what you owe.
## Distribution tracking [#distribution-tracking]
Open a reward to see its recipients.
| List | What it tells you |
| --------- | ------------------------------------------------------------------- |
| Earned | Every fan who won it, and from which quest or event |
| Claimed | Which of them completed the claim form, and which are still pending |
| Submitted | What each fan gave you: their address, email or wallet |
The gap between earned and claimed is the list to chase. Fans forget to claim.
Work through claims in batches on a schedule you can keep. The claim data is the same shape every time, so exporting it into whatever your fulfilment team already uses beats copying rows by hand.
## Code distribution [#code-distribution]
In build
You will be able to upload a batch of discount or gift codes and hand them out as a reward, delivered to the fan by email. One code per fan from a pool you control, rather than one shared code that ends up on a deals site.
Until then, codes are a custom reward with an email requirement, sent by you. See [Feature status](/docs/status).
# Rewards overview (/docs/rewards)
Every quest ends in something the fan is paid.
Seven kinds of reward, and most communities run three. The list below is ordered by how much of your time each one takes, cheapest first.
| Reward | What the fan gets | What it costs you |
| -------------------------------------- | ------------------------------------------------------------- | ---------------------------- |
| XP | Progress toward the next level and a place on the leaderboard | Nothing. It is automatic |
| Spendable currency | A balance to spend in the store and on loot boxes | Nothing, until they spend it |
| Collectibles and personalisation items | A profile picture, border, background or item they own | One upload each |
| Loot boxes | A chance at anything in the box | Setting the odds once |
| Discord roles | A role in your server, assigned automatically | Connecting Discord once |
| Prizes and custom rewards | A gift card, a code, merchandise, a ticket, an experience | A person, fulfilling it |
| Decaying rewards | A currency reward that shrinks as other fans claim it | A decision about the floor |
## The two resources [#the-two-resources]
**XP** is earn only. A fan gains it by completing things and can never spend it, so it measures how much someone has done. It drives levels, the main [leaderboard](/docs/leaderboards) and [battlepass](/docs/battlepass) tiers. You do not attach it to a quest by hand: it is distributed automatically on completion.
**Spendable currency** is the second, optional one. It is called Points or Credits by default and you can rename it to anything that fits your community. Fans earn it from quests and events and spend it in the [store](/docs/store) and on loot boxes.
Running both is the normal setup, and it exists so that spending never costs a fan their standing.
Where XP thresholds turn into levels is [Levels](/docs/levels). Creating and renaming a currency is [Resources](/docs/rewards/resources).
## Prizes and custom rewards [#prizes-and-custom-rewards]
Anything that exists outside the app. Gift cards, discount codes, signed merchandise, match tickets, a call with a player.
These are the rewards fans actually talk about, and the only ones that need a person. Set one up with a title, a description and an image, then decide what you need from the fan before you can fulfil it.
| Requirement | Collect it when |
| -------------- | ------------------------------------------------------------- |
| Email address | You are sending a code or a voucher |
| Postal address | You are shipping something |
| Wallet address | You are sending something on chain |
| Nothing | The reward is honorary, or you already know how to reach them |
The fan supplies the detail at the moment they claim rather than when they earn, so you are not holding addresses for people who never came back. Everything claimed lands in the admin panel with the fan, the reward and the details they gave, and your team works from that list. See [Rewards in the admin panel](/docs/rewards/custom-rewards).
Price the effort honestly. A fan who spends twenty minutes on a submission for a hundred XP learns exactly what your quests are worth.
## Collectibles and personalisation items [#collectibles-and-personalisation-items]
Items a fan owns and keeps.
**Personalisation items** are the ones every community can use: profile pictures, borders that layer on top of the picture, and backgrounds. You upload them, hand them out through quests, events, the store and loot boxes, and they render on the leaderboard, on profiles, on comments and in the navigation bar.
**Wearables** sit on the 3D avatar and are part of the avatar add-on rather than the base platform. Both are covered in [Profile personalisation](/docs/rewards/collectibles) and [3D avatars](/docs/rewards/avatars-3d), and setup is [Collectibles](/docs/rewards/collectibles).
Items are held in your community rather than on a chain. See [Feature status](/docs/status#retired).
## Loot boxes [#loot-boxes]
A box containing any mix of the rewards above, with odds you set per item, opened with an animation.
A fan either buys one in the store with spendable currency or receives one as a reward. Either way the contents are decided when they open it, so the same box can hold a common currency drop and a rare prize.
Loot boxes are how you put something genuinely scarce into circulation without deciding who gets it. Ten signed shirts as a quest reward means picking ten fans. Ten signed shirts in a box means every fan has a reason to open one.
Two things to get right. Odds that are too generous empty your stock in a weekend. Odds that are too mean produce a box that fans open twice and never again, because a hundred currency five times running teaches them the box is not worth opening. Publish the odds in the description.
## Discord roles [#discord-roles]
A quest can assign a role in your Discord server on completion. It needs [Discord](/docs/integrations/discord) connected, and the role has to already exist in your server.
Use it to tie the app to the server you already run: finish onboarding in the app, get the verified role in Discord, see the channels. It also works as a gate in the other direction, because a Discord role can be a quest requirement.
## Decaying rewards [#decaying-rewards]
A reward that is worth more to the fans who get there first. You set a starting value, an amount it drops by with each claim, and a floor it never goes below. The fan sees what the reward is worth right now.
It falls with claims rather than with the clock, so the value depends on how many fans got there before them, not on how long they waited. Decay on a quiet quest stays near the starting value for days.
| Field | What it does | Get it wrong and |
| -------------- | ---------------------------------------- | ----------------------------------------------------------------- |
| Starting value | What the first fans to claim get | Too low and the drop changes nothing about when a fan claims |
| Decay rate | How much the value falls with each claim | Too fast and everyone outside the first few claims gets the floor |
| Floor | The value it stops at | A floor of zero means a late fan does the work for nothing |
This is the tool for being early rather than for volume. Use it when the point is that fans show up before everyone else: a drop, a match day quest, a reaction to news you published an hour ago. Do not use it on your daily quest.
Set the floor at something you would be happy to pay, and set the rate against the number of fans you expect rather than against a deadline.
Decay that falls with elapsed time, with a countdown on the card, is Planned. See [Feature status](/docs/status).
## Several rewards on one quest [#several-rewards-on-one-quest]
One quest can carry more than one reward. XP plus currency plus a collectible is a normal combination, and the fan claims them together.
Pair a small automatic reward with a rare one. Everybody gets the currency, and the collectible is the reason to bother. It also lets you split a reward across types, so a hard quest can pay in something spendable and something ownable at once.
## Allocation and claim [#allocation-and-claim]
Every reward goes through two steps, and a fan asking where their prize is has usually stopped between them.
**Allocation** happens when the fan earns it. The platform reserves the reward against their account. For an event, this is the moment the event resolves and positions are final.
**Claim** is the fan's action. They tap claim, the reward lands, and anything you asked for is collected at that point. A prize that needs a postal address asks for it here.
Rewards do not claim themselves. A fan who earned a prize and never opened the app again has an unclaimed allocation, and it will sit there. If you are running a campaign against a deadline, that gap is worth an announcement. The claim list in the admin panel and the earned list are two different lists.
# Resources (/docs/rewards/resources)
A resource is a number a fan accumulates. You get three kinds, and they behave differently enough that mixing them up breaks your economy.
## The three kinds [#the-three-kinds]
| Property | Primary | Secondary | Event score |
| ------------------ | ------------------------------- | ------------------------------------------ | ---------------------------------------------- |
| Called by default | XP | Points or Credits | Event score |
| How a fan gets it | Quests, events, purchases | The same | Completing quests inside one event |
| Can a fan spend it | No. Earn only. | Yes. It is the store currency. | No |
| What it drives | Levels and the main leaderboard | Balance, and what a fan can afford | That event's leaderboard, and nothing else |
| How many you get | One | As many as you create, though you want one | One per event |
| Survives the event | Yes | Yes | No. It is scoped to the event that produced it |
XP only ever goes up, which is what makes a leaderboard mean something over a season. The secondary resource goes up and down, because fans spend it in [the store](/docs/store). The event score is separate from both: it ranks one [event](/docs/events) and does not move a fan's level or their position on the main leaderboard.
## Renaming and re-imaging [#renaming-and-re-imaging]
Select a resource, then edit. You can change its **name** and its **icon**.
The name is what fans see everywhere: quest cards, the store, the leaderboard, notifications. Partners call XP things like Fan Points or the club name plus XP, and the secondary currency Credits, Coins or the club's own currency name.
Pick both before launch. A fan who has been earning Credits for a month and opens the app to find Coins assumes something was taken from them.
The icon sits next to every number in the app at a small size, so a detailed logo turns into a smudge. Use a simple shape with a single colour.
## Creating a secondary resource [#creating-a-secondary-resource]
A secondary resource takes a name and an icon, and you create it yourself.
## Best practice, two currencies [#best-practice-two-currencies]
Run XP plus one spendable currency and stop there. It is the setup every screen in the app is designed around.
A third spendable currency is a support burden. It doubles the number of prices in the store and needs its own rules for what earns it. If you think you need one, describe the campaign to us first, because usually a [tag](/docs/quests/tags) or a [level gate](/docs/levels) does the same job.
## Reset balance [#reset-balance]
One button. It clears every fan's balances and levels across the community, and it cannot be undone.
| Cleared | Kept |
| --------------------------------------------------- | ---------------------------------------------- |
| Resource balances, primary and secondary | Quest completion history, submissions included |
| Levels, and every fan's position on the leaderboard | Accounts, linked accounts and profiles |
| Battlepass progress, which unlocks on the same XP | Collectibles and items already owned |
This is the last step before launch. Your team tested the app, and that testing produced real balances on real accounts, sitting at the top of the leaderboard on day one for anyone to see. Reset the day before you invite fans.
After launch, treat it as a season boundary rather than a maintenance task. Past standings are not archived when you reset, so anything you want to keep needs exporting first: the [member export](/docs/members#exporting-the-member-list) or the [Data API](/docs/integrations/data-api). Seasonal history that survives a reset is on the list. See [Feature status](/docs/status).
# In-app actions (/docs/quests/templates/action)
No account to link and nothing to review. These read state your app already holds, or they watch for one press.
| Template | The fan | You configure |
| --------------------------- | --------------------------------------------- | ---------------------------------------------- |
| Auto complete | Opens the quest and presses complete | Nothing |
| Visit link | Opens your link, then presses complete | The URL |
| Check level | Nothing. It reads their level | The level, and which resource's levels to read |
| Check resource balance | Presses Check | The resource and the amount |
| Complete a quest | Completes the quest you name | Which quest |
| Complete a number of quests | Completes any quests until the count is met | How many |
| Referral count | Shares their referral link and people sign up | How many people |
| Membership referral count | The same link, counted as community members | How many people |
| Leaderboard ranking | Climbs to a position | The target rank |
| Event leaderboard ranking | Climbs to a position inside an event | The event and the target rank |
| Join events | Joins events | How many |
| Own collectibles | Holds items in their inventory | How many |
## Auto complete [#auto-complete]
The one with no condition at all. The fan opens it, presses the button, gets paid.
A daily auto complete with a small reward and a streak boost is the cheapest way to make fans open the app tomorrow, and it takes about two minutes to set up. See [recurrence and streaks](/docs/quests/templates#recurrence-and-streaks).
Keep the reward small. There is nothing to verify, so the reward is the price of one tap.
## Visit link [#visit-link]
The fan opens your URL in a new tab, comes back, and the complete button turns on.
The platform records the click rather than what happened after it, so it cannot tell you whether they read the article or closed the tab. That is what the template is built for: pushing traffic somewhere you measure separately.
Write the description as though it is the instruction. "Visit our store" gets a click. "Visit our store and find the code in the banner" gets a click and a reason to stay.
## Check level and check resource balance [#check-level-and-check-resource-balance]
Two ways of paying fans for progress they have already made.
**Check level** completes once the fan has reached a level you choose. Levels are driven by a resource, usually XP, so you pick the resource as well as the number.
**Check resource balance** completes once the fan holds an amount of a resource you choose. It shows a progress row and a Check button rather than completing on its own, so a fan who is already over the line still has to open the quest once.
Level quests are also how battlepass tiers are built, and those are hidden from the quest board. If you see level quests in the admin panel that nobody on your team created, that is what they are. See [Battlepass](/docs/battlepass).
## Complete a quest, and complete a number of quests [#complete-a-quest-and-complete-a-number-of-quests]
**Complete a quest** completes once the fan has completed the quest you name. It is a way of paying a bonus for a quest you want to push, without editing that quest's reward.
**Complete a number of quests** counts any quests at all, so it is the board-wide milestone: complete five things this week, get something. It counts from the moment the fan starts it, so publish it early in a campaign rather than at the end.
To gate a quest behind another quest, use a quest requirement instead. That is on [Creating quests](/docs/quests/creating).
## Referral count and membership referral count [#referral-count-and-membership-referral-count]
Both are built on the fan's own referral link, which the card shows with a copy button. Neither one asks the fan to do anything else.
**Referral count** completes when the number of people who signed up through their link reaches your target. The fan comes back to the quest to complete it.
**Membership referral count** counts referrals who become members of your community, and it completes on its own the moment the count is reached. There is no button for the fan to press.
The platform runs referral safeguards, and a quest that pays well will attract people trying to get around them, so start the reward lower than feels right and raise it.
## Leaderboard ranking and event leaderboard ranking [#leaderboard-ranking-and-event-leaderboard-ranking]
**Leaderboard ranking** completes when the fan reaches a position you set on the community leaderboard. **Event leaderboard ranking** does the same inside one event you choose.
Both are progressive: the fan starts the quest and it completes once they have hit the rank.
Rank quests are the two templates on this page most worth an expiry date, because a rank refers to a season. See [Before you publish](/docs/quests/templates#before-you-publish).
Pick a rank that more than a handful of fans can reach. Top 100 pays a hundred people. Top 3 pays three. See [Leaderboards](/docs/leaderboards).
## Join events [#join-events]
Counts the events a fan has joined, whatever the result. Use it to fill an event that has just opened, or as a season-long "turn up to three of these" quest. See [Events](/docs/events).
## Own collectibles [#own-collectibles]
Completes once the fan holds a number of items in their inventory. Any items, counted together.
If you want a quest that only fans holding one particular collectible can complete, that is a quest requirement rather than this template. See [Creating quests](/docs/quests/creating) and [Profile personalisation](/docs/rewards/collectibles).
## The visit templates on the social pages [#the-visit-templates-on-the-social-pages]
Four more templates work exactly like Visit link.
| Template | Where it is documented |
| ----------------------- | -------------------------------------------------------------------- |
| Visit a Facebook page | [Facebook, Instagram and TikTok](/docs/quests/templates/social/meta) |
| Visit an Instagram page | [Facebook, Instagram and TikTok](/docs/quests/templates/social/meta) |
| View an Instagram post | [Facebook, Instagram and TikTok](/docs/quests/templates/social/meta) |
| View a TikTok post | [Facebook, Instagram and TikTok](/docs/quests/templates/social/meta) |
# Quest templates (/docs/quests/templates)
A template decides what the platform watches for, what counts as proof, and which fields you fill in before you can publish.
Everything else about a quest is the same whichever template you pick: the title, the description, the image, the reward, the schedule, the gating. Those live in [Creating quests](/docs/quests/creating).
A quest's template and its reward cannot be edited once the quest exists, in draft or published. Everything else stays editable. If you picked the wrong template, duplicate the quest and start again. See [Managing quests](/docs/quests/managing).
## The families [#the-families]
More than 150 templates. The picker groups them as Actions, Answers, Social and Gaming, and adds on-chain templates for communities that have wallet linking turned on.
Visit a link, reach a level, hold a balance, refer a friend, join an event.
Quiz, poll, prediction, free text, image upload, email, wallet.
Token and NFT balance checks on EVM chains and on Solana.
### Social [#social]
| Page | Templates | What you can ask for |
| -------------------------------------------------------------------- | --------- | ------------------------------------------------------------------------------------------------------ |
| [X](/docs/quests/templates/social/x) | 9 | Follow, like, repost, quote, post with a hashtag or a link, and three checks on the fan's own profile. |
| [Discord](/docs/quests/templates/social/discord) | 2 | Join your server, or hold a role in it. |
| [YouTube](/docs/quests/templates/social/youtube) | 2 | Visit a channel, watch a video. Subscribe and like were withdrawn. |
| [Twitch](/docs/quests/templates/social/twitch) | 3 | Follow, subscribe, watch a stream for a number of hours. |
| [Facebook, Instagram and TikTok](/docs/quests/templates/social/meta) | 4 | Visit a page, view a post on Instagram or TikTok. |
| [Spotify](/docs/quests/templates/social/spotify) | 3 | Follow an artist or a playlist, or be one of an artist's regular listeners. |
### Gaming [#gaming]
| Page | Templates | What you can ask for |
| -------------------------------------------------------------------- | --------- | ------------------------------------------------------------------------- |
| [Steam](/docs/quests/templates/gaming/steam) | 3 | Hours played, hours in one game, wishlist a game. |
| [Counter-Strike 2](/docs/quests/templates/gaming/cs2) | 19 | Games, wins, win rate, kills, headshots, MVPs, bombs, damage, money. |
| [Dota 2](/docs/quests/templates/gaming/dota-2) | 11 | Last hits, denies, tower damage, kills, assists, rank, wins on a hero. |
| [FACEIT](/docs/quests/templates/gaming/faceit) | 9 | ELO, skill level, hub membership and ranking, and five CS2 stats. |
| [Riot Games](/docs/quests/templates/gaming/riot-games) | Hub | Linking, regions and season resets that apply to all three Riot games. |
| [League of Legends](/docs/quests/templates/gaming/league-of-legends) | 23 | ARAM, ranked, lane objectives, kills, turrets, wards, epic monsters. |
| [Valorant](/docs/quests/templates/gaming/valorant) | 18 | Kills by hit location, spike plants and defuses, ability casts, playtime. |
| [Teamfight Tactics](/docs/quests/templates/gaming/teamfight-tactics) | 4 | Wins, win rate, reach a rank, improve a rank. |
| [World of Warcraft](/docs/quests/templates/gaming/world-of-warcraft) | 16 | PVP, dungeons, raids, character level, renown, achievements. |
## The four shapes [#the-four-shapes]
The shape you publish changes what the card looks like and how long the quest takes to complete.
| Shape | The fan | Templates that work this way |
| --------------------- | --------------------------------------------------------------- | -------------------------------------------------------------------------------------------------------------------------- |
| One press | Opens the quest, does the thing, presses complete | Visit links, most social templates, level and balance checks, gaming rank and achievement checks, on-chain balances |
| Start, then come back | Presses start, plays or watches, returns when the counter fills | Gaming templates that count matches, wins or hours, watch a Twitch stream, acquire tokens, leaderboard and event templates |
| Send something | Types, picks or uploads a value | Quiz, poll, answer, text, image, email, wallet, prediction |
| Nothing at all | The quest completes itself | Auto complete, membership referral count |
Nothing counts before the fan presses start. A quest in the second shape ignores everything that happened first, so a fan who played ten matches, watched two hours or bought the tokens before opening it starts at zero, and the description is the only place you can warn them.
## Templates that need a linked account [#templates-that-need-a-linked-account]
Linking is separate from signing in. A fan signs in once, then links whichever accounts your quests need, and the quest card shows the link step as its own row until it is green.
| Account | Needed for | Templates |
| ------------- | -------------------------------------------------------- | -------------------------------------------------------------------- |
| X | Every X template | [X](/docs/quests/templates/social/x) |
| Discord | Both Discord templates | [Discord](/docs/quests/templates/social/discord) |
| Twitch | Follow, subscribe and watch a stream | [Twitch](/docs/quests/templates/social/twitch) |
| Spotify | All three Spotify templates | [Spotify](/docs/quests/templates/social/spotify) |
| Steam | Steam, Counter-Strike 2 and Dota 2 | [Steam](/docs/quests/templates/gaming/steam) |
| Riot | League of Legends, Teamfight Tactics and Valorant | [Riot Games](/docs/quests/templates/gaming/riot-games) |
| Battle.net | World of Warcraft | [World of Warcraft](/docs/quests/templates/gaming/world-of-warcraft) |
| FACEIT | All nine FACEIT templates | [FACEIT](/docs/quests/templates/gaming/faceit) |
| EVM wallet | ERC-20, staked ERC-20, ERC-721 and native token balances | [On-chain](/docs/quests/templates/on-chain) |
| Solana wallet | Solana NFT balances | [On-chain](/docs/quests/templates/on-chain) |
Nothing in Actions or Answers needs a link. Neither do the Facebook, Instagram, TikTok and YouTube templates, which record the click rather than reading an account.
Three things go wrong here often enough to plan for.
The account has to be enabled for your community. Which accounts a fan can link is a per community setting, and a quest whose account is switched off cannot be completed by anyone. See [Sign-in](/docs/settings/sign-in).
Riot and Battle.net also need a region. The fan picks a server when they link. Until they do, the quest tells them to select a region rather than starting.
Links expire. When a linked account expires the card asks the fan to reconnect, and any quest in progress waits. Nothing is lost, but a fan who does not reconnect looks to you like a fan who abandoned the quest.
## Verification [#verification]
Most templates verify themselves. The platform reads the linked account, the wallet or your app's own state, and decides.
A check runs once, when the fan completes the quest, and nothing is re-checked afterwards. A fan who unfollows, leaves your server or sells the token next week keeps what they earned. Put the quest on a weekly recurrence if you need the thing to be an ongoing condition rather than a one-off.
Display text is never checked. The artist name, channel handle, game name, token symbol, server name and role name you type are what fans read on the card, and nothing compares them to the account, contract or channel being verified. A typo there is visible to every fan and invisible to the check.
Two templates are reviewed by a person: **text submissions** and **image submissions**. The fan submits, the card shows Pending review, and nothing is paid until someone approves it. Both have an auto approve switch that skips the queue and pays on submission. The queue, the bulk export and the approval flow are in [Reviewing submissions](/docs/quests/submissions).
Visit templates record the click rather than what happened after it. Use them where the click is the point, and write the description so a fan knows what you wanted.
## Before you publish [#before-you-publish]
Read the objective line in the quest preview. That sentence is what the fan reads, and it is the fastest way to catch a template that is not the one you meant. Several templates sit beside each other in the picker and differ only in that line: reach a rank against improve a rank, a rate with a minimum number of games against the same rate without one.
Set an expiry on anything seasonal. A quest tied to a ranked season, a leaderboard, an event or a sponsor should unpublish rather than sit there asking for something that has ended. Say the deadline in the description as well, because the expiry date removes the quest without explaining itself, and only the description can tell a fan how long they have.
## Multi-step quests [#multi-step-quests]
A multi-step quest holds several steps inside one card with a single reward at the end, and the fan sees every step from the start. It is built on the quest form rather than by picking a template, so it works whichever template you chose. See [Creating quests](/docs/quests/creating) for the fields and [Quests](/docs/quests/creating#multi-step-quests) for when to reach for one.
Requirements are a different control. They decide whether a fan may complete the quest at all, and they are covered in [Hidden quests and gating](/docs/quests/creating#set-the-advanced-properties).
## Recurrence and streaks [#recurrence-and-streaks]
A quest runs once by default. Set it to renew daily or weekly and it comes back on that schedule. A fan who completes it on consecutive renewals earns a streak boost that grows the reward up to a cap you set, and missing one resets the streak. Recurrence works with every template on these pages, so a daily auto complete and a weekly Counter-Strike 2 quest are both normal. The fields and what happens when the cap is set badly are in [Creating quests](/docs/quests/creating).
## Asking for a template or a game [#asking-for-a-template-or-a-game]
Three template items are queued. Everything else stays unscheduled until a partner asks for it.
| Item | Status | What it would give you |
| -------------------------------------- | ------------------------ | -------------------------------------------------------------------------------------------------------------------------------------- |
| Instagram like and follow verification | Planned | Instagram quests that check the action instead of the visit. See [Facebook, Instagram and TikTok](/docs/quests/templates/social/meta). |
| More Discord templates | Planned | Beyond joining a server and holding a role. Reactions and message activity are the two partners ask for. |
| More Twitch templates | Planned | Beyond follow, subscribe and watch time. |
### New games [#new-games]
Game integrations are built when a partner needs one. Every game in the library today got there that way, and the most recent arrivals came from partners with a launch date.
Ask your FanBase contact for the game you want. That is what reorders the list. A game with a public API and a partner behind it is a matter of weeks. A game with no public API cannot be integrated.
The same is true of a template inside a game you already have. If Counter-Strike 2 is missing the one stat your campaign needs, that is a much smaller job than a new game.
### Partner-specific integrations [#partner-specific-integrations]
Some templates exist for one community. Apeiron is the current example: three templates, enabled for the community that asked for them and invisible everywhere else. If you have a game of your own, or a partner's game, that is the shape the work takes.
# On-chain (/docs/quests/templates/on-chain)
Every template here reads a balance and nothing else. The fan links a wallet, the platform looks at what that address holds, and the quest passes or it does not.
Items are held in your community rather than on a chain. The templates on this page and wallet linking itself are unaffected. See [Feature status](/docs/status#retired).
## The templates [#the-templates]
| Template | Passes when the fan | You configure |
| ------------------ | --------------------------------------------------- | -------------------------------------------------------------------------- |
| Hold ERC-20 | Holds at least the amount you set | Chain, token contract, amount, and the token name and symbol shown to fans |
| Hold staked ERC-20 | Holds at least the amount staked | The same, plus the staking contract |
| Acquire ERC-20 | Adds the amount after starting the quest | Chain, token contract, and the amount to acquire |
| Hold ERC-721 | Holds at least the number you set from a collection | Chain, collection address, count, and the collection name |
| Hold native token | Holds at least the amount of the chain's own coin | Chain and amount |
| Hold a Solana NFT | Holds at least the number you set from a collection | Collection and count |
### Hold, and acquire [#hold-and-acquire]
Five of the six are a snapshot. The fan opens the quest, the platform reads their balance, and if it clears your number the quest completes. A fan who already qualifies completes it in one press.
**Acquire ERC-20** is the exception. It takes a snapshot of the fan's balance when they press start, and it completes once they have added your amount on top of that. A fan holding a thousand tokens who starts an acquire quest for a hundred needs eleven hundred to complete it, and a fan who buys before the snapshot has bought nothing the quest can see. Say so in the description.
## Accounts the fan links [#accounts-the-fan-links]
On EVM chains the fan connects a wallet and signs a message to prove they control the address. No transaction and no gas. The consent screen says what the app can do, which is read public chain data. Solana works the same read-only way, through Phantom, Solflare or Backpack.
EVM and Solana wallet linking are separate settings and both are off by default, so turning on one does not turn on the other. See [Sign-in](/docs/settings/sign-in).
## Getting the configuration right [#getting-the-configuration-right]
The chain and the contract are the whole check. A contract address from the wrong network looks correct and matches nothing. Paste it from a block explorer on the chain you are targeting, not from a search result.
The token name and symbol are not read from the contract. You type them, and they are [display text](/docs/quests/templates#verification), as is the collection name on the NFT templates.
Amounts are what a fan would recognise. Set the number the way it appears in a wallet, not in the token's smallest unit.
Testnets are a separate setting. Communities that need to rehearse against a test network can have it enabled. Ask your FanBase contact rather than pointing a live quest at a test contract.
# Answers and submissions (/docs/quests/templates/submission)
Eight templates that ask a fan to send something back, rather than watching for something they did. Six complete themselves and two go to a review queue.
| Template | The fan | You configure | Reviewed |
| ---------- | -------------------------------- | ------------------------------------------------- | ------------------------ |
| Quiz | Picks one option from a list | The options, and which one is correct | No |
| Poll | Picks one option from a list | The options, and whether results stay private | No |
| Answer | Types an answer | The correct answer, case sensitivity, exact match | No |
| Text | Writes free text | Auto approve on or off | Yes, unless auto approve |
| Image | Uploads an image | Auto approve on or off | Yes, unless auto approve |
| Email | Types an email address | The prompt, in the description | No |
| Wallet | Pastes a wallet address | The prompt, in the description | No |
| Prediction | Picks an outcome before the lock | The options and the lock time | No, you resolve it |
## Quiz [#quiz]
A question with a list of options and exactly one right answer. The fan picks one and submits.
Grading happens on the server, so the correct answer is never sent to the fan's device and cannot be read out of the app. A wrong answer fails the attempt. The quest's attempt limit decides whether the fan can try again, and a quiz with a single attempt and a hard question will generate support messages.
Only one option can be correct. If your question has two defensible answers, use a poll or an answer submission instead.
## Poll [#poll]
The same list of options with no right answer. Every fan who votes completes the quest.
Results are shown as a percentage and a vote count after the fan submits. Turn on **private** and results stay hidden from fans. Use it when you are asking something you intend to act on rather than publish.
## Answer [#answer]
A riddle, or a code read out on a stream. The fan types it and the platform compares it to the answer you stored.
Two switches change how strict the comparison is.
| Setting | Off | On |
| -------------- | --------------------------------------------------------------------------- | ---------------------------------------------------------------------- |
| Case sensitive | Fanbase, FANBASE and fanbase all pass | Only the capitalisation you typed passes |
| Match exactly | An answer that contains your text passes, so a fan can answer in a sentence | The whole submission has to equal your answer, character for character |
Both off is the forgiving combination and the right default for anything a fan types from memory. Both on is right for a code, and it will fail a fan who pastes a trailing space, so say in the description that the code is exact.
## Text [#text]
Free writing. Feedback, a hot take, a caption, a hundred words on why they should get the shirt.
The fan submits at least three characters. By default the submission lands in the review queue and nothing is paid until someone on your team approves it. Turn on **auto approve** and the fan is paid the moment they press submit.
Auto approve on a text quest pays for anything, including three characters of nonsense. Use it when the reward is small and the point is participation. Leave it off when the reward is worth farming, and budget the review time before you publish.
## Image [#image]
An upload. Fan art, a matchday photo, a screenshot of a scoreline, a receipt.
One image per submission, dragged or picked. The card shows **Pending review** until someone decides, and the fan gets a notification either way. **Auto approve** is available here too and carries the same warning as text, and an image quest usually pays more.
Rejections can carry a note back to the fan, which tells them what to fix. The queue and the bulk export are in [Reviewing submissions](/docs/quests/submissions).
## Email [#email]
A single email field, validated as an email address before it is accepted.
There is nothing to configure. Everything the fan needs to know goes in the description, including what you will use the address for. Submissions come out of the admin panel with the rest of them.
## Wallet [#wallet]
A single text field that accepts an EVM address: 40 hexadecimal characters, with or without the leading `0x`. Anything else is rejected in the app.
This is for whitelists and airdrop lists. It does not link a wallet to the fan's account and it does not check any balance, so a fan can type an address that is not theirs. If you need a wallet the platform has verified, that is wallet linking and the [on-chain templates](/docs/quests/templates/on-chain).
## Predictions [#predictions]
A prediction has a deadline and a right answer, which no other family here does, so it has [its own page](/docs/predictions).
# Counter-Strike 2 (/docs/quests/templates/gaming/cs2)
Every template here reads Competitive mode statistics, and the same numbers are farmable against bots, which is why FACEIT exists as an alternative.
Every template needs the fan to [link their Steam account](/docs/quests/templates#templates-that-need-a-linked-account).
The stats API is reliable in Competitive mode. Other modes report inconsistently, so a fan grinding Casual can do everything you asked and see nothing move. Say "in Competitive" in the description.
Bot kills count. Kills against bots go into the same totals, which means a fan who wants to farm a kill count quest can. Assume the highest numbers on your board will be reached that way.
FACEIT avoids both. The same kind of quest run through [FACEIT](/docs/quests/templates/gaming/faceit) is played in a real competitive queue with no bots in it. Use FACEIT for anything with a reward worth farming.
## Round performance [#round-performance]
| Template | What the fan sees | You set |
| -------------------- | --------------------------------------------------------------------- | ------------------------------ |
| Games played | Play a number of games | Games |
| Games won | Win a number of games | Games |
| Win rate | A target win rate | Target win rate |
| Win rate per games | Play at least a number of games and hold a win rate above your target | Minimum games, target win rate |
| Pistol rounds | Win a number of pistol rounds | Pistol rounds |
| MVP titles | Earn a number of MVP titles | MVP titles |
| MVP titles per games | Earn a number of MVP titles | MVP titles |
| Total MVPs | A total MVP count | MVP total |
## Round objectives [#round-objectives]
| Template | What the fan sees | You set |
| ------------- | ------------------------------- | ------- |
| Bombs planted | Plant a number of bombs | Bombs |
| Damage dealt | Inflict an amount of damage | Damage |
| Money earned | Earn an amount of in-game money | Money |
Objective templates are the ones that reward playing the round properly rather than fragging, so they suit a community that plays together. A fan can only plant while they are on the T side, so set the number against a real session rather than against a round count.
## Kill performance [#kill-performance]
| Template | What the fan sees | You set |
| --------------------- | -------------------------------------------------------------------------- | -------------------------- |
| Kill count | Get a total number of kills | Kills |
| Kill count per games | Kill a number of enemies | Kills |
| K/D ratio | Play at least a number of games and hold a K/D above your target | Minimum games, target K/D |
| Kills to deaths ratio | Hold a K/D above your target | Target K/D |
| Headshot kills | Get a number of headshot kills | Headshot kills |
| Headshot rate | Play at least a number of games and hold a headshot rate above your target | Minimum games, target rate |
| Enemy weapon kills | Get kills with weapons picked up from enemies | Kills |
| Knife kills | Get a number of knife kills | Knife kills |
Knife kills and enemy weapon kills are slow, so pay for them properly.
## The paired templates [#the-paired-templates]
Four stats appear twice in the picker: kills, MVP titles, win rate and K/D. The pairs read the same underlying stat and differ in what you get to set. One of each pair takes a **minimum number of games** as well as the target, which is what stops a fan completing a K/D quest on the strength of one lucky round.
Where a pair exists, take the one that lets you set a minimum number of games, then [read the objective line in the preview](/docs/quests/templates#before-you-publish) to confirm you took it.
## Writing a Counter-Strike board [#writing-a-counter-strike-board]
Rate quests need a floor. A win rate or K/D target with no minimum games is a coin flip, and a fan will complete it by accident. Ten games is a sensible floor for anything you are paying real value for.
Totals suit dailies, rates suit weeklies. "Get 30 kills" is a session. "Hold a 1.2 K/D over 20 games" is a week.
Every template here is progressive, so [nothing counts before start](/docs/quests/templates#the-four-shapes).
A quest tied to an event or a sponsor should not outlive it. See [Before you publish](/docs/quests/templates#before-you-publish).
# Dota 2 (/docs/quests/templates/gaming/dota-2)
Eleven templates on the same Steam link that Counter-Strike 2 uses.
Ranked All-pick is the mode these read reliably. A fan playing Turbo or an event mode can do everything the quest asks and see nothing move, so put the mode in the description.
## Objectives [#objectives]
| Template | What the fan sees | You set |
| ------------------ | --------------------------------------------------------------------- | ------------------------------ |
| Tower damage | Inflict an amount of damage to enemy towers | Damage |
| Sentry wards | Buy a number of sentry wards | Sentry wards |
| Win rate per games | Play at least a number of games and hold a win rate above your target | Minimum games, target win rate |
## Lane performance [#lane-performance]
| Template | What the fan sees | You set |
| ------------------- | --------------------------------------------------------------- | -------------------------------- |
| Last hits | Get a number of last hits | Last hits |
| Last hits per games | Average a number of last hits across at least a number of games | Average last hits, minimum games |
| Denies | Get a number of denies | Denies |
Last hits per games is the better of the two last hit templates for anything you are paying for, because a total rewards playing a lot and an average rewards playing well.
## Kill performance [#kill-performance]
| Template | What the fan sees | You set |
| --------- | ---------------------------------------------------------------- | ------------------------- |
| Kills | Kill a number of enemies | Kills |
| Assists | Get a number of assists | Assists |
| K/D ratio | Play at least a number of games and hold a K/D above your target | Minimum games, target K/D |
In a game where support players do most of the work and get none of the kill counts, an assists quest is the one your support players can win.
## Rank and heroes [#rank-and-heroes]
| Template | What the fan sees | You set |
| --------------- | ------------------------------------------ | --------------- |
| Rank | Reach a rank | The target rank |
| Win with a hero | Win a number of games playing a named hero | Hero, wins |
**Rank** is a check on where the fan sits, so a fan already at your target completes it as soon as they start it. Use it to identify a tier of your community rather than to make anyone climb.
**Win with a hero** asks for wins on a hero you choose: win three games on the hero your player is known for, win three on whatever got banned in the last series. It is the one to reach for with a sponsor, because it names a thing rather than a number.
Pick the hero with the fan's queue in mind. A hero who is banned in most games at high MMR is a quest your best players cannot complete.
## Writing a Dota board [#writing-a-dota-board]
Every counting template here is [progressive](/docs/quests/templates#the-four-shapes). Rank is the exception, and it reads where the fan already sits.
Games are long. A quest asking for ten wins is a week of someone's evenings, and it should pay like it.
Rate quests need a floor. Set a minimum number of games on anything with a target average or ratio, or one good game completes it.
Sentry wards is the ward template in the library. No further ward or gem templates are planned.
# FACEIT (/docs/quests/templates/gaming/faceit)
The competitive alternative to reading Counter-Strike 2 stats from Steam. FACEIT matches are played in a real queue with no bots in them.
Every template needs the fan to [link their FACEIT account](/docs/quests/templates#templates-that-need-a-linked-account).
## Hub quests [#hub-quests]
| Template | Passes when the fan | You set |
| ----------------------- | --------------------------------------- | --------------------------- |
| ELO | Reaches an ELO score | Target ELO |
| Skill level | Reaches a skill level | Target skill level, 1 to 10 |
| Hub membership | Is a member of your hub | Hub ID |
| Hub leaderboard ranking | Reaches a position on a hub leaderboard | Leaderboard ID, target rank |
**Hub membership** is the one to publish first if you run a hub. It is a single check.
**ELO and skill level** read where a fan already sits. A fan above your target completes them immediately. Use them to sort your community into tiers.
**Hub leaderboard ranking** needs a leaderboard ID, which you get from the URL of the leaderboard after you have configured it on FACEIT. There is no way to look it up from the admin panel, so set the leaderboard up first.
Leaderboards run in seasons and quests do not, so [set an expiry](/docs/quests/templates#before-you-publish) on any leaderboard quest and put both the leaderboard dates and the claim deadline in the description. A fan who reaches the rank and comes back to claim after the quest expired has a complaint you cannot fix.
## Counter-Strike 2 on FACEIT [#counter-strike-2-on-faceit]
| Template | What the fan sees | You set |
| -------------- | ------------------------- | --------- |
| Kill count | Kill a number of enemies | Kills |
| MVP count | Get a number of MVPs | MVPs |
| Headshot count | Get a number of headshots | Headshots |
| Assists | Get a number of assists | Assists |
| Matches won | Win a number of matches | Matches |
Five stats against the nineteen on [Counter-Strike 2](/docs/quests/templates/gaming/cs2), and the trade is worth it whenever the reward is worth farming.
All five are [progressive](/docs/quests/templates#the-four-shapes).
## Choosing between FACEIT and Steam [#choosing-between-faceit-and-steam]
| You want | Use |
| --------------------------------------------------------------- | ----------------------------------------------------- |
| A big prize, a sponsor, anything competitive | FACEIT |
| A stat FACEIT does not cover, like knife kills or bombs planted | [Counter-Strike 2](/docs/quests/templates/gaming/cs2) |
| To reach fans who play Counter-Strike but not on FACEIT | Counter-Strike 2 |
| To build a quest board around your own hub | FACEIT |
Running both is normal. The usual shape is a wide, cheap Steam board for everybody and two or three FACEIT quests with real rewards on top.
## Linking, and where the IDs come from [#linking-and-where-the-ids-come-from]
FACEIT linking is off by default. Ask your FanBase contact to enable it. See [Sign-in](/docs/settings/sign-in).
Hub IDs and leaderboard IDs both come from FACEIT URLs. Copy them from the address bar rather than retyping them. A wrong ID fails for every fan, including ones who are already in the hub.
# League of Legends (/docs/quests/templates/gaming/league-of-legends)
Twenty-three templates, the largest game library on the platform.
Every template needs a linked Riot account with a region selected. Read [Riot Games](/docs/quests/templates/gaming/riot-games) first for linking, season resets and rate limits.
## ARAM [#aram]
| Template | What the fan sees | You set |
| ------------------- | ----------------------------------------------------- | ---------- |
| High damage in ARAM | Be the high damage dealer in a number of ARAM matches | Matches |
| Dodge skillshots | Dodge a number of skillshots in ARAM | Skillshots |
| Pentakill in ARAM | Get a number of pentakills in ARAM | Pentakills |
| S grade in ARAM | Be rated S or higher a number of times in ARAM | Times |
| Snowballs | Hit a number of snowballs on champions | Snowballs |
Start here. ARAM is one queue, twenty minutes, no ranked pressure and no promo anxiety, which makes these the quests the widest part of your community will complete.
## General performance [#general-performance]
| Template | What the fan sees | You set |
| --------------- | ------------------------------------------------------------------ | ------------------------------ |
| Wins | Win a number of ranked games | Wins |
| Win rate | Play more than a number of games with a win rate above your target | Minimum games, target win rate |
| Ranked duo wins | Win a number of ranked games in a premade duo | Duo wins |
| Reach a rank | Reach a tier and rank this season | Tier, rank |
| Improve rank | Improve to a tier and rank | Tier, rank |
| S minus grade | Be rated S minus a number of times on the Rift | Times |
**Reach a rank** completes for a fan who is already there. **Improve rank** asks them to climb to it. They look almost identical in the picker and they are very different quests, so [read the objective line in the preview](/docs/quests/templates#before-you-publish).
**Ranked duo wins** asks fans to find someone to play with.
## Lane performance [#lane-performance]
| Template | What the fan sees | You set |
| -------------------------- | -------------------------------------------------- | --------------- |
| Turrets before plates fall | Destroy a number of turrets before the plates fall | Turrets |
| Early takedowns | Get a number of early takedowns | Early takedowns |
| Invade the enemy jungle | Kill a number of monsters in the enemy jungle | Monsters |
| Turret takedowns | Take down a number of turrets | Turrets |
| Ward takedowns | Take down a number of wards | Wards |
Ward takedowns is the support and jungle quest. Turrets before plates fall is a laning quest with a real skill ceiling, and worth a real reward.
## Kill performance [#kill-performance]
| Template | What the fan sees | You set |
| ------------------- | ----------------------------------------------------------------- | ------------- |
| Kills | Kill a number of enemy champions | Kills |
| Assists | Get a number of assists | Assists |
| Solo kills | Get a number of solo kills | Solo kills |
| First blood | Get first blood a number of times | First bloods |
| Pentakill | Get a number of pentakills | Pentakills |
| Epic monster kills | Kill a number of epic monsters within 30 seconds of them spawning | Epic monsters |
| Steal epic monsters | Steal a number of epic monsters | Epic monsters |
Pentakill and steal epic monsters are the two that should carry your biggest League rewards. Neither is grindable.
Assists is the one to pair with them, because a board where every kill quest carries the rewards tells half your community the quests are not for them.
## Game changes [#game-changes]
Some of these templates depend on mechanics Riot has changed over the years, and Riot changes the game every season. Build from the templates the admin panel picker offers rather than from a list written for a previous patch.
## Writing a League board [#writing-a-league-board]
Season resets are the biggest risk. See [Riot Games](/docs/quests/templates/gaming/riot-games#season-resets).
Every counting template here is [progressive](/docs/quests/templates#the-four-shapes). Reach a rank is the exception, and it reads where the fan already sits.
Split the board by queue. ARAM quests for everyone, ranked quests for the players who queue anyway. A board that is all ranked excludes most of a community; a board that is all ARAM has nothing for your best players.
# Riot Games (/docs/quests/templates/gaming/riot-games)
League of Legends, Teamfight Tactics and Valorant all sit behind a single Riot link.
23 templates. ARAM, ranked, laning, kills, turrets, wards, epic monsters.
18 templates. Kills by hit location, spike objectives, ability casts, playtime.
4 templates. Wins, win rate, reach a rank, improve a rank.
## Linking, and the region [#linking-and-the-region]
The fan links their Riot account and then picks a region. Both steps are required. A fan who links without choosing a server sees the quest ask for a region before it will start.
Riot linking is off by default. See [Sign-in](/docs/settings/sign-in).
Riot API access is approved per community rather than for the platform as a whole, and approval takes time. If Riot quests are part of your launch plan, raise it with your FanBase contact at the start of onboarding rather than in the week before you go live.
## Season resets [#season-resets]
Player statistics reset when a ranked season starts. A quest published before a reset is asking for progress that is about to be wiped, and a fan halfway through one loses the half they had done.
Any Riot quest that refers to ranked progress needs an expiry date. See [Before you publish](/docs/quests/templates#before-you-publish).
Rank quests are the sharpest case, since a fan's rank is reset to a placement rather than to zero, but win totals and win rates are affected too.
## Rate limits [#rate-limits]
Riot's API is rate limited, and the allowance is granted per community rather than shared across the platform. For most communities this never comes up.
It comes up when a large community runs many Riot quests at once, because every active quest is checking match history for every fan who started it. The symptom is progress that updates slowly.
If you are launching a Riot heavy board to a big audience, plan it with your FanBase contact first. Publish Riot quests in waves rather than twenty at once, and prefer a small number of quests with real rewards over a wall of them.
# Steam (/docs/quests/templates/gaming/steam)
Three templates use the Steam link directly, and every Counter-Strike 2 and Dota 2 template uses it too.
| Template | The fan | You configure |
| -------------------- | --------------------------------------------- | ------------------------------- |
| Play any Steam game | Plays anything on Steam for a number of hours | Hours played |
| Play a specific game | Plays one game for a number of hours | App ID, game name, hours played |
| Wishlist a game | Adds the game to their Steam wishlist | App ID, game name |
Both playtime templates are [progressive](/docs/quests/templates#the-four-shapes), which is the most common reason a fan tells you a Steam quest is broken: they played first and started the quest afterwards. Put it in the description.
A fan's Steam profile has to be public, and game details have to be public with it. A private profile links successfully and then reports nothing, so the quest sits at zero forever with no explanation on the card. The app shows a warning about this. Repeat it in your description.
## Finding the App ID [#finding-the-app-id]
Open the game's page in the Steam store and read the URL.
```
https://store.steampowered.com/app/730/CounterStrike_2/
```
`730` is the App ID. The game name after it is the one to type into the quest as well, so fans see a name rather than a number. That name is [display text](/docs/quests/templates#verification); the App ID is what the check reads.
Get the App ID wrong and the quest tracks a different game, silently and successfully. A fan who plays the game you meant makes no progress. Check it against the store page before you publish.
## Wishlisting [#wishlisting]
A one press quest rather than a progressive one. The fan taps through to the store page, adds it, comes back and completes.
This is the template sponsors and publishers ask for by name, because a wishlist before a launch is the number their marketing team is measured on. It is also the template most worth pairing with a deadline, since a wishlist added the week of release is worth more than one added six months out.
## Playtime [#playtime]
**Play any Steam game** counts everything in the fan's library. It is the low friction version, useful as a weekly quest for a gaming community where you do not much care what people play.
**Play a specific game** counts one App ID. This is the sponsorship template: a publisher wants hours in their game, you set the App ID and the hours, and the reward comes from them.
Set the hours somewhere a fan can reach inside the quest's life. Ten hours on a weekly recurrence is a serious commitment; two is a Saturday.
## The game libraries [#the-game-libraries]
Two games have their own stat templates on top of the Steam link.
| Game | Templates | Page |
| ---------------- | --------- | ----------------------------------------------------- |
| Counter-Strike 2 | 19 | [Counter-Strike 2](/docs/quests/templates/gaming/cs2) |
| Dota 2 | 11 | [Dota 2](/docs/quests/templates/gaming/dota-2) |
Counter-Strike quests can also be run through FACEIT instead of Steam, which changes what is verifiable and what is farmable. See [FACEIT](/docs/quests/templates/gaming/faceit).
## Linking and stat lag [#linking-and-stat-lag]
Steam linking is off by default. Ask your FanBase contact to enable it before publishing anything on this page. See [Sign-in](/docs/settings/sign-in).
Steam stats lag. They are read from Steam rather than watched live, so a fan who ends a session and immediately opens the quest may see their progress a little behind. It catches up.
# Teamfight Tactics (/docs/quests/templates/gaming/teamfight-tactics)
Four templates, and the only Riot rank quests outside League of Legends.
Every template needs a linked Riot account with a region selected. Read [Riot Games](/docs/quests/templates/gaming/riot-games) first.
| Template | What the fan sees | You set |
| ------------ | --------------------------------------------------------------------- | ------------------------------ |
| Wins | Win a number of ranked games | Wins |
| Win rate | Play at least a number of games and hold a win rate above your target | Minimum games, target win rate |
| Reach a rank | Reach a tier and rank this season | Tier, rank |
| Improve rank | Improve to a tier and rank | Tier, rank |
## Reach a rank against improve rank [#reach-a-rank-against-improve-rank]
They sit next to each other in the picker and they are different quests.
**Reach a rank** is a check. A fan already at or above your target completes it as soon as they start it, so it identifies a tier of your community rather than making anyone play.
**Improve rank** asks them to climb. A fan starts it where they are and completes it when they get to your target, which for a fan two tiers below is weeks of work.
[The objective line in the preview](/docs/quests/templates#before-you-publish) is what tells the two apart once a quest is drafted.
## Winning in Teamfight Tactics [#winning-in-teamfight-tactics]
Eight players enter and placings matter more than a binary result, so "win a number of ranked games" is a heavier ask than the same number would be in a five versus five game. Set the target low.
**Win rate** needs its minimum games set, or a single good lobby completes it.
Season resets hit this page harder than any other, because every template here is about rank. See [Riot Games](/docs/quests/templates/gaming/riot-games#season-resets).
# Valorant (/docs/quests/templates/gaming/valorant)
Almost every template is a counter with a number you set, which makes the number the whole design decision on this page.
Every template needs a linked Riot account with a region selected. Read [Riot Games](/docs/quests/templates/gaming/riot-games) first for linking, season resets and rate limits.
## Combat [#combat]
| Template | What the fan sees | You set |
| -------------- | ------------------------------ | -------------- |
| Total kills | Get a number of total kills | Kills |
| Headshot kills | Get a number of headshot kills | Headshot kills |
| Bodyshot kills | Get a number of bodyshot kills | Bodyshot kills |
| Legshot kills | Get a number of legshot kills | Legshot kills |
| Total deaths | A total death count | Deaths |
| Assists | Get a number of assists | Assists |
| Damage dealt | Deal an amount of total damage | Damage |
Legshot kills is the light one that fans love and nobody can farm on purpose.
## Spike and round objectives [#spike-and-round-objectives]
| Template | What the fan sees | You set |
| ---------------- | ---------------------------------- | ------- |
| Plant the spike | Plant the spike a number of times | Plants |
| Defuse the spike | Defuse the spike a number of times | Defuses |
| Team rounds won | Win a number of rounds in total | Rounds |
| Team wins | Win a number of matches | Matches |
| Rounds played | Play a number of rounds in total | Rounds |
Plants and defuses are the two templates that reward playing the objective rather than the fight.
## Abilities [#abilities]
| Template | What the fan sees | You set |
| ------------------- | --------------------------------------- | --------- |
| Total ability casts | A total number of ability casts | Casts |
| Ultimate casts | Use an ultimate a number of times | Ultimates |
| Grenade casts | Use a grenade ability a number of times | Casts |
Ability quests are agent agnostic, so a fan can complete them on whoever they main. They are also the easiest numbers on this page to reach, so keep the rewards small and use them as daily filler.
## Activity [#activity]
| Template | What the fan sees | You set |
| -------------- | ------------------------------------- | ------- |
| Matches played | Play a number of matches | Matches |
| Playtime | Play for a number of minutes in total | Minutes |
| Total score | Achieve a total score | Score |
Playtime is set in minutes, not hours. A weekly quest is a three figure number, and typing the hours by mistake produces a quest a fan completes in one game.
There is no Valorant rank template. If you want a rank quest for a Riot title, that is [League of Legends](/docs/quests/templates/gaming/league-of-legends) or [Teamfight Tactics](/docs/quests/templates/gaming/teamfight-tactics).
## Writing a Valorant board [#writing-a-valorant-board]
Every template here is progressive, so [nothing counts before start](/docs/quests/templates#the-four-shapes).
Rate limits bite hardest here. Valorant templates read match history, and a large community running many of them at once is where Riot's per community allowance shows up as slow progress. Publish in waves. See [Riot Games](/docs/quests/templates/gaming/riot-games#rate-limits).
Counters need a sense of scale. Work out how long a ranked match takes for your community, then price against that: twenty kills is an evening and two hundred is a fortnight.
# World of Warcraft (/docs/quests/templates/gaming/world-of-warcraft)
Retail only, on a Battle.net link that also needs a region. Five of the sixteen take a named dungeon, raid, boss, expansion or achievement, and those are the strongest quests on the page.
These templates were built for one partner first, so ask your FanBase contact to confirm they are enabled on your community before you plan a campaign on them.
## PVP [#pvp]
| Template | What the fan sees | You set |
| --------------- | --------------------------------------------------------------------------- | -------------------------------- |
| Matches played | Play a number of PVP matches | Matches |
| Matches won | Win a number of PVP matches | Matches |
| Win rate | Play at least a number of PVP matches and hold a win rate above your target | Minimum matches, target win rate |
| Honorable kills | Get a number of honorable kills | Honorable kills |
| Honor level | Reach an honor level | Honor level |
Honor level reads where the fan already is, so a fan above your number completes it in one press.
## Dungeons and raids [#dungeons-and-raids]
| Template | What the fan sees | You set |
| ------------------------ | --------------------------------------------------- | ---------------------- |
| Dungeon completion | Complete a named dungeon on a difficulty | Dungeon, difficulty |
| Dungeon boss kills | Get a number of dungeon boss kills | Boss kills |
| Raid completion | Complete a named raid on a difficulty | Raid, difficulty |
| Raid boss kills | Get a number of raid boss kills | Boss kills |
| Defeat a raid boss | Defeat a named boss in a named raid on a difficulty | Boss, raid, difficulty |
| Any raid in an expansion | Complete any raid in an expansion | Expansion |
Dungeons and raids are what a World of Warcraft community organises around, and four of the six templates here take a name.
Difficulty is part of the check. Normal, Heroic and Mythic are different quests with different audiences, and a Mythic quest is for a fraction of your community. Say the difficulty in the title, not just in the configuration, or fans will assume the easiest one.
**Any raid in an expansion** is the wide version, and the right one for a returning player campaign. It asks for one clear of anything, which most of a community can do.
## Progression [#progression]
| Template | What the fan sees | You set |
| ---------------------- | ----------------------------------------- | --------------- |
| Character level | Reach a level | Level |
| Renown level | Reach a renown level | Renown level |
| Achievements | Complete a number of achievements | Achievements |
| Achievement points | Accumulate a number of achievement points | Points |
| A specific achievement | Complete a named achievement | The achievement |
**Character level** and **renown level** are the two to use around a new expansion or patch, because they are the things every player is doing anyway in the first fortnight.
**A specific achievement** is the World of Warcraft equivalent of the named boss quest, and the same advice applies.
**Achievement points** is a total the fan has already accumulated over years of playing, so most of your community completes it the moment they start it unless you set the number high. Treat it as a way of finding long-time players.
## Writing a World of Warcraft board [#writing-a-world-of-warcraft-board]
Every counting template here is [progressive](/docs/quests/templates#the-four-shapes). The check templates, level, renown, honor level and achievement points, read what the fan already has.
Name things where you can. A named dungeon, raid or boss tells a fan exactly what to go and do.
Battle.net linking is off by default and works the same way as the Riot titles. See [Sign-in](/docs/settings/sign-in).
# Discord (/docs/quests/templates/social/discord)
Both templates need the fan to [link their Discord account](/docs/quests/templates#templates-that-need-a-linked-account). Both also need identifiers out of your own server.
| Template | Passes when the fan | You configure |
| ----------- | --------------------------- | ------------------------------------------------------------ |
| Join server | Is a member of your server | Displayed handle, guild ID, guild invite |
| Get a role | Holds a role in your server | Displayed handle, guild ID, guild invite, role ID, role name |
## Finding the IDs [#finding-the-ids]
Discord hides both IDs behind a developer setting. Turn it on once and it stays on.
### Turn on Developer Mode [#turn-on-developer-mode]
In Discord, open **User Settings**, then **Advanced**, and switch on **Developer Mode**. Nothing about your account changes except that copy options appear on right click menus.
### Copy the server ID [#copy-the-server-id]
Right click your server's icon in the left sidebar and choose **Copy Server ID**. That is the guild ID.
### Copy the role ID [#copy-the-role-id]
Open **Server Settings**, then **Roles**. Right click the role you want. Choose **Copy Role ID**. Only the Get a role template needs this.
### Get the invite [#get-the-invite]
Right click the server icon and choose **Invite People**, then copy the link. Use an invite that does not expire and has no use limit, or the quest will stop working.
## The fields [#the-fields]
| Field | What it is | What goes wrong |
| ---------------- | -------------------------------------------- | ----------------------------------------------------------------------------------------------------------- |
| Displayed handle | The server name fans see on the card | [Display text](/docs/quests/templates#verification), so a wrong one is a cosmetic error you will not notice |
| Guild ID | The server the membership is checked against | A wrong ID fails for every fan, including ones already in the server |
| Guild invite | Where the button sends the fan | An expired or single-use invite sends fans to a dead page |
| Role ID | The role the check reads | A wrong ID fails for everyone, the same way a wrong guild ID does |
| Role name | The role name fans see on the card | Renaming the role in Discord does not update the quest. Edit the quest too |
## Role quest behaviour [#role-quest-behaviour]
The fan links Discord, joins the server if they are not already in it, and the quest completes once they hold the role. Nothing in the quest hands out the role. Whatever gives fans the role, a bot or a moderator, has to already exist in your server, and the quest only reads the result.
Role quests work best as a reward for something that already happens in Discord. A fan who arrives at a role quest with no way to get the role has hit a dead end with no explanation on the card.
Giving a fan a Discord role **as a reward** for completing a quest is the opposite direction and a different feature. That is on [Rewards](/docs/rewards), and it needs the Discord integration connected. Announcing quests and events into your server is [Discord](/docs/integrations/discord).
## Linking, and what happens when a fan leaves [#linking-and-what-happens-when-a-fan-leaves]
A fan who leaves the server keeps the reward, because nothing is re-checked once a quest completes. See [Verification](/docs/quests/templates#verification).
Discord linking is on by default. See [Sign-in](/docs/settings/sign-in).
# Facebook, Instagram and TikTok (/docs/quests/templates/social/meta)
None of the four verifies a follow, a like or a view. All four record the tap that opened the link.
| Template | The fan | You configure |
| ----------------------- | ----------------------------------------- | ------------------------------------------------- |
| Visit a Facebook page | Opens your page, comes back, completes | The page URL, and the handle shown on the card |
| Visit an Instagram page | Opens your profile, comes back, completes | The profile URL, and the handle shown on the card |
| View an Instagram post | Opens one post, comes back, completes | The post URL, and the handle shown on the card |
| View a TikTok post | Opens your post, comes back, completes | The post URL, and the handle shown on the card |
## The check [#the-check]
There is no Facebook, Instagram or TikTok account for the fan to link, so the platform has no way to ask any of them whether a particular fan follows you, watched the video, or ever loaded the page. A quest card that says "Follow us on Instagram" and pays out is paying for the tap that opened Instagram. All four are [Visit link](/docs/quests/templates/action#visit-link) with a card that looks like the platform.
Keep the reward small. These are the cheapest quests on your board to complete and they should be among the cheapest to earn. A fan who works out that the button pays without the follow will tell other fans.
Write the description as the instruction. The quest cannot ask for the follow, so the copy has to. Partners get a real share of fans doing the thing anyway, in the same way they do with [YouTube](/docs/quests/templates/social/youtube), as long as the description says plainly what is wanted.
The TikTok template has one job the other three do not: putting a burst of traffic on a post in the hours after you publish it. Price it as a traffic quest.
## Instagram verification [#instagram-verification]
Planned
Checking that a fan liked a post or followed an account on Instagram is the template partners ask for most often among those not yet built. It would need Instagram account linking, which means a fan connecting their Instagram to your app rather than only tapping a link.
Until it lands, treat everything on this page as a traffic template. Ask your FanBase contact where it stands before you build a campaign that depends on it, and see [asking for a template or a game](/docs/quests/templates#asking-for-a-template-or-a-game).
## TikTok account linking [#tiktok-account-linking]
Follow and like checks would need TikTok account linking, in the way they work on [X](/docs/quests/templates/social/x). It is not being built. Instagram verification is ahead of it in the queue, and TikTok would follow the same path if partners ask for it.
## Getting the URLs right [#getting-the-urls-right]
The link is the whole configuration, so paste it from the address bar rather than from a share sheet. Instagram share links carry tracking parameters that sometimes bounce a logged out fan to a login wall. Shared TikTok links redirect through a shortener and occasionally land on an app install prompt instead of the post. Either way the fan cannot complete the quest and has no idea why.
The handle you type is [display text](/docs/quests/templates#verification).
# Spotify (/docs/quests/templates/social/spotify)
Built for music partners, and the only family on the platform that reads what a fan listens to.
All three need the fan to [link their Spotify account](/docs/quests/templates#templates-that-need-a-linked-account).
| Template | Passes when the fan | You configure |
| ----------------- | -------------------------------------- | --------------------------------------------------------- |
| Follow an artist | Follows the artist | The Spotify link, and the artist name shown on the card |
| Follow a playlist | Follows the playlist | The Spotify link, and the playlist name shown on the card |
| Top artist | Has the artist among their top artists | The artist name |
## The two follow templates [#the-two-follow-templates]
The fan taps through to Spotify, follows, comes back, and the check runs against their linked account. The link you paste is where the button sends them. Copy it from Spotify's own share menu or from the address bar of the web player.
The artist or playlist name you type is [display text](/docs/quests/templates#verification).
A playlist follow is usually the better ask of the two. An artist follow is a bigger commitment for a fan who is not already a listener. A playlist you control keeps changing, which gives you a reason to run the quest again next month.
## Top artist [#top-artist]
The one that reads listening history. It checks whether the artist you name appears among the fan's top artists on Spotify, which Spotify works out from what they play.
A fan completes it on months of listening.
It identifies your existing listeners. Use it to find and reward the fans who were already listening. A top artist quest with a big reward and a small qualifying audience is a quest most of your community will look at once and never again.
Set expectations in the description. A fan who fails it deserves to know why, and the card cannot tell them. One line saying that this one is for the people already on repeat is enough.
## Linking, and the one-time check [#linking-and-the-one-time-check]
Spotify linking is off by default. Ask your FanBase contact to enable it before you publish any of these. See [Sign-in](/docs/settings/sign-in).
A follow is not re-checked once the quest completes. See [Verification](/docs/quests/templates#verification).
# Twitch (/docs/quests/templates/social/twitch)
All three need the fan to [link their Twitch account](/docs/quests/templates#templates-that-need-a-linked-account).
| Template | The fan | You configure |
| ------------ | ------------------------------------------ | ---------------------------------------------------- |
| Follow | Follows your channel | The channel handle, and the handle shown on the card |
| Subscribe | Subscribes to your channel | The same |
| Watch stream | Watches your streams for a number of hours | Hours, plus setup. See below |
## Follow and subscribe [#follow-and-subscribe]
The card sends the fan to `twitch.tv` with your handle, they do the thing, and the check runs against their linked account when they come back.
The handle you type is the channel that gets checked, so it has to be the login name from the URL rather than the display name on the channel page. Those are usually the same and occasionally are not.
Subscribe costs the fan money. It is the only social template on the platform that does, and a reward priced as though it were a follow asks a fan to spend money for very little. Partners who run subscribe quests successfully treat them as a thank you to fans who were going to subscribe anyway.
Neither is re-checked once the quest completes. See [Verification](/docs/quests/templates#verification).
## Watch stream [#watch-stream]
Progressive. The fan starts the quest, watches, and the counter fills with hours watched until it reaches your target.
Watch time needs a custom setup for your channel before it can be published. Ask your FanBase contact what it involves for your community before you plan a campaign around it.
The quest has to be live before the stream is, because [nothing counts before the fan presses start](/docs/quests/templates#the-four-shapes).
## Linking, and expired links mid quest [#linking-and-expired-links-mid-quest]
Twitch linking is on by default. See [Sign-in](/docs/settings/sign-in).
A watch time quest that a fan started before [their link expired](/docs/quests/templates#templates-that-need-a-linked-account) resumes counting once they reconnect.
More Twitch templates are one of the three live asks on [the template queue](/docs/quests/templates#asking-for-a-template-or-a-game).
# X (/docs/quests/templates/social/x)
Every template here needs the fan to [link their X account](/docs/quests/templates#templates-that-need-a-linked-account) first.
## Engaging with a post or an account [#engaging-with-a-post-or-an-account]
| Template | The fan | You configure |
| -------- | ------------------------------------ | ------------------------------- |
| Follow | Follows an account | The account link, or the handle |
| Like | Likes one post | The link to the post |
| Repost | Reposts one post | The link to the post |
| Quote | Quotes one post with their own words | The link to the post |
The fan taps through to X, does the thing, comes back and completes. The check runs at that moment against their linked account.
Give the link to the exact post, not to your profile. A quest that says "like our latest post" and links to a timeline will be completed by fans who liked the wrong thing. It fails for everyone once the post is no longer the latest.
## Posting [#posting]
Two templates ask the fan to publish a post of their own and then check that it contains something.
| Template | Passes when the post contains | You configure |
| ------------------- | ----------------------------- | ------------------------------------ |
| Post with a hashtag | Your hashtag | A post template, and the hashtag |
| Post with a link | Your link | A post template, and the link prefix |
The **post template** is the text the app pre-fills for the fan when they tap through to compose. They can edit it, and it can carry the fan's own handle so the post reads as theirs.
The **hashtag** and the **link prefix** are what the check reads. A fan who deletes your hashtag while editing does not complete the quest, and a fan who adds a paragraph of their own around it does. Keep the pre-filled text short: the longer it is, the more of it fans delete, and the more likely the checked part goes with it.
## Checking a fan's own profile [#checking-a-fans-own-profile]
Three templates read what the fan has put on their own profile. Use them for a campaign where fans mark themselves as part of something: a tag in the display name for a tournament, a link in the bio for a launch.
| Template | Reads | You configure |
| ------------------ | ---------------------- | --------------------------------------------------- |
| Display name check | The fan's display name | The text to look for, case sensitivity, exact match |
| Bio check | The fan's bio | The same |
| Username check | The fan's handle | The same |
**Case sensitive** on means the capitalisation has to match yours. **Exact match** on means the whole field has to equal your text, which for a bio is almost never what you want. Leave both off unless you are checking a code.
Username check is the strictest of the three, because changing a handle is a real decision for a fan. Price the reward accordingly.
## Private accounts and the one-time check [#private-accounts-and-the-one-time-check]
A private account will not verify. A fan whose posts are protected will link successfully and then fail the post checks, and neither they nor you get an explanation beyond the quest not completing. Put one line in the description.
Nothing is re-checked once a quest completes, which matters most for the follow and the profile checks. See [Verification](/docs/quests/templates#verification).
# YouTube (/docs/quests/templates/social/youtube)
Neither live template asks the fan to link a YouTube account, so both record the click. Subscribe and like were withdrawn and are not coming back.
| Template | Status | The fan | You configure |
| ------------- | --------------------- | ----------------------------------------- | ----------------------------------------- |
| Visit channel | Live | Opens your channel, comes back, completes | Page URL and the handle shown on the card |
| Watch video | Live | Opens your video, comes back, completes | Page URL and the handle shown on the card |
| Subscribe | Withdrawn | | |
| Like | Withdrawn | | |
## Visit channel and watch video [#visit-channel-and-watch-video]
Both work like any other visit template. The fan taps through, the link opens in a new tab, and the complete button turns on when they come back.
Partners use these templates to drive a spike of traffic to a video in its first hours, the window that matters most to YouTube's own ranking.
## The withdrawn templates [#the-withdrawn-templates]
The scopes YouTube requires to verify that a specific fan subscribed to a channel, or liked a video, are wide enough that no reward on a quest board justifies them.
The templates stay in the catalogue and cannot be published.
## The workaround [#the-workaround]
Use a **visit channel** or **watch video** quest and ask for the like in the description.
Partners running this pattern found that a meaningful share of fans do the thing the description asks for, even though nothing checks it. Write the description as the instruction and be specific: "Watch the video and drop a like" does better than "Check out our new video".