PureXit Documentation
Everything you need to install, configure and operate PureXit. If you can't find an answer here, join the support server.
Getting Started
PureXit is a complete Discord management platform. The typical setup takes a few minutes:
- Invite the bot using the Add to Discord button. You'll pick a server where you have Manage Server permission.
- Sign in to the dashboard with Discord. Only servers where PureXit is installed and you have management permissions will appear.
- Open your server, enable the modules you need, and set your logging channels.
$ prefix and slash commands. All configuration made in the dashboard applies immediately — no restarts.
Installation
The invite link requests the permissions PureXit needs for full functionality: managing roles, channels, messages, bans, timeouts, webhooks and voice. You can trim permissions afterwards, but security and moderation features degrade without them.
Required Discord settings
- Place the PureXit role above the roles it should be able to moderate.
- Keep View Audit Log enabled — anti-nuke relies on it to identify actors.
Dashboard
The dashboard at /servers lists your eligible servers. A server is eligible when both are true:
- PureXit is installed on the server, and
- you are the owner, an Administrator, or have Manage Server permission.
Both conditions are verified server-side on every request. Changing a server ID in the URL will not expose another server's configuration.
Each server dashboard contains: Overview, Moderation, Security, AutoMod, Welcome, Roles, Tickets, Giveaways, Leveling, Music, Voice, Logging, Automation, Custom Commands, Analytics, Permissions and Bot Settings.
Moderation
Every moderation action creates a numbered case with moderator, reason, duration and timestamp.
| Command | Description |
|---|---|
$ban @user [reason] | Ban a member |
$kick @user [reason] | Kick a member |
$timeout @user 2h [reason] | Timeout a member |
$warn @user [reason] | Issue a warning |
$purge 50 | Bulk delete messages |
$cases @user | View a member's case history |
Cases can also be created from the dashboard's Moderation page, which supports filtering by user, moderator, action type and free-text search.
Security
The security module has three layers:
- Anti-Nuke — watches for destructive bursts (mass bans/kicks, channel or role deletion, webhook spam). When a threshold is exceeded, the configured response runs automatically: ban, kick or strip roles from the actor.
- Anti-Raid — monitors join velocity and account age; can enable lockdown automatically.
- Trusted users — members exempt from anti-nuke enforcement. Keep this list short.
AutoMod
AutoMod rules run on every message. Each rule defines a condition, scope and action:
| Rule | Detects |
|---|---|
| Anti-Invite | Discord invite links |
| Anti-Link | URLs (with allowlist support) |
| Bad Words | Your prohibited word list |
| Anti-Caps | Excessive capital letters |
| Anti-Spam | Rapid repeated messages |
Configure exempt channels and roles per rule from the dashboard. Actions include delete, warn, timeout and log.
Tickets
Set a ticket category and log channel, then post a ticket panel. Members open tickets with a button; staff can claim, add/remove members, and close with a transcript saved to the log channel. Ticket statistics appear in the dashboard.
Giveaways
Create giveaways with $gstart <duration> <winners> <prize> or from the dashboard. Supports role requirements, minimum account age, rerolls ($greroll) and early ending ($gend). Active and past giveaways are listed in the dashboard.
Leveling
Members earn XP for activity. Configure XP rates, cooldowns, multipliers, excluded channels/roles, level-up announcements and role rewards. $rank shows a member's rank card; $lb shows the leaderboard.
Music & Voice
Play from names or URLs with $play. Queue, skip, pause, volume, shuffle, loop and audio filters are available as commands and from the dashboard's live music panel.
Join-to-Create: designate a hub voice channel; joining it creates a personal room the owner can rename, lock, hide or limit. Rooms clean up automatically when empty.
Automation
Workflows follow a trigger → condition → action model:
Trigger: Member joins
Condition: Account age > 7 days
Action: Assign @Member role, send welcome message, log event
Available triggers: member join/leave, level reached, ticket created, message keyword, schedule. Actions: send message, assign/remove role, send DM, log event, create channel.
Custom Commands
Create commands and auto-responses without code from the dashboard. Choose a trigger style (command, exact match, contains), response type (text or embed), and optional restrictions: channels, roles, cooldowns. Variables like {user}, {server} and {count} are substituted at runtime.
Configuration
All settings are stored per-server in PureXit's database and read live by the bot. Dashboard changes take effect immediately. Bot Settings covers language, timezone, embed styling, module enable/disable switches and notification behavior.
Permissions
Two layers of permission control apply to the dashboard:
- Discord permissions — you must be owner, Administrator or have Manage Server to open a server's dashboard at all. This is always enforced and can never be bypassed.
- Module permissions — server owners can additionally restrict specific dashboard modules to specific Discord roles. These restrictions only narrow access; they never grant access beyond Discord's own permission model.
API
PureXit exposes a small public telemetry API. All other endpoints require an authenticated dashboard session and are authorized per-guild.
| Endpoint | Description |
|---|---|
GET /api/status | Live component health (public) |
GET /api/stats | Aggregate bot statistics (public) |
GET /api/commands | Command catalog (public) |
FAQ
Why don't I see my server in the dashboard?
Either PureXit isn't installed there, or you don't have Manage Server permission. Servers you manage where the bot is missing appear under "Add PureXit" instead.
Does the dashboard need my Discord password?
No. Sign-in uses Discord OAuth2 with only the identify and guilds scopes. PureXit never sees your password and cannot act on your account.
Do changes require a bot restart?
No. Configuration is read live from the database.
How do I remove my data?
Kick the bot and contact us in the support server for full data deletion, or see the privacy policy.
Troubleshooting
- Bot doesn't respond to commands — check the bot's role can view and send in the channel, and that the channel isn't in the ignore list.
- Moderation actions fail — the PureXit role must be higher than the target member's highest role.
- Anti-nuke didn't trigger — verify the actor isn't on the trusted list and thresholds are configured.
- Music won't play — check the status page for audio node availability.
- Dashboard session expired — sign in again; sessions last seven days and refresh Discord access automatically while valid.
Changelog
3.0
- Complete web platform: new public site, secure OAuth flow, per-server dashboards.
- Server-side authorization on every API operation, module-level role permissions, full audit logging.
- Live music controls, automation builder, custom command editor and analytics in the dashboard.
2.x
- 24 feature cogs: moderation, security, automod, music, tickets, giveaways, leveling, automation and more.
- Dual-engine storage (MongoDB pool + SQLite) and Lavalink audio node pool.