SnippetBan¶
The snippetban command (also available as sb) allows server moderators to restrict a member's ability to use Tux's snippet creation and management features. This is useful for dealing with members who abuse snippets by creating duplicates, irrelevant content, or violating server rules through snippets.
Syntax¶
The snippetban command can be used in two ways:
Slash Command:
/snippetban member:@user [reason:STRING] [silent:true/false]
Prefix Command:
$snippetban @user [reason] [-silent]
Aliases:
sb
Parameters¶
| Parameter | Type | Required | Description |
|---|---|---|---|
member |
Member | Yes | The member to restrict from using snippets. |
Flags¶
This command supports the following flags:
| Flag | Type | Default | Description |
|---|---|---|---|
reason |
String | No reason provided | The reason for the snippet ban (positional). |
-silent |
Boolean | False | If true, Tux will not attempt to DM the user. |
reason¶
The reason for the snippet restriction, logged in the moderation case and included in the DM notification. In the prefix command, this is a positional flag. In slash commands, it is a standard argument.
- Type: String
- Default: "No reason provided"
-silent¶
Whether to suppress the DM notification to the restricted user.
- Type: Boolean
- Default: False
- Aliases:
-s,-quiet
Permissions¶
Bot Permissions¶
Tux requires no special Discord permissions for this command, as it is handled internally via its database.
User Permissions¶
Users need appropriate moderation permissions to use this command.
Permission System
Command permissions are configured per-guild using Tux's dynamic permission system. Configure via /config commands or see the Permission Configuration guide.
Usage Examples¶
Basic Snippet Ban¶
Preventing a member from creating snippets.
/snippetban member:@user reason:"Spamming"
With Reason¶
$snippetban @user Creation of multiple spam snippets
Response¶
When executed successfully, Tux will:
- Update its internal database to mark the user as snippet-banned.
- Attempt to DM the user informing them they can no longer create or manage snippets (unless
-silentis used). - Create a new moderation case for the snippet ban.
- Post a confirmation message in the current channel.
- Log the action in the designated moderation log channel.
Error Handling¶
Common Errors¶
Error: Lacking Permission Rank¶
When it occurs: Your internal Tux permission rank is lower than what's required to use this command.
Solution: Contact a server administrator to check your rank.
Error: User Already Snippet Banned¶
When it occurs: The target user is already restricted from creating snippets.
Solution: No action needed, or use /snippetunban to restore their access.
Related Commands¶
/snippetunban- Restore a member's ability to create snippets./cases- View the moderation history for snippet bans.