Vanity & Server Tags

​

What it can do

• Match a member’s Custom Status text or profile name and manage a role.
• Match the Server Tag a member wears (its server, its text, or whether they show one) and manage a role.
• Keep a role safe when several rules use it, and never take away a role someone was given by hand.
• Thank the member in a channel when a rule starts matching, with a saved embed from Embeds (classic or V2) if you like.
• Log every role the rules add or remove, with a Petto card or a saved embed for each kind of entry.
• Check everyone at once with a live progress bar.

​

First-time setup

1. Give Petto Manage Roles and move its role above every role a rule should add or remove (Server Settings → Roles). Discord rejects a role change otherwise.
2. Custom Status rules need Petto’s Presence Intent, which is already on.
3. Create a rule, then check it with !vanity test and apply it with !vanity sync.

​

Vanity rules

​

Sources

​

Create a rule

!vanity add cinnamochi cinnamochi @Rep
!vanity add cinnamochi cinnamochi @Rep --source custom_status --comparison contains --action add_role

• name: a short name for the rule (letters, numbers, - and _);
• word: the text to look for (up to 200 characters);
• role: the role the rule manages;
• source: where to look (default custom_status);
• comparison: equals, contains (default), starts_with, ends_with or regex;
• action: add_role (default) or remove_role.

​

Other commands

!vanity list

!vanity edit

!vanity remove

!vanity test

!vanity sync

!vanity sync <user>

!vanity offline

​

When a member goes offline

• remove (the default): when Discord says the member went offline, Petto takes the role away. It gives it back when they are online with a matching Custom Status, and it thanks them again.
• keep: the member keeps the role until they are online again, and it only goes when Petto sees the status stop matching.

​

Server Tag rules

!guildtag add partner is_guild_id @Partner 707307527846625280
!guildtag add shows-tag identity_enabled @Tagged

​

How roles stay safe

• A role stays while at least one add rule matches and no remove rule does (a remove rule always wins).
• Petto only takes a role away if it remembers adding it itself. A role someone gave by hand is never removed, even if a rule later matches and stops matching.
• If the bot cannot read a value right now (the Custom Status of someone who is offline or invisible, because Discord hides it, or someone it has no presence for), the rule leaves their role as it is instead of treating it as empty. The role is only taken away when they are online and the status no longer matches.
• Bots are never changed.
• Several rules can manage the same role: it is one role. It stays while at least one add rule matches, goes when none does (and no remove rule matches), and the member is thanked once for each source (Vanity and Server Tag), not once per rule. A role that both a Vanity rule and a Server Tag rule manage is still one role.

​

Thank-you messages

!vanity notify #thanks
!vanity notify #thanks my-embed none
!guildtag notify #tags
!vanity notify-off

!vanity notify #thanks

!vanity notify #thanks my-embed none

!guildtag notify #tags

!vanity notify-off

​

Log of role changes

!identity logs #staff-log
!identity log-event vanity_add false
!identity log-embed tag_add my-embed
!identity logs-off

!identity logs

!identity log-event

!identity log-embed

!identity logs-off

​

Variables for the messages

{vanity.rule} {vanity.word} {vanity.source} {vanity.value} {vanity.role}
{tag} {tag.rule} {tag.condition} {tag.rule_value} {tag.guild_id} {tag.enabled} {tag.badge} {tag.role}
{rule.name} {rule.source} {rule.value} {rule.condition} {rule.reason} {rule.role} {rule.role_id}
{rule.action} {rule.action_text} {rule.result} {rule.error} {rule.matched_value} {rule.event} {rule.event_title}

​

Roles that come back

​

Coming from the Vanity bot

​

Troubleshooting

​

The role is not added

1. Petto has Manage Roles and its role is above the target role.
2. The right source was chosen (custom_status is not the username).
3. The text matches the comparison. Try !vanity test @member.
4. Run !vanity sync after changing a rule.

​

The role is not taken away

1. The server may be set to keep (!vanity offline): then a member who is offline or invisible keeps the role, because Discord hides their Custom Status. Use !vanity offline remove (the default) if you want it to go when they go offline.
2. Petto only takes away roles it gave itself. A role someone gave by hand stays.
3. If another rule that manages the same role still matches, the role stays. Check with !vanity test @member.

​

The thank-you message does not arrive

​

The Server Tag looks empty or late