Setting up the bot

Everything you need to get Ninth Bot working in your server, from the first /setup to a tested ticket panel. This page is for server admins.

Before you start

Ninth Bot is run by zVapor. Its commands only appear in servers that zVapor has set up for the bot, so if the bot is in your server but no commands show up, contact contact@ninthbot.site.

You need:

• The bot online in your member list.
• Manage Server or Administrator on your account.
• The bot's role placed above your staff roles and any roles it should hand out, so it can manage ticket channels and give auto-roles.

The bot's invite gives it View Channel, Send Messages, Embed Links, Attach Files, Read Message History, Manage Channels, Manage Roles, Manage Messages, Kick Members, Ban Members and Moderate Members. It does not get View Audit Log. Give its role View Audit Log yourself if you want the message log to show who deleted a message.

Create your channels first

Set these up in Discord before you open the panel. The names are only examples.

Keep the log, transcript and message log channels staff-only. The message log shows deleted message text. The bot adds your staff to each new ticket by itself, but it doesn't change who can see your log channels, so make sure your staff roles can view them.

The panel channel is the opposite: everyone who should be able to open a ticket needs to see it. The bot needs View Channel, Send Messages and Embed Links there to send the panel.

On the Tickets category, the bot needs View Channel, Manage Channels, Send Messages, Read Message History, Attach Files and Embed Links. It hides each new ticket from @everyone itself. Staff only use Add user and Remove user if the bot also has Manage Roles there.

Open the setup panel

Run this in any channel:

/setup

You get a private panel with a section menu, plus Back, Refresh and Close buttons. Only the admin who opened the panel can use it, and it expires after 15 minutes without use. Run /setup again if that happens.

• Back returns to the previous view.
• Refresh reloads the section. Use it after you change channels or roles in Discord while the panel is open.
• Close dismisses the panel.
• Guide, on most sections, opens the matching page of these docs.

Your permissions are checked again on every click, so if you lose Manage Server while the panel is open, it stops working for you.

Every change you make is posted to the mod log as a Setup changed entry, and shows up in the dashboard's settings history, where you can undo it.

Overview

A summary of every section: channels, roles, ticket categories, the reports category, auto-close times, welcome messages and logs. A Needs attention list warns you about problems, such as a log channel the bot can't post in, a deleted role, or a ticket category whose Discord category no longer exists.

Channels

Pick the Ticket log and Transcripts channels from the selects. Clear empties a slot.

Roles

• Ticket staff roles: members with these roles can handle tickets.
• Ticket admin roles: everything staff can do, plus taking over, unclaiming or closing a ticket someone else claimed.

Each select replaces the whole list, so deselect a role to remove it. You can pick up to 10 roles. @everyone and bot or integration roles can't be staff roles.

Tickets

• New category opens a form with a name, the Discord category to create ticket channels under, an optional category staff role, an optional extra field and up to 5 intake questions (one per line).
• The extra field takes up to four lines, in this order: description, emoji, cooldown in minutes, and the maximum open tickets per member. Its label reads description | emoji | cooldown | max_open.
• Edit and Delete appear when you pick a category from the menu.
• Reports category picks which ticket category report tickets open in.
• Inactivity sets the auto-close time and the warning time. New servers start at 48 hours, with a warning 12 hours before.
• Panel channel and Send panel post the ticket panel. See below.

You can have up to 25 ticket categories, and each needs its own name. See Tickets for limits and what each setting does.

A category that has ever had a ticket can't be deleted. If you try, the panel says "Something went wrong" and nothing changes. To stop offering it, send a new panel without it and delete the old panel message. Deleting the category you picked as the reports category also clears that setting, so new reports go to the mod log instead.

Welcome

Choose Join post, DM or Leave post, then use Turn on, Edit text, Images, Preview and Reset. Pick the welcome channel, the auto-roles for new members, and whether to ignore bots. See Welcome messages.

Moderation & logs

• Mod log and Message log channel selects, with Clear mod log and Clear message log.
• Message log ignores: up to 25 channels or categories the message log skips.
• Enable weekly summary or Disable weekly summary. It is on by default and needs a mod log channel.
• Store message text or Stop storing message text for the logs kept on the dashboard.
• Enable ban appeals or Disable ban appeals, and the appeal channel (Clear appeal channel removes it).

See Logs and Ban appeals.

Send the ticket panel

The names must match your category names exactly, including capitals. If none match, the bot answers "Pick at least one category." Without a title the panel says "Support" and "Select a category below to open a ticket."

To change a panel, send a new one. The old panel message stays in the channel until you delete it.

What to do first

Test it

• Open a ticket: as a member without staff roles, pick a category on the panel. You should get a private link to the new channel, and a line in the ticket log.
• Claim and close: as staff, press Claim, then Close, enter a reason and press Confirm close. The channel is deleted about five seconds later, the transcript appears in your transcript channel, and the opener gets a DM with a 1 to 5 rating.
• Report: right-click a message, choose Apps, then Report message. See Reports.
• Health: run /status. It should say "Bot status: healthy", show the database latency in milliseconds and list each background job. See the FAQ if it doesn't.

Changing settings later