Documentation

Getting Started

This guide walks you through the full setup, from inviting the bot to running your first real gearcheck. The whole process takes about 10 minutes if you use a template pack, or a bit longer if you want to build everything from scratch.

1. Invite the Bot

Click the Invite Bot button on the homepage or use the invite link your server admin shared. The bot will ask for a few permissions during setup:

  • Manage Roles so it can assign verified roles automatically when someone passes a gearcheck.
  • Manage Threads so it can create and manage gearcheck threads in your designated channels.
  • Send Messages / Embeds for the dashboards, score breakdowns, and status updates inside threads.
  • Read Message History so it can find and process screenshots posted in threads.
  • Attach Files for exporting packs and sharing score reports.

You need Manage Server permission in your Discord server to invite the bot.

2. Get Oriented

Once the bot is in your server, you have two ways to get started:

Discord Commands

Run /guide setup to get a step-by-step walkthrough right inside Discord. It covers everything on this page and links to the right commands as you go.

Web Dashboard

Sign in on the dashboard to manage builds visually, view analytics, and configure settings without typing commands. The dashboard becomes more powerful on paid tiers.

3. Install a Template or Build From Scratch

Builds are the gear specs your members need to match. You have two options here:

Option A: Install a Template Pack

Template packs are pre-built gear specs curated for specific games and activities. If your game has a template available, this is the fastest way to get going.

/pack install-template template:new_world_mutations

Template installation requires the Subscriber or Premium tier. On the Free tier, you can build everything manually.

Option B: Build From Scratch

Start by creating a build, then add categories and items to it. This gives you total control over what gets checked.

Create a build under the "Raids" activity

/pack create-build name:Tank Build activity:raids

Add a category for weapons

/pack add-category build:tank-build name:Weapons

Add an item to that category

/pack add-item build:tank-build category:weapons name:Sword and Shield aliases:SnS,Sword & Shield

Check the Build System docs for the full breakdown of categories, items, aliases, weights, and thresholds.

4. Set Up a Gearcheck Channel

Pick a channel in your server and tell the bot to use it for gearchecks. You need to specify which activity the channel is for, so the bot knows which builds to show.

/gearcheck setup activity:raids

After this, when someone creates a thread in that channel, the bot will post a dashboard with all the builds available for that activity. Members pick a build, upload their screenshots, and hit Continue.

You can set up multiple channels with different activities. For example, one channel for raid gearchecks and another for dungeon gearchecks.

5. Configure the Mod Role

By default, anyone with Manage Messages or Administrator permission can use mod commands (overrides, transfers, etc.). If you want to give mod access to a specific role instead, set it up:

/mod set-mod-role role:@Officers

6. Test Your Build

Before sending your members through the gearcheck, test it yourself. The /pack test command lets you paste some text and see how the scoring engine matches it against your build. This is how you verify that your aliases are right, your items are being detected, and the scores look reasonable.

/pack test build:tank-build text:Sword and Shield, Refreshing, Fortifying Shield Rush

The bot will show you exactly which items matched, which were close (maybe), and which were missed. If something isn't matching when it should, add more aliases to that item.

7. Run Your First Real Gearcheck

You're ready. Tell your members to head to the gearcheck channel, create a thread, and follow the dashboard prompts. Here's what happens from their perspective:

  1. 1They create a thread in the gearcheck channel.
  2. 2The bot posts a dashboard. They pick a build from the dropdown.
  3. 3They upload screenshots of their gear and click Continue.
  4. 4The bot OCR-reads the screenshots, scores them, and shows a full breakdown of matches, near-misses, and missing items.
  5. 5If the score hits the verified threshold, the bot assigns the verified role (if configured). If not, the member can try again with better screenshots or updated gear.

What's Next

Now that you're up and running, here are some things to explore: