Skip to main content

Guide - Settings

This section quickly covers the most common Statbot settings. You can find detailed explanations of all of Statbot's settings in the settings section of these docs. Only Privileged Users (e.g. users with the Administrator Discord permission) and users with Manager Roles specified with Statbot's RBAC (Role-Based Access Control) system can change settings.

Most but not all settings can be changed in Discord with the bot. You can find a matrix on where you can configure settings in the settings section of these docs.

info

Except for Activity Tracking, these settings do NOT affect other Statbot features likes Statroles or premium Statdocks. Those features have their own separate settings.

Common Settings

Prefix

The prefix used for bot commands in the server as explained in section 3. Discord Bot.

Prefix documentation

Usage

Bot

s?prefix statbot?  # change prefix to "statbot?" (i.e. s?ping -> statbot?ping)
s?prefix reset # set prefix to default ("s?" and "S?"โ€‹)

Dashboard

Lookback

Determines the start time of stats shown on the dashboard and bot commands. Default is 14 days back from "now" (2 weeks) ago. This can be increased to 30 days for free, or longer with the History upgrade. A date can be used instead of a number of days, however the 30 days restriction will still be in effect.

Lookback documentation

Usage

Bot

s?lookback days 7   # set lookback to 7 days back from now
s?lookback days 30 # set lookback to 30 days back from now
s?lookback date 1/2/2020 # set lookback to February 1st, 2020.*

# *Will be "days 30" without the [History] upgrade if date is older than 30 days.

Dashboard

Activity Tracking (Premium)

Activity Tracking can be toggled on the dashboard for servers with the Data+. This will begin tracking all activities in the curated list for all members. If an activity you want tracked is not in the list, you can request that it be added by running the s?show activity @user command on a user interacting with that application and copy-pasting the response to the #๐ŸŽฎ-activity-requests channel in the support server.

Activity Tracking documentation

Usage

Dashboard

Configuring Access to Commands

There are two settings that give you control over how commands are use in your server: Command Access Level and Command Channels.

Command Access Level

Control what kinds of commands users can use (if any). Allows Override Roles to be added.

Command Access Level documentation

Usage

Bot

s?commandlevel admins           # restricts usage to only Privileged Users
s?commandroles add @Moderator # allows members with the Moderator role to ignore the commandlevel

# Result: Only Privileged Users and users with the Moderator role can use commands.

Dashboard

Command Channels

Control what channels commands can be used in. Privileged Users are not affected.

Command Channels documentation

Usage

Bot

s?toggle commandchannels whitelist    # set the channel filter to only include channels
s?commandchannels add #bot-spam 12# adds the #bot-spam channel to the filter

# Result: Members can only use statbot commands in #bot-spam.

Dashboard

Filters

These settings control what data is displayed on the Dashboard and in Commands. Changing these does NOT affect what Statbot tracks. The change is only visual.

Most allow you to choose between Whitelists and Blacklists. Whitelisting means "only include these". Blacklisting means "do not include these". Channel filters support categories as well.

Voice State Filters

Control what types of voice types appear in stats.

Voice State Filter documentation

Usage

Bot

  s?toggle voice afk  # turns AFK stats On or Off (depending on what it was previously)

Dashboard

info

A minute of voice will only be one of AFK, Server Deaf, Self Deaf, Sever Mute, Self Mute, or Regular (in order of how the bot will record it).

Channel Filter

Control what channels appear in stats. This gives you the ability to hide the channels from general stats and use them in other Statbot features like Channel Drilldown. If you don't want the bot to track channels, see the relevant FAQ question in Part 2. Set Up.

Channel Filter documentation

Usage

Bot

s?toggle channelfilter blacklist  # set the channel filter to exclude channels
s?channelfilter add #bot-spam # adds the #bot-spam channel to the filter

# Result: Message stats from #bot-spam are excluded from graphs and commands.

Dashboard

Member Filter

Similar to Channel Filter, control what members appear in stats.

Member Filter documentation

Usage

Bot

s?toggle memberfilter blacklist  # set the channel filter to exclude channels
s?memberfilter add @spammer # adds the user @spammer to the filter

# Result: Stats from @spammer are excluded from graphs and commands.

Dashboard

Role Filter (Premium)

Similar to Member Filter, control what members appear in stats using their roles.

Role Filter documentation. Part of the Data+ upgrade.

Usage

Bot

s?toggle memberfilter blacklist  # set the channel filter to exclude channels
s?memberfilter add @spammer # adds the user @spammer to the filter

# Result: Stats from @spammer are excluded from graphs and commands.

Dashboard

Statdocks (Channel Counters)

Statbot's channel counter solution where you can display stats about your server in channel names that update regularly.

Statdocks documentation

Usage

Bot

Bot commands allow you to create simple counters that you can later edit through the dashboard. counter is an alias for statdocks and is used in the examples below.

s?counter setup    # create preset counters under a new category*
s?counter create # show a list of preset counters
s?counter create custom # show a list of all the advanced presets
s?counter create custom Users: {{19}} # create a counter with a custom name**

# *Creates all the preset counters under "counters create"
# **Will produce a counter with a name like "Users: 1000".
tip

To delete counters, just delete the Discord channel! Though after some time you may need to go to the dashboard to clear out old configs.

You can also move counters wherever you want, but be wary about Discord permissions. You can find what permissions Statdock channels need in the previous section 3. Discord Bot.

Dashboard

tip

The bot is limited in the counters you can make. Go to the dashboard for editing your Statdocks and many more settings.

Statroles (Auto Roles)

Statroles assign and remove roles on members based on your settings and their stats. Each Statrole has its own Conditions and Filters that can be combined to customize your role management systems to your needs.

Statroles documentation

Usage

Dashboard