Counting invites

Know who invited whom, reward your best recruiters with roles, and run invite contests.

Crow Tools remembers who invited each new member. Your members see how many people they brought in, compare themselves in a leaderboard, and you can reward the best recruiters with roles. Crow Tools answers in French: this guide quotes its messages as they appear.

In short

Give the bot the Administrator permission.
Your members type ;invite to see their invites, ;leaderboard invite for the leaderboard.
;role invite add @Recruiter 10: the @Recruiter role is given at 10 invites.

What the bot counts

When a member arrives, the bot finds the invite they used and credits whoever created it. For each member, it keeps four counters:

join: the people they invited;
leave: those who have left since;
bonus: invites added or removed by an administrator (see below);
invalide (invalid): arrivals of accounts that are too new, if you turned it on (see below).

A member's total is their joins, minus their leaves, plus their bonus. Invalid invites don't count towards the total.

Some arrivals are credited to no one:

those through the server's custom link (discord.gg/your-server): ;list vanity lists them separately;
those where the bot can't tell which invite was used, for instance during a wave of simultaneous arrivals.

The conditions

The bot only counts invites on the servers in its whitelist, and only if it has the Administrator permission. Arrivals from before it was turned on aren't counted.

Seeing the invites

These commands are public: your members use them in the public channels.

;invite shows your invites (;invite @member someone else's): the total and the details, and how many are missing for the next invite role;
;leaderboard invite shows the server's leaderboard, 10 per page;
;list invite @member lists the people a member invited, with the date, and whether they're still here or when they left;
;list join @member traces a member's comings and goings on the server, and who invited them each time;
;list vanity lists the arrivals through the server's custom link, and how many of these members are still here.

Invalid invites

An account created the day before to boost a friend's score? ;fakelimit 7j counts as invalid any arrival of an account created less than 7 days ago. Write the duration in s, m, h or j/d (days): ;fakelimit 12h, ;fakelimit 30d; ;fakelimit off turns the check off.

Quick comings and goings

Some members join and leave right away. With ;safejoin 30 (owners), the bot waits 30 seconds before counting an arrival: if the member has left in the meantime, nothing is counted, and neither the arrival nor the departure message is sent. The arrival message is delayed by as much.

The wait goes up to 300 seconds; ;safejoin 0 turns it off. The setting applies to all of the bot's servers.

Managing invites

For administrators:

;manageinvite add 5 @member adds 5 bonus invites to a member, ;manageinvite del 5 @member removes some;
;manageinvite reset @member resets their invites to zero;
;manageinvite resetall resets every member's invites, after a confirmation.

When a member leaves the server, their own invites are kept for when they come back. With ;leavereset invite on, they lose them when leaving; ;leavereset invite off goes back to the default.

;settings invite sums up the settings of invites and of arrival and departure messages.

Rewarding with roles

;role invite add @Recruiter 10: the @Recruiter role is given automatically at 10 invites;
;role invite del @Recruiter removes this reward;
;role invite list shows the invite roles;
;role invite cumul on: members keep every role they earned; with off, they only keep the highest. This setting also applies to the contest roles;
;role invite sync (owners) brings every member's roles up to date, useful after a change; it can take a while.

Roles follow the total: if invited members leave, the member can lose a role. The role must be below the bot's role in the role list, and below your own highest role.

Invite contests

For a contest ("the best recruiter of the month wins…"), the bot keeps a second counter, the event invites. It counts exactly like the first one, but you reset it at the start of each contest, without touching the all-time invites.

;manageevent resetall resets the contest counter: the contest starts.
Your members follow their score with ;event (or ;event @member) and the leaderboard with ;leaderboard event.
At the end, the leaderboard gives the winners.

The rest works like invites:

;manageevent add, del and reset manage a member's event invites;
;role event add @Champion 20, del, list and sync: roles given according to the contest score;
;leavereset event on: a member who leaves the server loses their event invites.

If it doesn't work

Nobody has any invites: check that the bot has the Administrator permission and that the server is in the whitelist.
An arrival is credited to no one: the member came through the server's custom link (;list vanity), or the bot couldn't tell which invite was used.
An invite role isn't given: move the bot's role above this role, then run ;role invite sync.
"Vous devez ajouter ce serveur à la whitelist" (you must add this server to the whitelist): use ;wl add.

Every command

Each command of this guide, with its arguments and who can use it: Invites (in French).