Skip to content
This repository has been archived by the owner on Oct 6, 2022. It is now read-only.

Settings

David edited this page May 17, 2021 · 14 revisions
Name Description More explanations
default_volume Manage music's default volume Link
nsfw Manage current channel's NSFW state Link
allowed_channels Manage channel(s) in which Shadbot can interact Link
allowed_roles Manage role(s) that can interact with Shadbot Link
blacklist Manage blacklisted command(s) Link
auto_messages Manage auto-message(s) on user join/leave Link
auto_roles Manage auto assigned role(s) Link
restricted_channels Restrict commands to specific channels Link
restricted_roles Restrict commands to specific roles Link
language Manage default server language Link

default_volume

Manage music's default volume.

Default
By default, the volume is set to 10%.

Usage
You can change the default volume by executing
/setting default_volume <volume>

  • <volume> is the new default volume.

Restrictions
The minimum default volume possible is 1% and the maximum default volume is 75%.

Example
/setting default_volume 50


nsfw

Manage current channel's NSFW state.

Usage
You can change the current channel's NSFW state by executing
/setting nsfw <action>

  • <action> is either toggle to toggle the current state, enable to enable NSFW state or disable to disable NSFW state.

Example
/setting nsfw enable


allowed_channels

Manage channel(s) in which Shadbot can interact.

Default
By default, all channels where Shadbot has the View channel and Send message permissions are allowed.

Usage
You can restrict Shadbot to one or several channels by executing
/setting allowed_channels <action> <#channel(s)>

  • <action> is either add to add an allowed channel or remove to remove an allowed channel
  • <#channel(s)> is/are the channel(s)

Example
/setting allowed_channels add #bot_room


allowed_roles

Manage role(s) that can interact with Shadbot.

Default
By default, all roles can interact with Shadbot.

Restrictions
Server's owner and administrators will always be able to interact with Shadbot no matter this setting.

Usage
You can restrict Shadbot's interactions with one or several roles by executing
/setting allowed_roles <action> <role(s)>

  • <action> is either add to add an allowed role or remove to remove an allowed role
  • <role(s)> is/are the role names

Example
/setting allowed_roles add @can_interact


blacklist

Manage commands that are not allowed in the server.

Default
By default, all commands and categories are allowed.

Restrictions
It is not possible to blacklist the /setting command or the whole setting category.

Usage
You can blacklist one or several commands by executing
/setting blacklist <action> <type> <name(s)>

  • <action> is either add to add a command / category or remove to remove a command / category from the blacklist
  • <type> is either command to blacklist a command or category to blacklist a full category
  • <name(s)> is/are the command/category names

Example
/setting blacklist add command rule34 russian_roulette
/setting blacklist add category NSFW


auto_messages

Manage auto-message(s) on user join/leave.

Default
By default, Shadbot will not send any auto-messages.

Usage
You can enable / disable auto-messages by executing
/setting auto_messages <action> <type> [<value>]

  • <action> is either enable to enable an auto-message or disable to disable an auto-message
  • <type> is either join_message to configure the message when a user joins, leave_message to configure the message when a user leaves or channel to configure the channel in which the messages are sent
  • [<value>] is the message to send when the type is join_message or leave_message or a #channel when the type is channel

Formatting
When defining a value for join_message or leave_message, you can add some variable that will be automatically formatted:

  • {mention} - the mention of the user who joined/left
  • {username} - the username of the user who joined/left
  • {userId} - the id of the user who joined/left

Example
/setting auto_messages enable channel #welcome
/setting auto_messages enable join_message Hello {mention} 😄
/setting auto_messages disable leave_message


auto_roles

Manage auto assigned role(s).

Default
By default, Shadbot will not assign any role automatically.

Restrictions
Shadbot will not be able to add role(s) higher or at the same level in the role hierarchy than it.

Usage
You can automatically attribute role(s) to new comers by executing
/setting auto_roles <action> <role(s)>

  • <action> either add to add a role or remove to remove a role
  • <role(s)> is/are the role names

Example
/setting auto_roles add @newbie
/setting auto_roles remove @newbie


restricted_channels

Restrict commands to specific channels.

Default
By default, commands are not restricted to any channels.

Usage
You can restrict commands to a specific channel by executing:
/setting restricted_channels <action> <type> <name> <channel>

  • <action> is either add to add or remove to remove a restricted category
  • <type> is either command to restrict a single command or category to restrict a whole category
  • <name> is the command/category name
  • <channel> is the channel name

Example
/setting restricted_channels add category music #music
/setting restricted_channels add command rule34 #nsfw


restricted_roles

Restrict commands to specific roles.

Default
By default, commands are not restricted to any roles.

Usage
You can restrict commands to a specific roles by executing:
/setting restricted_roles <action> <type> <name> <role>

  • <action> is either add to add or remove to remove a restricted category
  • <type> is either command to restrict a single command or category to restrict a whole category
  • <name> is the command/category name
  • <role> is the role name to add/remove

Example
/setting restricted_roles add command play @admin
/setting restricted_roles add category music @dj


language

Manage default server language.

Default
By default, Shadbot will send messages in english.

Usage
You can change default language by executing: /setting language <language>

  • <language> is either french or english

Example
/setting language french