ClemBot Documentation

website·Indexed 30 days ago

https://docs.clembot.io/

Documentation for ClemBot, a modular and configurable Discord bot. Includes guides on moderation tools such as banning, muting, and warning; role management via auto-assigned and user-assignable roles; and utility features like custom prefixes, tags, emote boards, and designated channels.

Tokens
5.4K
Snippets
46
Records
66
Agent score
59%

What's inside ClemBot

  1. Overview of ClemBot Authorization Claims

    Claims are granular permissions assigned to Discord roles to control access to specific ClemBot features. By default, server owners and users with the Discord 'Administrator' permission have full access to all bot functionality. For other users, access is granted if they possess a role that has the corresponding claim associated with it. A single role can have multiple claims, and a single claim can be assigned to multiple roles.
  2. Overview of ClemBot Mute functionality

    Mutes in ClemBot silence a specific individual, preventing them from sending messages or joining voice channels for a designated period of time.
  3. Overview of ClemBot Command Restrictions

    ClemBot allows administrators and moderators to block specific commands server-wide or in specific channels. When a command is disabled, the bot can either notify the user that the command is disabled or silently ignore the request. Both top-level commands (e.g., claims) and sub-commands (e.g., claims add) can be restricted.
  4. Overview of ClemBot Emote Boards

    Emote Boards are customizable systems that automatically repost messages to designated channels once they reach a specific threshold of valid reactions. Key features include:

    • Support for multiple boards per server with no limit.
    • Compatibility with both Unicode and custom emotes.
    • Ability to repost to multiple channels per board.
    • Message persistence: edited messages are updated and deleted messages are removed from the board.
    • Leaderboards for popular posts and top users.
    • Configurable reaction thresholds and bot-post permissions.

    Note: Reactions added by the message author are invalid and do not count toward the threshold.

  5. Overview of ClemBot Welcome Messages

    Welcome messages are automated direct messages (DMs) that ClemBot sends to every member who joins a server. They are typically used to greet new users, provide server rules, or share necessary setup instructions.
  6. Overview of ClemBot Tags

    Tags are custom commands that allow users to create custom responses. When a tag is invoked, ClemBot responds with the tag's content in the current channel. Tags support ownership: the creator owns the tag and can edit or delete it. If an owner leaves the server, their tags become unclaimed and can be claimed by other users.
  7. Get tag information and search

    Retrieve metadata about a tag (such as owner, creation date, and usage count) or search for tags using a query.
    # Get info about a tag
    !tag info <TagName>
    # Search for tags
    !tag search <query>
    # Example
    !tag find my_tag
  8. Manage bot permissions using Claims

    ClemBot manages access to its functionality through 'Claims'. Claims are granted to moderator or admin roles to enable specific bot features. They can be added to or removed from roles arbitrarily.
  9. Configure logging channels using Designated Channels

    ClemBot uses 'Designated Channels' to route specific server events to designated Discord channels. You can assign multiple designations to a single channel, or the same designation to multiple channels.

    Available designations include:

    • message_log: Logs all message edits and deletions. Note: ClemBot stores message content for 30 days to enable this; edits/deletions of messages older than 30 days will be logged, but the original content will not be available.
    • moderation_log: Logs all moderation actions occurring in the server.
    • user_join_log: Logs users joining the server.
    • user_leave_log: Logs users leaving the server.
  10. View Emote Board details and leaderboards

    Retrieve information about existing boards or view the top 5 entries for Popular Posts, Number of Posts, or Number of Reactions.
    # List boards or get details for a specific board
    !emoteboard [board name | emote]
    # Example: !emoteboard starboard
    
    # View leaderboards
    !emoteboard leaderboard [board name | emote]
    # Example: !emoteboard leaderboard ⭐
  11. Invoke tags using inline notation

    Tags can be triggered in the middle of a message by prefixing the tag name with the server's tag prefix (default is $). This allows for organic usage within a conversation.
    Hello there, new person. Have you checked out $funstufftodohere yet?
  12. Unban a user from a Discord server

    To undo a ban, navigate to the server/guild settings, go to the Moderation group, select the Bans tab, choose the specific user, and click the Revoke Ban button.