# Criminal

- [Overview](https://docs.criminal.work/index.md): Criminal is a Discord bot with 169 commands across 21 categories, configured per server through /config.
- [Before you begin](https://docs.criminal.work/before-you-begin.md): Invite Criminal, enable the right intents and arm the moderation stack in five minutes.
- [Add Criminal](https://docs.criminal.work/invite.md): The invite link, both install types, and the permissions the bot needs.
- [Quick Start](https://docs.criminal.work/quickstart.md): The five commands that turn a bare install into a moderated server.
- [Moderation](https://docs.criminal.work/features/moderation.md): Bans, softbans, timeouts, jail, warnings and purge — every action becomes a numbered case.
- [AutoMod](https://docs.criminal.work/features/automod.md): Invites, links, caps, mass mentions, spam and filtered words · all off until you turn them on.
- [Honeypot](https://docs.criminal.work/features/honeypot.md): A trap channel nobody has a reason to post in · anyone who does gets punished on the spot.
- [Server Logs](https://docs.criminal.work/features/logging.md): Every message, member, thread, voice and permission event in one channel.
- [Overview](https://docs.criminal.work/features/messages/index.md): Every automatic message Criminal can send, and the settings behind each one.
- [Welcome Message](https://docs.criminal.work/features/messages/welcome.md): Greet every member who joins, with a template or an embed script.
- [Goodbye Message](https://docs.criminal.work/features/messages/goodbye.md): Say something when a member leaves or is removed.
- [Boost Message](https://docs.criminal.work/features/messages/boost.md): Thank members the moment they boost the server.
- [Level-up Messages](https://docs.criminal.work/features/messages/levelup.md): Announce levels in chat and congratulate members in DMs.
- [Vanity Message](https://docs.criminal.work/features/messages/vanity.md): Announce members who start showing your invite in their status.
- [Overview](https://docs.criminal.work/features/triggers/index.md): Keyword triggers that reply or react whenever a word is said.
- [Message Triggers](https://docs.criminal.work/features/triggers/message.md): Reply with a canned line whenever a keyword appears.
- [Reaction Triggers](https://docs.criminal.work/features/triggers/reaction.md): Add an emoji automatically when a keyword is said.
- [Overview](https://docs.criminal.work/features/events/index.md): Everything Criminal does on its own when something happens in the server.
- [Prompt Reactions](https://docs.criminal.work/features/events/prompts.md): y/n becomes 👍👎, v/s becomes ⬅️➡️ · automatically.
- [Mentions & AFK](https://docs.criminal.work/features/events/mentions.md): A reply when you're pinged, and automatic AFK handling.
- [Member Events](https://docs.criminal.work/features/events/members.md): What happens on join, leave, boost, ban and member updates.
- [Message Events](https://docs.criminal.work/features/events/messages.md): Deletions, edits, snipes and everything Criminal notices about chat.
- [Server Events](https://docs.criminal.work/features/events/server.md): Channel, role and guild changes Criminal records.
- [Overview](https://docs.criminal.work/features/variables/index.md): Every variable an embed script or message template can use.
- [User](https://docs.criminal.work/features/variables/user.md): The member a message is about · identity, avatar, dates and roles.
- [Server](https://docs.criminal.work/features/variables/server.md): Guild name, branding, owner, boosts and creation date.
- [Channel](https://docs.criminal.work/features/variables/channel.md): The channel a message is posted in or about.
- [Bot](https://docs.criminal.work/features/variables/bot.md): Criminal's own name, ID and avatar.
- [Time](https://docs.criminal.work/features/variables/time.md): Current time, timestamps and date formats.
- [Level-up](https://docs.criminal.work/features/variables/levelup.md): Variables that only resolve inside level-up messages.
- [Honeypot](https://docs.criminal.work/features/variables/honeypot.md): Variables for the trap-channel warning and trigger DM.
- [Role Management](https://docs.criminal.work/features/roles/index.md): Grant and strip roles, build a self-service panel, and find the right role page.
- [Vanity Roles](https://docs.criminal.work/features/roles/vanity.md): Members who put your invite in their custom status get a role · automatically.
- [Booster Roles](https://docs.criminal.work/features/roles/booster.md): One personal role per booster, with colour, icon and sharing.
- [Reaction Roles](https://docs.criminal.work/features/roles/reaction.md): Bind roles to reactions or buttons · bindings survive restarts and message reloads.
- [Levels](https://docs.criminal.work/features/engagement/levels.md): Message XP, a rank card, a leaderboard and role rewards · off until you enable it.
- [Sob Board](https://docs.criminal.work/features/engagement/sob-board.md): A starboard driven by crying-emoji reactions, with live counts and author stats.
- [Suggestions](https://docs.criminal.work/features/engagement/suggestions.md): Members post ideas, everyone votes, staff deliver a verdict with a reason.
- [Giveaways](https://docs.criminal.work/features/engagement/giveaways.md): Timed draws with a persistent Enter button, role gates and auditable entries.
- [Profile Cards](https://docs.criminal.work/features/profile/cards.md): Rendered profile cards, per-user customisation and how the card is drawn.
- [Roblox Profile](https://docs.criminal.work/features/profile/roblox.md): Look up a Roblox account and render its profile card.
- [Overview](https://docs.criminal.work/features/social/index.md): Announce new videos, posts, pins, tracks and streams from seven platforms.
- [YouTube](https://docs.criminal.work/features/social/youtube.md): Announce new videos and Shorts from a channel.
- [Reddit](https://docs.criminal.work/features/social/reddit.md): Follow a subreddit or a user and post what they publish.
- [X (Twitter)](https://docs.criminal.work/features/social/x.md): Announce new tweets and quote tweets from an account.
- [Twitch](https://docs.criminal.work/features/social/twitch.md): Post a live alert when a streamer goes live.
- [Kick](https://docs.criminal.work/features/social/kick.md): Post a live alert when a Kick streamer goes live.
- [SoundCloud](https://docs.criminal.work/features/social/soundcloud.md): Announce new tracks from an artist or profile.
- [Pinterest](https://docs.criminal.work/features/social/pinterest.md): Announce new pins from a profile.
- [Embeds](https://docs.criminal.work/features/embeds.md): Build messages with the interactive builder or with embed scripts, using the same variables everywhere.
- [Last.fm & Lyrics](https://docs.criminal.work/features/lastfm.md): Link an account, read scrobbles and charts, and pull lyrics.
- [Names](https://docs.criminal.work/features/names.md): Username, display-name and nickname history · visible to everyone, clearable only by you.
- [Utility](https://docs.criminal.work/features/utility.md): Polls, AFK, snipes, reminders, sticky messages and other daily-driver tools.
- [Fun & Games](https://docs.criminal.work/features/fun.md): Coinflips, the magic 8-ball, quote cards and three button-driven games.
- [Information](https://docs.criminal.work/features/information.md): Server, user, role, invite and permission lookups · plus the ones only staff need.
- [Command Reference](https://docs.criminal.work/commands/index.md): 169 commands across 21 categories · the whole map, grouped the way /help groups it.
- [Slash & Prefix](https://docs.criminal.work/commands/slash-commands.md): How Criminal's two command surfaces differ, and what to expect in Discord.
- [Configuration](https://docs.criminal.work/configuration/config.md): Every per-server setting, edited through one command.
- [Setup](https://docs.criminal.work/configuration/setup.md): /setup mute and /setup jail build the roles and permissions the moderation modules expect.
- [Permissions](https://docs.criminal.work/configuration/permissions.md): What Criminal needs, what it checks per command, and why role hierarchy decides everything.
- [FAQ](https://docs.criminal.work/resources/faq.md): How to punish someone, hand out roles, run a giveaway, fix levels and find your way around.
- [Troubleshooting](https://docs.criminal.work/resources/troubleshooting.md): The problems people actually hit · permissions, missing roles, quiet modules and late feeds.
- [Support](https://docs.criminal.work/resources/support.md): Where to get help with Criminal and how to report a problem.


This documentation is built and hosted on [Mintlify](https://mintlify.com), a developer documentation platform.