Users Module

Contains commands for getting and setting user information.

Configuration

users.newuserduration

The number of seconds a new user will have the newuserrole role. If zero, newuserrole won't be given to any new user.

users.newuserrole

If this is set and newuserduration is nonzero, this role is given to any new user that joins, regardless of raid settings. It is automatically removed after newuserduration seconds.

users.notifychannel

If set to a channel ID other than zero, sends a message to that channel whenever a new user joins the server.

users.roles

A list of all user-assignable roles. Manage it via !addrole and !removerole

users.silencemessage

This message will be sent to users that have been silenced by the !silence command.

users.timezonelocation

Sets the timezone location of the server itself. When no user timezone is available, the bot will use this.

users.trackuserleft

If true, tracks users that leave the server if notifychannel is set.

users.welcomechannel

If set to a channel ID, the bot will treat this channel as a "quarantine zone" for silenced members. If RaidSilence is enabled, new users will be sent to this channel.

users.welcomemessage

If RaidSilence is enabled, this message will be sent to a new user upon joining.

NewUsers

!newusers [maxresults]

Lists up to maxresults users, starting with the newest user to join the server.

maxresults

(optional) Defaults to 5 results, returns a maximum of 40.

aka

!aka [user]

Lists all known aliases of the user in question, up to a maximum of 10, with the names used the longest first.

user

(optional) A ping of the user, or simply their name.

ban

!ban <user> [for: duration] [reason]

Bans the given user. Examples: '!ban @CrystalFlash for: 5 MINUTES because he's a dunce or !ban "Name With Spaces" caught stealing cookies

user

A ping of the user, or simply their name. If the name has spaces, this argument must be put in quotes.

for: duration

(optional) If the keyword for: is used after the username, looks for a duration of the form for: 50 MINUTES and creates an unban event that will be fired after that much time has passed from now.

reason

(optional) The rest of the message is treated as a reason for the ban.

BanNewcomers

!bannewcomers [duration]

Bans all users who have sent their first message in the past duration seconds.

duration

(optional) The number of seconds to look back, defaults to 120 seconds (so anyone who sent their first message in the past 2 minutes would be banned).

time

!time [user]

Gets the local time for the specified user, or simply gets the local time for this server.

user

(optional) A ping of the user, or simply their name.

SetTimezone

!settimezone [timezone] [offset]

Sets your timezone to the given location. Providing a partial timezone name, like "America", will return a list of all possible timezones that contain that string.

timezone

(optional) A timezone location, such as America/Los_Angeles. Note that timezones do not have spaces.

offset

(optional) Your expected timezone offset in hours, used to narrow the search. For example, if you know you're in the PDT timezone, which is GMT-7, you could search for America -7 to list all timezones in america with a standard or DST timezone offset of -7.

UserInfo

!userinfo <user>

Lists the ID, username, nickname, timezone, roles, avatar, join date, and other information about a given user.

user

A ping of the user, or simply their name.

DefaultServer

!defaultserver <server>

Sets the default server SB will run commands on that you PM to her.

server

The exact name of your default server.

Silence

!silence <user> [for: duration]

Silences the given user.

user

A ping of the user, or simply their name.

for: duration

(optional) If the keyword for: is used after the username, looks for a duration of the form for: 50 MINUTES and creates an unsilence event that will be fired after that much time has passed from now.

Unsilence

!unsilence <user>

Unsilences the given user.

user

A ping of the user, or simply their name.

AssignRole

!assignrole <role> <user> [for: duration]

Assigns the role to the given user, and optionally adds an event to remove it in the future.

role

The role to add, either as a ping or as the name, but must be in quotes if it has spaces.

user

A ping of the user, or simply their name.

for: duration

(optional) If the keyword for: is used after the username, looks for a duration of the form for: 50 MINUTES and creates an event that will remove the role after that much time has passed from now.