Quickstart - shinyfinder/chatot-smogon GitHub Wiki

This page is designed to get you up and running with Chatot quickly. For more details on using Chatot, please review the User Guide, which will guide you through more of the nuances of working with bots on Discord. For best results, you're going to want to do this on desktop (not mobile). By the end of this guide, you'll have:

  • Added Chatot to your server
  • Configured your server to allow for Chatot to ban users
  • Set up a logging channel (/config logging channel)
  • Sync'd with the masterlist of user bans from Smogon servers (/opt in)
  • Subscribed to features updates (/updates)

Steps

Objective 1: Adding Chatot

If you haven't already, add Chatot to your server. Here is an invite link. Opening that link in a browser will present you with a prompt to add the bot to a server. You must have the Manage Server permission in a server to add a bot to it.

Objective 2: Role Hierarchy

Chatot can only moderate users whose highest role is below Chatot's. We'll be using the Roles menu to place the Chatot role high enough in the list that it won't encounter issues when trying to punish users.

  1. Click on the name of your server in the upper left corner of Discord to expand the settings menu. Click on Server Settings.
  1. Click on Roles on the left sidebar
  1. Hover over the Chatot role, and click-and-hold on the dots to the left of the role. While holding down left click, drag the Chatot role above the other roles in the list. This will allow Chatot to moderate (i.e. ban) users. Chatot can only moderate roles that are below it in this menu. If Chatot is already sufficiently high on the hierarchy, you may skip this step. But it's good to know how to do.
  1. If you made changes to the position of Chatot's role, Discord will prompt you to save your changes at the bottom of your screen. Make sure you save them!
  1. You can now exit this menu by hitting your ESC key or clicking the "X" in the upper right corner.

Objective 3: Logging

Chatot is able to log many mod actions in the server, such as deleting messages and banning users. This section will walk you through creating a channel to receive these logs and configuring Chatot to log there.

  1. Create a new text channel (or thread) somewhere in your server, making sure that it's set to Private and that Chatot as one of the roles/members that can see it. At the very least, Chatot should have Send Messages, Attach Files, and View Channel permissions for this channel. Making sure your server's staff can see the channel is a good idea too! If you already have a channel setup, that works too; no need to make a new one.

  2. Within any text channel in your server, enter the following: /config logging channel

Chatot will prompt you to select a channel to setup to receive server logs. Discord limits the number of results you can see at a time, so type the name of the channel into the channel field if you don't see your desired one.

Sometimes if you copy-and-paste a command, Discord will think it's normal text rather than you trying to initiate a command. You can always click on the popups to make sure it registers.

  1. Hit Enter to send the command. Chatot will prompt you with a dropdown menu to select which actions you want logged to your channel. You can select as many as you want, so go ahead and click on all of them (you can scroll through the dropdown).

  2. Click off of the dropdown menu to submit your choices (awkward, I know, but that's how Discord works. You'll get used to it).

You can have any number of logging channels, so feel free to play around with your setup if you find you want to isolate some logging actions. Just run /config logging channel again!

Objective 4: Syncing Global Bans

Official Smogon servers are required to subscribe to Chatot's global ban (gban) functionality. While the process of marking as official is performed by SS, any server can allow Chatot to automatically ban users when they are globally banned from Smogon servers.

To subscribe to gbans, run the following command in a channel: /opt in

Chatot will then sync your server's list of bans with the list of people who have already been globally banned, and automatically ban future users who are globally banned. If Chatot has trouble banning anyone, it will create an entry in your log channel.

If Chatot had trouble banning someone and you've since fixed the issue (i.e. Chatot's role wasn't high enough in the role hierarchy), or if you wish to resync the list of gbans to make sure you're caught up, you can run the /syncgban command at any time within your server.

Objective 5: Feature Updates

New features are posted on the forums whenever they are released, but it's also possible to have the updates delivered directly to a channel within your server. Simply run the /updates command, and select the channel you wish to receive them!