Getting Start: Settings

Common 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.

Each setting below will show short examples for the bot (if able), and where you can find the setting on the dashboard. All of the dashboard screenshots are taken from the Manage Page explained in the last section.

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

important

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

Prefix

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

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

img

Lookback

Determines the start time of stats shown on the dashboard and bot commands. Default is 14 days back from "now". Can be increased to 30 days for free, or longer with the History upgrade. Also allows setting a Date instead and stats will show starting from that date.

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

img

Activity Tracking

Determines what activities (games, applications, etc.) the bot is tracking in your server. The current limit is 10. Adding activities must be done through the dashboard, but it is a common enough setting to mention here.

Dashboard

img

important

Unless the server has once had Premium at some point in time, now or in the past, Activity Tracking will not track per member. This means that per-member Activity tracking will only start from the time of the server's first Premium subscription.

Filters

These are special settings that allow you to toggle between Whitelists and Blacklists. Whitelisting means "only these". Blacklisting means "not these". Filters where you can select channels support categories as well.

Command Channels

Control what channels commands can be used in.

Privileged Users can always use commands everywhere (that the bot can see and respond).

Bot

s?toggle commandchannels whitelist # set the channel filter to only include channels
s?commands channels add #bot-spam # adds the #bot-spam channel to the filter
# Result: Members can only use statbot commands in #bot-spam.

Dashboard

img

Channel Filter (stats)

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.

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

img

Member Filter (stats)

Similar to channel filter, control what members appear in stats.

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

img

Configuring Access to Commands

In addition to the Command Channels setting, you can further control who can use commands with Command Access Level.

The full explanation of this setting can be found with the others in the settings section of these docs. There you will also learn about how to add Override Roles that will ignore the setting.

Levels:

  • All: All members can use all non-Admin commands. Default setting.
  • Restricted: Members can use all non-Admin commands, but any that take members as targets (e.g. s?user @TargetUser ) are restricted to the member running the command.
  • User Locked: Members can only use commands that target themselves.
  • Admin Only: Only Admins can use any command.

Bot

s?commands accesslevel all # set to "All"
s?commands accesslevel restricted # set to "Restricted"
s?commands accesslevel user # set to "User Locked"
s?commands accesslevel admin # set to "Admin Only"

Dashboard

img

Statdocks (Channel Counters)

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

To delete counters, just delete the channel! You can move counters wherever you want, but be careful about the Discord permissions on them. You can find what permissions Statdock channels need in the previous section 3. Discord Bot.

Bot

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

s?counters setup # create preset counters under a new category*
s?counters create # show a list of preset counters
s?counters create custom # show a list of all the advanced presets
s?counters 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".

Dashboard

img

info

The dashboard has many, many more counters and options for Statdocks. Statdock configurations are also kept when the channel is deleted and servers have a cap of 50 configs. When a server reaches this max, old configs must be deleted in order to create more. We highly suggest you start configuring Statdocks through the dashboard after creating your first few counters through the bot.