First five minutes
Provision the roles and channels Righteous expects, then open the config panel and turn on what your server needs.
Righteous does almost nothing useful until it has a mute role, a jail role, and somewhere to write
logs. ,setup creates those for you, and
,config is where you change everything afterwards. Two
commands in that order, and the rest of the bot becomes configurable.
Both need Administrator, on you and on the bot.
Provision the roles and channels
Open the picker
Run ,setup with no arguments, or /setup run. A card
appears listing everything the command can create, with each item's current state beside it.
Choose what to create
Anything not already present is pre-selected, so the default selection is the dry run.
Deselect what you'd rather make yourself. The list covers the Muted role, the jailed role
with its #jailchat, #welcome, #starboard, and a channel for each logging category —
message, member, server, voice and staff.
Decide where the log channels go
The Put log channels in a private Logs category button is on by default, which puts them in
their own private logs category. Turn it off and they're created at the top level instead.
Run it
Press Run Setup. Creating the Muted and jailed roles applies a permission overwrite to
every channel you have, so a large server takes a moment. Let it finish.
Read the report
Every item comes back as created, already present, or failed. A failure is nearly always a missing permission or the bot's role sitting too low. Fix that and run it again.
The slash form is private, the prefix form isn't
/setup run opens the card as an ephemeral reply only you can see. ,setup posts a normal
message, so anyone who can read the channel can read the card. Neither form lets a
non-administrator press the buttons.
Running it a second time repairs rather than duplicates. An item counts as present only if the
stored role or channel still exists, so deleting #welcome means the next run recreates it and
stores the new one.
Three variants are worth knowing:
| Command | What it does |
|---|---|
,setup preview | Reports the current state and changes nothing at all |
,setup all | Provisions everything at once, with no picker |
,setup update | Re-applies the jail and mute overwrites without creating anything |
Reach for ,setup update after adding channels to a
server that was already set up. New channels don't inherit the mute and jail overwrites on their own.
Open the config panel
,config opens it, and so do the aliases ,settings,
,configuration and ,setting. On slash it's
/config panel. Any unrecognised ,config spelling
opens it too, so a half-remembered subcommand still lands somewhere useful.
The dropdown at the bottom moves between pages. What each one controls:
| Page | Controls |
|---|---|
| Overview | Everything at a glance, plus the prefix |
| Roles & Jail | Mute role, jail role, jail channel |
| Logging & Welcome | Log and welcome channels, plus the welcome, leave, delete and edit log toggles |
| Snipe & Spam | Snipe filters and anti-spam toggles |
| Starboard · Clownboard | Channel, threshold, colour and emoji for each board |
| Tickets | A pointer to ,ticket panel, where tickets are really configured |
| VoiceMaster · VM Defaults | Join-to-create channel, category and panel, then default name, bitrate, region and join role |
| Music | DJ role, vote-skip, 24/7 |
| Premium | Booster colours and status roles |
| Server Stats | Member and boost count channels |
| Trap | Punishments, DMs, counter and gates |
| Messages | Welcome, goodbye, boost, unboost and join-DM messages |
| Antiraid · Antinuke | Join-rate and alt-account controls, then per-action anti-nuke rules |
| Social Links | Per-platform link reposting and auto-delete |
| Last.fm | Server-wide Last.fm settings |
| Giveaways | Ping role, host role, log channel, entry mode |
| Autorole | Roles given on join, and role history on rejoin |
Three things about the panel aren't obvious:
It's a normal message in the channel. Anyone who can read the channel sees the panel and its current values, so open it somewhere staff-only. Permissions are checked when a control is used, not when the panel is drawn, so someone without the right permission gets a private refusal rather than a greyed-out button.
Deselecting everything in a dropdown clears that field. Discord populates role and channel dropdowns itself, so there's no "None" option to pick. An empty selection is how you unset a value.
A setting pointing at something you deleted shows as deleted and ignored. That's the panel telling you to set it again, not an error.
Set your prefix
Optional, and worth doing early if you're going to do it at all. People memorise a prefix fast, and changing it later means re-teaching everyone.
Change it on the panel's Overview page, or with
,prefix set <prefix>. That needs Manage Server.
,prefix list shows every prefix the server accepts,
and ,prefix reset puts it back to the default. Both
need Manage Server too.
Slash commands are unaffected by any of this. /help works whatever your server's prefix is, which
makes it the safer thing to put in your own staff instructions.
Turn on what your server needs
None of this is on by default and none of it is required. Start with whichever line describes a problem you actually have.
| You want | Start here |
|---|---|
| Protection against a compromised admin | ,antinuke — configured by the server owner, and needs View Audit Log on the bot to detect anything |
| Protection against a join raid | ,antiraid |
| Automatic punishment of spam bots | ,trap |
| Word, link or invite filtering | ,filter |
Logging beyond what ,setup created | ,log |
| A support ticket system | ,ticket |
| Custom welcome and goodbye messages | ,welcomemessage |
| A role handed out automatically on join | ,autorole |
| A button members press to verify themselves | ,verification |
| Temporary voice channels members own | ,voicemaster |
| A starboard for messages people react to | ,starboard |
| Giveaways | ,giveaway |
| XP and levels | ,levels |
| Now-playing, WhoKnows and charts | ,lastfm set <username> |
Welcome, goodbye, boost and join-DM messages have two surfaces. The panel's Messages page edits
them all in one place, and each also has its own command —
,welcomemessage,
,goodbyemessage and
,boostmessage. Either way they take the same
embed-code syntax as the rest of the bot, so you can write a full embed instead of a line of text.
Common issues
,setup says an item is already present, but you can't see it. The stored role or channel
exists and the bot can see it, so you're probably missing View Channel on it. Look in Server
Settings → Channels rather than the sidebar.
Setup reports an item as failed. Almost always the bot's own permissions. It needs Manage Roles
for the Muted and jailed roles, and Manage Channels for the rest. Grant them and re-run — the
successful items are skipped the second time.
An old panel opens on the wrong page. Close it and run
,config again. Reopening rebuilds it from scratch.
Someone with Administrator gets refused by a panel control. A few controls are restricted beyond Administrator, and some need Server Premium. The refusal names which one, and it's private, so only the person clicking sees it.