Commands - Sven65/Sledgehammer GitHub Wiki
The kick command is used to kick members.
The usage is =>kick @user [@user] [@user]
The ban command is used to ban members.
The usage is =>ban @user [@user] [@user]
The clean command is used to remove messages.
The usage is =>clean [amount]
The amount
parameter defaults to 10.
The blacklist command is used to blacklist words from being said.
The usage is =>blacklist <value>
The value
parameter can be a word such as Hello
, a phrase such as Hello World
, or a JavaScript regex such as /Hello/
The whitelist command is used to remove items from the blacklist.
The usage is =>whitelist <value>
The value
parameter should be an item on the current blacklist of the server.
The mute command is used to mute members.
The usage is =>mute @user [@user] [@user]
The command also requires some configuration to be done.
Work In Progress.
The modlog command is used to change the channel where Sledgehammer sends messages such as kicks and bans.
The usage is
=>modlog #channel
The linkfilter command is used to change what types of links should be filtered in a channel.
The usage is =>linkfilter [#channel] <all/invites/none>
If the Channel
parameter is not present, the command defaults to the channel the command was sent in.
If the value is all
, the bot will remove all links.
If the value is invites
, the bot will only filter invite links such as discord.gg
If the value is none
, the bot will not filter any links.
The config command is used to see the current configuration of the server.
The setprefix command is used to change the prefix of Sledgehammer.
The usage is =>setprefix <prefix>
The prefix
value can be a maximum of 16 characters.
The edit command is used to edit Sledgehammers actions when certain events occur.
The usage is =>edit <event> <responseType> <value>
(If the event has a β
next to it, it's not been added yet.)
- onJoin
- The onJoin event is emited when a user joins the server.
- Emits the tag
${user}
- Emits the tag
- The onJoin event is emited when a user joins the server.
- onLeave
- The onLeave event is emited when a user leaves the server.
- Emits the tag
${user}
- Emits the tag
- The onLeave event is emited when a user leaves the server.
- onKick
- The onKick event is emited when a user is kicked from the server by the
kick
command.- Emits the tags
${kicker}
,${kickCount}
and${kicks}
- Emits the tags
- The onKick event is emited when a user is kicked from the server by the
- onBan
- The onBan event is emited when a user is banned from the server by the
ban
command.- Emits the tags
${banner}
,${banCount}
and${bans}
- Emits the tags
- The onBan event is emited when a user is banned from the server by the
- onUnban
- The onUnban event is emited when a user is unbanned from the server.
- onMute
- The onMute event is emited when a user is muted on a server.
- Emits the tags
${muter}
,${muteCount}
and${mutes}
- Emits the tags
- The onMute event is emited when a user is muted on a server.
- onUnmute
- The onUnmute event is emited when a user is unmuted on the server.
- Emits the tags
${muter}
,${muteCount}
and${unmutes}
- Emits the tags
- The onUnmute event is emited when a user is unmuted on the server.
- onLinkRemove
- The onLinkRemove event is emited when Sledgehammer removes a link.
- Tag emits
${type}
${From}
${FromName}
${FromID}
${FromDiscrim}
${Channel}
${ChannelName}
${ChannelID}
- Tag emits
- The onLinkRemove event is emited when Sledgehammer removes a link.
- onEmojiCreate
- The onEmojiCreate event is emited when an emoji is created on the server.
- Tag emits
${emoji}
${emojiname}
${emojiid}
${emojicreated}
${emojiurl}
- Tag emits
- The onEmojiCreate event is emited when an emoji is created on the server.
- onEmojiDelete β
- The onEmojiDelete event is emited when an emoji is deleted on the server.
- Tag emits
${emoji}
${emojiname}
${emojiid}
${emojicreated}
${emojiurl}
- Tag emits
- The onEmojiDelete event is emited when an emoji is deleted on the server.
- onEmojiUpdate β
- The onEmojiUpdate event is emited when an emoji is updated on the server.
- Tag emits
${oldemoji}
${oldemojiname}
${oldemojiid}
${oldemojicreated}
${oldemojiurl}
${newemoji}
${newemojiname}
${newemojiid}
${newemojicreated}
${newemojiurl}
- Tag emits
- The onEmojiUpdate event is emited when an emoji is updated on the server.
- onMemberUpdate β
- The onMemberUpdate event is emited when a member of the server changes - i.e. new role, removed role, nickname.
- onUserUpdate β
- The onUserUpdate event is emited when the details (e.g. username) of a user is changed.
- onServerUpdate β
- The onServerUpdate event is emited when the server is updated - e.g. name change.
- onMessageDelete β
- The onMessageDelete event is emited when a message is deleted.
- onMessageUpdate β
- The onMessageUpdate event is emited when a message is updated.
- onRoleCreate β
- The onRoleCreate event is emited when a role is created.
- onRoleDelete β
- The onRoleDelete event is emited when a role is removed.
- onRoleUpdate β
- The onRoleUpdate event is emited when a role is updated.
- onChannelCreate β
- The onChannelCreate event is emited when a channel is created.
- onChannelDelete β
- The onChannelDelete event is emited when a channel is delted.
- onChannelUpdate β
- The onChannelUpdate event is emited when a channel is updated.
- onPinsUpdate β
- The onPinsUpdate event is emited when the pins of a channel is updated.
-
Message
- Sets the message to send when the event is emited
-
Embed
- Utilises the 'Discord RichEmbed' feature. soonβ’
If the response type is set to message
, the value should be formatted as [#channel] message
If no channel is present, the message will default to the modlog channel if set, otherwise it'll default to the channel the command was sent in.
The message parameter can be edited using certain tags to get information about the event.
- Date tags
%% a literal %
%a locale's abbreviated weekday name (e.g., Sun)
%A locale's full weekday name (e.g., Sunday)
%b locale's abbreviated month name (e.g., Jan)
%B locale's full month name (e.g., January)
%d day of month (e.g., 01)
%D date; same as %m/%d/%y
%H hour (00..23)
%m month (01..12)
%M minute (00..59)
%S second (00..60)
%T time; same as %H:%M:%S
%y last two digits of year (00..99)
%Y year
The message command is used to configure what messages should be sent.
The usage is =>message <type> <true/false>
(If the Type has a β
next to it, it's not been added yet.)
- Join
- Leave
- Ban
- Unban
- Linkdelete
- Blacklistdelete
- Mute
- Unmute
- EmojiCreate
- EmojiUpdate
- EmojiDelete
- MemberUpdate β
- UserUpdate β
- ServerUpdate β
- MessageUpdate β
- RoleCreate β
- RoleDelete β
- RoleUpdate β
- ChannelCreate β
- ChannelDelete β
- ChannelUpdate β
- PinUpdate β
The role command is used to change roles of commands.
The usage is =>role <RoleType> @role/Role Name
- Muted
- The role to give users when using the
=>mute
command
- The role to give users when using the
The ping command shows the response time of Sledgehammer.
The usage is =>ping
The help command shows the commands and information about the commands of Sledgehammer
The usage is =>help [command]
The invite command shows a link to invite Sledgehammer.
The usage is =>invite