mirror of
https://github.com/Sheldan/abstracto.git
synced 2026-04-18 12:57:39 +00:00
[AB-80] added tracking of emotes used by server members and configuration
updated sonar scanner version changed some commands to be silent instead of adding a check reaction
This commit is contained in:
Sheldan
@@ -0,0 +1,77 @@
|
||||
=== Assignable roles
|
||||
|
||||
This feature enables creating and maintaining so-called 'assignable role places'. These places are messages at which reactions are added, and when a member reacts a configured role is assigned to the user.
|
||||
These places can consist of multiple messages (reactions are limited to 20 per message) and assignable roles can be added/removed. A place can be disabled, which causes any reaction to be removed and no role to be assigned.
|
||||
There are several configurations possible for each individual assignable role place.
|
||||
* `inline`: tries to display the embed as compact as possible and when this is disabled, every assignable role is displayed in a separate line. Default: `false`
|
||||
* `autoRemove`: if a member adds a reaction to the assignable role place, they are removed immediately afterwards. Default: `false`
|
||||
* `unique`: if a member adds a reaction and has previously selected other roles, these previous roles are removed before the new ones are assigned. Default: `false`
|
||||
* `active`: an inactive assignable role place does not assign any roles and immediately removes any reactions added. Default: `true`
|
||||
|
||||
If there are reactions added by members, which are not used within an assignable role place, the reaction gets removed automatically.
|
||||
|
||||
If the emote is deleted, the assignable role place is still functional, but if you set it up again, it fail to do so. You need to remove the emote from the assignable role place via its ID. The ID will be displayed for the emotes which were removed.
|
||||
Deleting the actual role behind an assignable role causes the assignable role place to become non-functional: the added reaction will remain and reactions can still be added, but nothing will happen.
|
||||
|
||||
Feature key: `assignableRole`
|
||||
|
||||
|
||||
==== Commands
|
||||
Create a new assignable role place::
|
||||
* Usage: `createAssignableRolePlace <name> <channel> <text>`
|
||||
* Description: Creates a new assignable role place with the key `name`. The `text` will be shown in the description of the first message.
|
||||
When the place is setup, it will be posted in the `channel`. The created place is active and inline by default.
|
||||
|
||||
Add a role to an assignable role place::
|
||||
* Usage: `addRoleToAssignableRolePlace <name> <emote> <text> <role>`
|
||||
* Description: Adds to the assignable role place identified by `name` an additional assignable role. The reaction to be used will be `emote` and `role` will be assigned when a member adds the reaction.
|
||||
It is required that `emote` is usable by Abstracto and not yet used in the assignable role place. If the assignable role place is currently setup, the assignable role will be directly appended to the assignable role place and is
|
||||
immediately available to be used. If this requires a new post, because the last message already has the maximum amount of reactions, it is required to setup the assignable role place again.
|
||||
|
||||
Create the assignable role place in discord::
|
||||
* Usage: `setupAssignableRolePlace <name>`
|
||||
* Description: Posts the messages of the assignable role place identified by `name` to the configured channel in discord and adds the reactions. This will delete the old messages connected to this assignable role place, if there are any.
|
||||
|
||||
Remove a role from an assignable role place::
|
||||
* Usage: `removeRoleFromAssignableRolePlace <name> <emote>`
|
||||
* Description: Removes from the assignable role place identified by `name`, the emote identified by `emote`. If the assignable role place is currently in use, this will update the message and remove all reactions using `emote`.
|
||||
|
||||
Show the current configuration for an assignable role place::
|
||||
* Usage: `showAssignableRolePlaceConfig <name>`
|
||||
* Description: This command displays the current configuration of assignable role place identified by `name`. This information includes the available emotes, which roles they represent and what position they have.
|
||||
|
||||
Test how the assignable role place would look like::
|
||||
* Usage: `testAssignableRolePlace <name>`
|
||||
* Description: Posts the assignable role place identified by `name` in the current channel. This command does not add the reactions, and is purely to check how the messages look.
|
||||
|
||||
Move an assignable role place to another channel::
|
||||
* Usage: `moveAssignableRolePlace <name> <newChannel>`
|
||||
* Description: Moves the assignable role place identified by `name` to be in `newChannel`. This change takes effect the next time the assignable role place is setup via `setupAssignableRolePlace`.
|
||||
|
||||
Deactivate the assignable role place::
|
||||
* Usage: `deactivateAssignableRolePlace <name>`
|
||||
* Description: Deactivates the assignable role place identified by `name`. Any further reactions placed by members will be removed immediately and not assign any roles.
|
||||
|
||||
Activate the assignable role place::
|
||||
* Usage: `activateAssignableRolePlace <name>`
|
||||
* Description: Activates the assignable role place identified by `name` and enables the assignment of roles.
|
||||
|
||||
Change configuration of assignable role place::
|
||||
* Usage: `changeAssignableRolePlaceConfig <name> <key> <newValue>`
|
||||
* Description: Changes the config attribute indicated by `key` of the place identified by `name` to `newValue`. The possible keys are: `inline`, `unique`, `autoRemove` and `active` respectively and all of these can take `true`/`false` as `newValue`.
|
||||
|
||||
Swap two emotes in an assignable role place::
|
||||
* Usage: `swapAssignableRolePosition <name> <firstEmote> <secondEmote>`
|
||||
* Description: Swaps the position of the assignable role places `firstEmote` and `secondEmote` in the assignable role place identified by `name`. This change takes effect the next time the assignable role place is setup via `setupAssignableRolePlace`.
|
||||
|
||||
Set the position of an assignable role within an assignable role place::
|
||||
* Usage: `setAssignableRolePosition <name> <emote> <position>`
|
||||
* Description: Sets the position of the `emote` within the assignable role place identified by `name` to `position`. This change takes effect the next time the assignable role place is setup via `setupAssignableRolePlace`.
|
||||
|
||||
Delete an assignable role place::
|
||||
* Usage: `deleteAssignableRolePlace <name>`
|
||||
* Description: Completely deletes the assignable role place identified by `name`. This includes any trace in the database and the current messages, if any.
|
||||
|
||||
Change description text of assignable role place::
|
||||
* Usage `editAssignableRolePlaceText <name> <newText>`
|
||||
* Description: Changes the text which is shown in the first message of the assignable role place identified by `name` to `newText`. This changes the message immediately.
|
||||
@@ -0,0 +1,134 @@
|
||||
=== Core
|
||||
|
||||
The core feature contains necessary commands in order for Abstracto to function and be configured.
|
||||
|
||||
==== Emotes
|
||||
* `successReaction` reaction emote in case the command completed successfully
|
||||
* `warnReaction` reaction emote in case the command did not complete successfully
|
||||
|
||||
==== Commands
|
||||
Help::
|
||||
* Usage: `help [module/command]`
|
||||
* Description: If no parameter is provided, this will list the currently available modules. If the provided parameter matches the name of a module, information about that module is displayed.
|
||||
This information includes a description and the available commands of this module. If the provided parameter matches a command name, information about this command is displayed.
|
||||
The module matching takes precedence over command matching.
|
||||
This information includes the a short description, a more detailed description, aliases (if any), parameters (if any), which roles are allowed to execute the command,
|
||||
or if it is not restricted and which roles are immune against the command.
|
||||
Changing the system configuration::
|
||||
* Usage `setConfig <key> <value>`
|
||||
* Description: Changes the value of this configuration identified by `key` to `value`. Some of these configurations have separate commands, but this works in general.
|
||||
* Example: `setConfig expMin 15` to set the minimum experience to 15
|
||||
Changing emotes Abstracto uses::
|
||||
* Usage: `setEmote <key> <emote>`
|
||||
* Description: Sets the emote identified by `key` used by Abstracto on this server to `emote`.
|
||||
This allows both built in emotes and custom emotes, but Abstracto must be in the server of the custom emote in order to use them.
|
||||
Clearing the cache::
|
||||
* Usage: `clearCache`
|
||||
* Description: Clears the internal cache used by Abstracto. This is necessary if things in the databases were changed and need to be in effect immediately.
|
||||
Ping::
|
||||
* Usage: `ping`
|
||||
* Description: Prints the latency of Abstracto to the Discord servers.
|
||||
Echo::
|
||||
* Usage: `echo <text>`
|
||||
* Description: Echos `text` in the same channel this command as executed in.
|
||||
Changing the prefix::
|
||||
* Usage: `setPrefix <prefix>`
|
||||
* Description: Changes the prefix of the bot in this guild to `prefix`. This can be one or multiple characters.
|
||||
Changing a post target::
|
||||
* Usage: `posttarget <key> <channel>`
|
||||
* Description: Changes the given post target identified by `key` to the given channel. All messages using this post target will be send to this channel from now on.
|
||||
If neither `key` nor `channel` is given, this will print the currently available post targets and the channels they point to, if set.
|
||||
* Example: `posttarget banLog #general` to log the bans in the #general channel.
|
||||
Listing the features::
|
||||
* Usage: `features`
|
||||
* Description: Lists the available features and whether or not they are enabled in this server.
|
||||
Enabling a feature::
|
||||
* Usage: `enableFeature <key>`
|
||||
* Description: Enables the feature identified by `key` in this server. If the feature dependents on other features, they will be enabled as well.
|
||||
* Example: `enableFeature moderation` to enable the moderation feature
|
||||
Disabling a feature::
|
||||
* Usage: `disableFeature <key>`
|
||||
* Description: Disables the feature identified by `key` in this server. If the feature is required for other features, they will be disabled as well.
|
||||
* Example: `disableFeature moderation` to disable the moderation feature
|
||||
Creating a channel group::
|
||||
* Usage: `createChannelGroup <key>`
|
||||
* Description: Creates a new channel group identified by `key`.
|
||||
* Aliases: `+ChGroup`
|
||||
Adding a channel to a channel group::
|
||||
* Usage: `addToChannelGroup <groupName> <channel>`
|
||||
* Description: Adds the `channel` to the channel group identified by the `groupName`. It is not possible for a channel to be in a group twice.
|
||||
* Aliases: `addTChGrp`, `chGrpCh+`
|
||||
* Example: `addToChannelGroup group1 #general` to add the channel #general to the group `group1`
|
||||
Removing a channel from a channel group::
|
||||
* Usage: `removeFromChannelGroup <groupName> <channel>`
|
||||
* Description: Removes the `channel` from the channel group identified by `groupName`.
|
||||
* Aliases: `rmChChgrp`, `chGrpCh-`
|
||||
* Example: `removeFromChannelGroup group1 #general` to remove the channel #general from the group `group1`
|
||||
Deleting a channel group::
|
||||
* Usage: `deleteChannelGroup <key>`
|
||||
* Description: Deletes the channel group identified by `key`. This will also remove all associated channels from this group. This command fails, if the group is used in other features and referenced.
|
||||
* Aliases: `-ChGroup`
|
||||
Disabling a command in a group::
|
||||
* Usage: `disableCommand <commandName> <groupName>`
|
||||
* Description: Disables the command identified by `commandName` in the channel group `groupName`. A command is considered disabled in a specified channel, if the command is disabled in *all* the groups the channel is in.
|
||||
* Example: `disableCommand warn group1` to disable the command `warn` in the group `group1`
|
||||
Enabling a command in a group::
|
||||
* Usage: `enableCommand <commandName> <groupName>`
|
||||
* Description: Enables the command identified by `commandName` in the channel group `groupName`. A command is considered enabled in a specified channel, if the command is enabled in *any* the groups the channel is in.
|
||||
* Example: `enableCommand warn group1` to enable the command `warn` in the group `group1`
|
||||
Showing all available channel groups and the respective channels::
|
||||
* Usage: `listChannelGroups`
|
||||
* Description: Provides an overview of the currently available channel groups and which channels are in this channel group.
|
||||
* Aliases: `lsChGrp`
|
||||
Removing role restrictions from a command::
|
||||
* Usage: `allow <featureName|commandName>`
|
||||
* Description: Allows everyone to execute all commands in this `feature`/the `command`. Which means, any restrictions concerning which role is able to execute a certain command is ignored even if it still shows in the help output.
|
||||
Allowing a role to execute a command::
|
||||
* Usage: `allowRole <featureName|commandName> <role>`
|
||||
* Description: Allows the provided `role` to execute all commands in the `feature`/the `command`. This command automatically restricts the commands, which means, if it was unrestricted before, after executing this command only the provided role can execute the command.
|
||||
* Example: `allowRole moderation @Staff` to allow the role `Staff` to execute all commands in the `moderation` feature (where @Staff is a role mention)
|
||||
Forbidding a role to execute a command::
|
||||
* Usage: `disAllowRole <featureName|commandName> <role>`
|
||||
* Description: Removes the `role` from the list of allowed roles for all commands in the `feature`/the `command`.
|
||||
* Example: `disAllowRole moderation @Staff` to forbid the role `Staff` to execute all commands in the `moderation` feature (where @Staff is a role mention)
|
||||
Make a role affected by a command::
|
||||
* Usage: `makeAffected <featureName|commandName> <role>`
|
||||
* Description: Makes the role affected by all commands in the `feature`/the `command`.
|
||||
* Example: `makeAffected ban @Staff` in order so the role `Staff` can be banned via the command (where @Staff is a role mention)
|
||||
Make a role immune against a command::
|
||||
* Usage: `makeImmune <featureName|commandName> <role>`
|
||||
* Description: Makes the role immune from all commands in the `feature`/the `command`.
|
||||
* Example: `makeImmune ban @Staff` in order so the role `Staff` cannot be banned via the command (where @Staff is a role mention)
|
||||
Enforce the role restrictions of commands::
|
||||
* Usage: `restrict <featureName|commandName>`
|
||||
* Description: Causes the role restrictions for a all commands in the `feature`/the `command` to be in effect again.
|
||||
Enabling a feature mode::
|
||||
* Usage: `enableMode <featureName> <mode>`
|
||||
* Description: Enables the mode `mode` in feature `featureName`.
|
||||
Disabling a feature mode::
|
||||
* Usage: `disableMode <featureName> <mode>`
|
||||
* Description: Disables the mode `mode` in feature `featureName`.
|
||||
Listing all feature modes::
|
||||
* usage `featureModes [feature]`
|
||||
* Description: Lists all of the currently available feature modes and the feature they are associated with. If `feature` is given, it only lists the feature modes of this feature. The output also includes whether or not the current mode is enabled and if this value comes from the default configuration.
|
||||
Setting up a feature with an interactive wizard::
|
||||
Usage: `setupFeature <featureName>`
|
||||
* Description: Starts an interactive wizard to configure the necessary properties and post targets of a feature. Also includes custom steps. Closes with a summary page to see all changes.
|
||||
|
||||
|
||||
.What does it mean if a role is immune?
|
||||
A command can take a member as a target, for example `ban`. If a role is considered immune, this means, if the member which is the target of the command has the given role, this command will fail. Not all commands support this feature, but only the following:
|
||||
|
||||
* Ban
|
||||
* Kick
|
||||
* Warn
|
||||
* Mute
|
||||
|
||||
While a role can be made immune for any command, only these commands actually use this information.
|
||||
|
||||
.What is a feature mode?
|
||||
A feature mode is a very specific way in which a feature behaves for a certain decision. These feature modes can be defined for each server and are directly bound to a feature.
|
||||
These feature modes influence the availability of commands or general behavior of features.
|
||||
|
||||
An example of a feature mode is mod mail logging: If the feature mode `log` of mod mail is disabled, no thread will be logged and the separate command `closeNoLog` will not be available in the first place, because it will behave the same as the normal `close` command.
|
||||
If the feature mode is enabled, the messages from the thread are logged in the respective post target and the command will be available.
|
||||
@@ -0,0 +1,69 @@
|
||||
=== Experience tracking
|
||||
|
||||
This feature contains the ability to track experience of users on the server and award roles based on the level they reach.
|
||||
The experience is awarded once per minute and is calculated by asciimath:[`\text{rand}(\text{minExp}, \text{maxExp}) * \text{expScale}`].
|
||||
Only one role is awarded at a time and the past unlocked roles are not given to the members.
|
||||
|
||||
==== Necessary bot permissions
|
||||
`MANAGE_ROLES` in order to award members with roles
|
||||
|
||||
==== Relevant system configuration
|
||||
`minExp` The lower bound of the awarded base experience. Default: 10.
|
||||
|
||||
`maxExp` The upper bound of the awarded base experience Default: 25.
|
||||
|
||||
`expScale` The multiplier applied after the experience amount was determined. Default: 1.0.
|
||||
|
||||
==== Commands
|
||||
Changing the experience scale of the server::
|
||||
* Usage: `expScale <value>`
|
||||
* Description: Changes the value of `expScale` on this server to `value`.
|
||||
|
||||
Showing the leader board of the server::
|
||||
* Usage: `leaderboard [page]`
|
||||
* Description: Shows the leader board of the server in a paginated format. This does not use the interactive pagination.
|
||||
If no parameter is provided, it will show the top 10 members and their message count, level, experience and rank.
|
||||
Additionally the same information for the user executing is shown, regardless whether or not the user is already shown on the given leader board page.
|
||||
If a `page` is provided, it will display the leader board of the ranks `page * 10` until `(page + 1) * 10` instead. If `page` is beyond the member count, the last members are shown.
|
||||
|
||||
|
||||
Setting a role to be awarded at a certain level::
|
||||
* Usage: `setExpRole <level> <role>`
|
||||
* Description: Sets `role` to be awarded at the given `level`. If the role was previously assigned,
|
||||
this will cause to remove this assignment and recalculate the roles for all users previously having this role.
|
||||
This command will provide a status message indicating this process.
|
||||
This will not award this role to users which qualify for this, a `syncRoles` is necessary for this.
|
||||
* Example: `setExpRole 50 @HighLevel` in order to award the role `HighLevel` at level `50` (the @HighLevel is a role mention)
|
||||
|
||||
Syncing the roles of the members with the configuration::
|
||||
* Usage: `syncRoles`
|
||||
* Description: Recalculates the appropriate levels for all users on the server and awards the roles appropriate for the level.
|
||||
There will be a message indicating the current status of the progress and it is highly advised to not execute this command while another instance is still processing.
|
||||
This command can run for a longer period of time, depending on the amount of members in the guild.
|
||||
|
||||
Remove a role from being awarded at a certain level::
|
||||
* Usage: `unSetExpRole <role>`
|
||||
* Description: Removes this role from the experience tracking, removes the role from all members previously owning it and recalculates their new role according to the configuration.
|
||||
This will provide a status update message displaying the process.
|
||||
|
||||
Disable experience gain for a certain role::
|
||||
* Usage: `disableExpForRole <role>`
|
||||
* Description: Disables any experience gain for members with this role. They will not gain any experience until the role is removed or it is possible for the role to gain experience again.
|
||||
If a member has *any* role of the ones for which experience is disabled, the member will not gain experience.
|
||||
|
||||
Enable experience gain for a certain role::
|
||||
* Usage: `enableExpForRole <role>`
|
||||
* Description: Enables experience gain for members with this role again.
|
||||
|
||||
List roles for which experience gain is disabled::
|
||||
* Usage: `listDisabledExperienceRoles`
|
||||
* Description: Lists the roles for which experience gain is disabled on this server.
|
||||
* Aliases: `lsDisEpRoles`
|
||||
|
||||
Disable experience gain for specific member::
|
||||
* Usage: `disableExpGain <member>`
|
||||
* Description: Disables the ability to gain experience for this certain member.
|
||||
|
||||
Enable experience gain for specific member::
|
||||
* Usage: `enableExpGain <member>`
|
||||
* Description: Enables the ability to gain experience for this certain member.
|
||||
@@ -0,0 +1,167 @@
|
||||
=== Moderation
|
||||
|
||||
Feature key: `moderation`
|
||||
|
||||
==== Post targets
|
||||
`banLog`:: target of the log message containing information about the ban for both `ban` and `banId`. Will still ban if not setup.
|
||||
`kickLog`:: target of the log message containing information about the kick. Will still kick if not setup.
|
||||
|
||||
==== Feature modes
|
||||
`banLogging`:: if enabled, log bans to the post target `banLog`. Enabled by default.
|
||||
`kickLogging`:: if enabled, log bans to the post target `kickLog`. Enabled by default.
|
||||
|
||||
==== Commands
|
||||
Ban a member::
|
||||
* Usage: `ban <member> [reason]`
|
||||
* Description:
|
||||
Bans the given given `member` with the given optional `reason`. This sends a logging message to the `banLog` post target.
|
||||
Banning this way does not delete old messages of the member on the server. If the `reason` is not provided, a default reason is used.
|
||||
* Example: `ban @Member bad` in order to ban `Member` with the reason `bad` (the @Member is a user mention)
|
||||
* Required bot permission: `BAN_MEMBERS`
|
||||
Ban a user by ID::
|
||||
* Usage: `banId <userId> [reason]`
|
||||
* Description: Bans the `user` by his id with the optional `reason`. . This command can be used in case the user is not part of the server anymore.
|
||||
This will also send a log message to `banLog` and not delete old messages.
|
||||
* Example: `banId 1234 bad` in order to ban the user with ID `1234` with the reason `bad`
|
||||
* Required bot permission: `BAN_MEMBERS`
|
||||
Kick a member::
|
||||
* Usage: `kick <member> [reason]`
|
||||
* Description: Kicks the `member` from the guild with the given `reason`. If the `reason` is not provided, a default reason is used.
|
||||
* Example: `kick @Member bad` in order to kick `Member` with the reason `bad` (the @Member is a user mention)
|
||||
* Required bot permission: `KICK_MEMBERS`
|
||||
Change the slow mode in a channel::
|
||||
* Usage: `slowmode <duration> [channel]`
|
||||
* Description: This command sets the slow mode in the `channel` to the given `duration`. This command uses duration parsing. The `channel` is optional and if none is provided, the current channel is used.
|
||||
* Example: `slowMode 1h2m3s #general` in order to set the slow mode in channel `general` to 1 hour 2 minutes and 3 seconds (the #general is a user mention)
|
||||
Purging messages in a channel::
|
||||
* Usage: `purge <messageCount> [member]`
|
||||
* Description: Deletes the last `messageCount` messages in the current channel. If a `member` is provided as parameter, only the messages by this member
|
||||
will be deleted. The deletion of this messages will *not* be logged by the logging mechanism. The messages to be deleted need to be from within the last 2 weeks, but there is no limit on how much messages can be deleted besides that.
|
||||
While the command is ongoing, a status update message will be shown indicating how far the command is. This message will be deleted after the command is done.
|
||||
|
||||
=== Warning
|
||||
|
||||
This feature can be used to warn specific users if they did something not allowed by the rules.
|
||||
|
||||
Feature key: `warnings`
|
||||
|
||||
==== Post targets
|
||||
`warnLog`:: target of the log message containing information about a created warn, only used if feature mode `warnLogging` is enabled.
|
||||
`decayLog`:: will be used when all the warnings are decayed by `decayAllWarnings` and feature mode `warnDecayLogging` is enabled.
|
||||
|
||||
==== Feature modes
|
||||
`warnLogging`:: if enabled, each warn is logged to the post target `warnLog`. Enabled by default.
|
||||
`automaticWarnDecayLogging`:: if enabled, warn decays by `decayAllWarnings` are logged to the post target `decayLog`. Enabled by default.
|
||||
|
||||
|
||||
==== Commands
|
||||
Warn a user::
|
||||
* Usage: `warn <member> [reason]`
|
||||
* Description: Warns the `member` with the given `reason` or a default one, if none is provided. This command sends a log message to the `warnLog` post
|
||||
target and notifies the member about the warn.
|
||||
* Example: `warn @Member bad` in order to warn `Member` with the reason `bad` (the @Member is a user mention)
|
||||
Listing the warnings of users::
|
||||
* Usage: `warnings [member]`
|
||||
* Description: If no `member` is provided displays all the warnings on the server. If a `member` is provided, will only display the warnings of the user.
|
||||
This uses a paginated output, which means multiple pages in case there are more warnings to display. This will also display the date the warning was decayed if applicable.
|
||||
Showing your warnings::
|
||||
* Usage: `myWarnings`
|
||||
* Description: Displays the amount of warnings of the user executing on the server. This will show both active and total warnings.
|
||||
Decaying all warnings regardless of the date::
|
||||
* Usage: `decayAllWarnings`
|
||||
* Description: This will cause all warnings of this server which are not decayed yet to be decayed instantly.
|
||||
Deleting a warning::
|
||||
* Usage: `deleteWarning <warnId>`
|
||||
* Description: Deletes the warning identified by `warnId` completely from the database.
|
||||
|
||||
|
||||
=== Automatic warn decay
|
||||
|
||||
This feature enables warnings to be decayed after a configurable amount of days. This feature directly depends on the feature `warnings`.
|
||||
|
||||
Feature key: `warnDecay`
|
||||
|
||||
==== Relevant system configuration
|
||||
`decayDays` The amount of days after which a warning gets decayed. Default: 90
|
||||
|
||||
==== Post targets
|
||||
`decayLog`:: target of the log message containing the information in case a warning is decayed.
|
||||
|
||||
==== Feature modes
|
||||
`automaticWarnDecayLogging`:: if enabled, automatic warn decays are logged to the `decayLog` post target. Enabled by default.
|
||||
|
||||
==== Commands
|
||||
Decaying all warnings if necessary::
|
||||
* Usage: `decayWarnings`
|
||||
* Description: Triggers the decay of the warnings instantly, which means, every not decayed warning on this server older than the configured amount of days will be decayed and the decay will be logged.
|
||||
|
||||
=== Muting
|
||||
|
||||
This feature provides the capability to mute users, which effectively means it applies a role which prevents them from sending messages and speaking in voice chat.
|
||||
The role used to mute member will not be created and needs to be provided. There is no validation if the provided role actually mutes members.
|
||||
If the user leaves the guild and rejoins, the mute role will be re-applied.
|
||||
|
||||
Feature key `muting`
|
||||
|
||||
==== Post targets
|
||||
`muteLog`:: target of log message containing the information in case a member was muted and when the mute ended automatically.
|
||||
|
||||
==== Feature modes
|
||||
`muteLogging`:: if enabled, each mute is to be logged to the post target `muteLog`. Enabled by default.
|
||||
`unMuteLogging`:: if enabled, each un mute which happens 'naturally' (after the defined time period is over) will be logged to the `muteLog` post target. Enabled by default.
|
||||
`manualUnMuteLogging`:: if enabled, each un mute which happens via the command `unmute` will be logged to the `muteLog` post target. Enabled by default.
|
||||
|
||||
|
||||
==== Commands
|
||||
Muting a user::
|
||||
* Usage: `mute <member> <duration> [reason]`
|
||||
* Description: Applies the mute role to the given `member` for the given `duration`. If `reason` is not provided, a default reason will be used for logging in the `muteLog` post target. This will automatically
|
||||
un-mute the user after the duration has passed. If the un-mute happens automatically, this will also be logged in the `muteLog` post target.
|
||||
This command sends a notification to the user about the mute and kicks the user from the voice channel, if any.
|
||||
* Example: `mute @Member 1h2m3s bad` in order to mute the member `Member` for 1 hour 2 minutes and 3 seconds with the reason `bad` (the @Member is a user mention)
|
||||
Un-Muting a user::
|
||||
* Usage: `unMute <member>`
|
||||
* Description: Removes the mute role from the given member. This does *not* log the un-mute.
|
||||
Configuring which role to use for muting::
|
||||
* Usage: `setMuteRole <role>`
|
||||
* Description: Sets the `role` to be used as the role when applying a mute. This role needs to be muting, which means, if you want it to be effective, this role needs to deny `MESSAGE_WRITE`. Abstracto does not validate nor require the role to actually mute.
|
||||
Only *one* role can be used as a mute role.
|
||||
|
||||
=== Logging
|
||||
|
||||
This feature provides a range of utilities to monitor the server.
|
||||
The logging includes:
|
||||
|
||||
Feature key `logging`
|
||||
|
||||
==== Post targets
|
||||
`deleteLog`:: target for the messages containing information about a deleted message.
|
||||
`editLog`:: target for the messages containing information about an edited message.
|
||||
`joinLog`:: target for the messages containing information about an user joining the server.
|
||||
`leaveLog`:: target or the messages containing information about an user leaving the server.
|
||||
|
||||
Deleted message logging:: When a message is deleted, the content of the message and the possible attachments of said message will be logged.
|
||||
Edited message logging:: When a message is edited, the previous content of the message and the new content of the message will be logged.
|
||||
This does not work if the message was sent before the bot was started.
|
||||
Member joining logging:: When a member joins the guild, a message indicating this is send.
|
||||
Member leaving logging:: When a member leaves the guild, a message indicating this is send.
|
||||
|
||||
|
||||
=== User notes
|
||||
|
||||
Feature key `userNotes`
|
||||
|
||||
This feature provides the ability to store specific notes for members in the database. These notes can then be retrieved and deleted and consist of only text.
|
||||
|
||||
==== Commands
|
||||
Creating a user note::
|
||||
* Usage: `userNote <user> <text>`
|
||||
* Description: Creates a single user note for the specified user.
|
||||
|
||||
Deleting a user note::
|
||||
* Usage: `deleteNote <id>`
|
||||
* Description: Deletes the user note identified by its ID. The ID can be retrieved by the command `userNotes`.
|
||||
|
||||
Retrieving user notes::
|
||||
* Usage: `userNotes [user]`
|
||||
* Description: If `user` is not provided, this will list the user notes of the whole server, if `user` is provided, this will only list user notes from this particular `user`.
|
||||
@@ -0,0 +1,81 @@
|
||||
=== Mod mail
|
||||
|
||||
This feature enables users to contact the moderation of the server in a private manner. This can be initiated by messaging the Abstracto bot.
|
||||
The messages, in the channel which is created to contain the mod mail thread, are not automatically sent to the user, but only when using the commands
|
||||
`reply` or `anonReply`. Any other message is ignored with the intention of enabling discussions within the channel. In case the message of a message sent to the user
|
||||
needs to be updated or deleted, you can do simply by editing/deleting the message containing the command.
|
||||
|
||||
Feature key: `modmail`
|
||||
|
||||
==== Necessary bot permissions
|
||||
`MANAGE_CHANNEL` to create the channels representing the mod mail threads
|
||||
|
||||
==== Workflow
|
||||
* User messages the Abstracto bot
|
||||
* If Abstracto is active in multiple servers with mod mail enabled, the user is prompted to which server he wants to open a mod mail thread for.
|
||||
* A channel in the mod mail category is created for the user and notification is sent that a new mod mail thread has been opened
|
||||
* User can send messages in the private channel and they get relayed to this created text channel.
|
||||
* Moderators can answer in the thread with the respective commands
|
||||
* Moderators close the thread
|
||||
* The interactions between the user and the moderators gets logged in the mod mail logging channel
|
||||
|
||||
==== Relevant system configuration
|
||||
`modmailCategory`:: The category on the server which is used to hold the text channels representing the threads
|
||||
|
||||
`modMailClosingText`:: The text being used when notifying the user when a thread is closed.
|
||||
|
||||
==== Post targets
|
||||
`modmailPing`:: Will be used to send the notification when a new thread is opened.
|
||||
`modmailLog`:: Will be used to log the interactions when a thread is closed.
|
||||
|
||||
==== Feature modes
|
||||
`log`:: If this is enabled, the messages should be logged into the `modmailLog` post target when the thread is closed (by the respective commands). This is required for the command `closeNoLog` to be available. Enabled by default.
|
||||
`threadMessage`:: If this is enabled, every message which is send via the commands `reply` and `anonReply` will also be sent to the thread in order to have a visualizer how the message looks
|
||||
and to have a clear indication which messages were sent. Enabled by default.
|
||||
|
||||
|
||||
==== Emotes
|
||||
* `readReaction` to indicate to the user that the message sent was processed
|
||||
|
||||
==== Commands
|
||||
Opening a mod mail thread for a user::
|
||||
* Usage: `contact <member>`
|
||||
* Description: Creates a new mod mail thread with the `member`. Does not send a notification about the new thread.
|
||||
Adding a role to the roles responsible for managing mod mail threads::
|
||||
* Usage: `setModMailRole <role>`
|
||||
* Description: Adds this role to the roles responsible for mod mail threads, which means: this role will be pinged when a new thread is created and this role is automatically added to the roles allowed to execute all commands related to mod mail.
|
||||
Removing a role from the roles responsible for managing mod mail threads::
|
||||
* Usage: `removeModMailRole <role>`
|
||||
* Description: Removes this role from the roles responsible for mod mail threads, which means: this role will no longer be pinged when a new thread is created and this role will also be removed from the roles allowed to execute all commands related to mod mail.
|
||||
Changing the category in which the text channels are created::
|
||||
* Usage: `setModMailCategory <categoryId>`
|
||||
* Description: Sets the category which Abstracto uses to create the text channels containing the mod mail threads. The existing threads will not be migrated automatically.
|
||||
|
||||
NOTE: The following commands are only available within a mod mail thread.
|
||||
|
||||
Replying to a mod mail thread::
|
||||
* Usage `reply [text]`
|
||||
* Description: Sends `text` to the user if provided. `text` is optional, because its also possible to only send a picture.
|
||||
Replying anonymously to a mod mail thread::
|
||||
* Usage: `anonReply [text]`
|
||||
* Description: Sends `text` to the user without showing how is the author. Instead the avatar and name of Abstracto will be used.
|
||||
Enabling notifications of messages sent by the user::
|
||||
* Usage: `subscribe`
|
||||
* Description: Subscribes you to the current thread, and will ping you when a new message from the member arrives.
|
||||
Disabling notifications of messages sent by the user::
|
||||
* Usage: `unSubscribe`
|
||||
* Description: Removes your subscription from the current thread, and you will no longer be notified when a message from the member arrives.
|
||||
Closing the mod mail thread::
|
||||
* Usage: `close [note]`
|
||||
* Description: Closes the thread, deletes the text channel containing the thread and logs the interactions between the member and the moderators in the `modmailLog` post target. (only if `modmail_logging` is enabled)
|
||||
When closing a thread, a closing header with general information will be send and the note will be displayed there.
|
||||
When a thread is closed this way the user is notified of this.
|
||||
Closing the mod mail thread without notifying the user::
|
||||
* Usage: `closeSilently [note]`
|
||||
* Description: Closes the thread, deletes the text channel containing the thread and logs the interactions between the member and the moderators in the `modmailLog` post target. (only if `modmail_logging` is enabled)
|
||||
When closing a thread, a closing header with general information will be send and the note will be displayed there.
|
||||
Close a thread without logging::
|
||||
* Usage: `closeNoLog`
|
||||
* Description: Closes the thread without notifying the user and without logging the messages.
|
||||
* Mode Restriction: This command is only available when the feature mode `log` is enabled.
|
||||
|
||||
@@ -0,0 +1,60 @@
|
||||
=== Statistic
|
||||
|
||||
This component will contain multiple features, currently only emote tracking is available.
|
||||
|
||||
=== Emote tracking
|
||||
This feature is about tracking the usage of emotes from the server and external servers.
|
||||
The intention of this feature is to see what emotes are doing better than others and which emotes might be interesting to add to the server.
|
||||
|
||||
Feature key: `emote_tracking`
|
||||
|
||||
==== Feature modes
|
||||
`emoteAutoTrack`:: If this is enabled, emotes which are created within the server, are automatically stored and tracked. If they are renamed/deleted this will also be reflected automatically. Enabled by default.
|
||||
`externalEmotes`:: If this is enabled, every external tracked emote will be counted. It is also possible to track additional external emotes via the `trackEmote` command. Disabled by default.
|
||||
`autoTrackExternal`:: If this is enabled, every external emote which is used in a message by a server member will be automatically stored and tracked. `externalEmotes` needs to be enabled in order for this to function properly. Disabled by default.
|
||||
|
||||
==== Commands
|
||||
Creating a newly tracked emote::
|
||||
* Usage: `trackEmote <emote>`
|
||||
* Description: The `enoteName` needs to be a valid usage of an emote. If this emote is part of the server, it will now be automatically tracked.
|
||||
If the emote was tracked previously, it will be enabled again. For external emotes to be tracked this way, the feature mode `externalEmotes` needs to be enabled. The `emote` can either be a valid usage or the ID of an emote (it can only be an ID if it was previously tracked).
|
||||
Disable tracking for an emote::
|
||||
* Usage: `disableEmoteTracking [emote]`
|
||||
* Description: This command will cause the usages of `emote` to not be counted anymore. The `emote` can either be a valid usage or the ID of an emote. If `emote` is not given, the tracking for all tracked emotes is disabled.
|
||||
Show currently tracked emotes::
|
||||
* Usage: `showTrackedEmotes [showTrackingDisabled]`
|
||||
* Description: This commands shows the currently tracked emotes of this server. If ´showTrackingDisabled´ is `true` this command will also show the emotes for which the tracking is currently disabled.
|
||||
The shown tracked emotes are split into six groups: static/animated emotes from the server, static/animated emotes which previously existed on the server and static/animated external emotes. The categories for external emotes will not be shown if `externalEmotes` is disabled.
|
||||
If there are no emotes of a group, there will be no message.
|
||||
Show emote statistics of emotes in the server::
|
||||
* Usage: `emoteStats [period]`
|
||||
* Description: This command shows the amount each tracked emote from the server has been used overall. If a `period` is supplied, it will only show the amount of usages in that time period. If it is not provided, it will show the whole timeline.
|
||||
Beware that the amount of emotes is only tracked per day. For example, if it is 3PM UTC and you use `18h` as a timeperiod, it will also show the emote statistics for the day before.
|
||||
Show emote statistics of emotes previously in the server::
|
||||
* Usage: `deletedEmoteStats [period]`
|
||||
* Description: This command behaves the same way as `emoteStats` with the difference that it shows the emotes which were previously in the server. This means that the output will only show the name and the ID of the emote.
|
||||
Show emote statistics of external emotes::
|
||||
* Usage: `externalEmoteStats [period]`
|
||||
* Description: This command behaves the same way as `emoteStats` with the difference that it shows emotes which are not from this server. This means that the output will only show the name and the ID of the emote.
|
||||
* Mode Restriction: This command is only available when the feature mode `externalEmotes` is enabled.
|
||||
Synchronize the server emotes with the database::
|
||||
* Usage: `syncTrackedEmotes`
|
||||
* Description: This command cross checks the emotes in the database with the ones currently available in the server. If an emote was deleted in the server, but is still marked as available in the database, it will be marked as deleted. If an emote from the server is not available in the database, it will be created and tracked automatically.
|
||||
A message containing the amount of emotes deleted and created is shown. If the feature mode `emoteAutoTrack` is enabled, this should only be necessary in case the bot had an outage.
|
||||
Delete emote usages::
|
||||
* Usage: `purgeEmoteStats <emote> [period]`
|
||||
* Description: This command removes any stored usages of `emote`. The `emote` can either be a valid usage or the ID of an emote. If `period` is given, only usages within this time period will be deleted, if it is not provided, the complete timeline will be deleted.
|
||||
Deleting an individual tracked emote::
|
||||
* Usage: `deleteTrackedEmote <emote>`
|
||||
* Description: Deletes the tracked emote from the database including the usages. The `emote` can either be a valid usage or the ID of an emote.
|
||||
Reset emote statistics::
|
||||
* Usage: `resetEmoteStats`
|
||||
* Description: This will delete all emote usages and tracked emotes in the database.
|
||||
Show the image of external tracked emotes::
|
||||
* Usage: `showExternalTrackedEmote <emote>`
|
||||
* Description: Shows the ID, name, link to the image and the image directly for `emote` in an embed.
|
||||
* Mode Restriction: This command is only available when the feature mode `externalEmotes` is enabled.
|
||||
Export the stored emote usages::
|
||||
* Usage: `exportEmoteStats [period]`
|
||||
* Description: Creates a CSV file containing the emote usages and attaches it to a message. Each line in the file is the amount of usages of an emote per day. When an emote has not been used in a day, no line is present. If `period` is given, only usages from this time period will be exported, if it is not provided, the complete timeline will be exported.
|
||||
If the resulting file size is over the upload limit of the server, this command will not provide the file.
|
||||
@@ -0,0 +1,117 @@
|
||||
=== Reminders
|
||||
|
||||
Provides the ability to schedule reminders.
|
||||
|
||||
Feature key: `remind`
|
||||
|
||||
==== Commands
|
||||
Create a reminder::
|
||||
* Usage: `remind <duration> <text>`
|
||||
* Description: Creates a reminder with `text` which will be triggered after `duration`. This command uses duration parsing. The reminder will ping when the duration has passed and provide
|
||||
the context of the reminder.
|
||||
* Example: `remind 1h2m3s text` in order to be reminded in 1 hour 2 minutes and 3 seconds with the reason `text`
|
||||
Cancelling a reminder::
|
||||
* Usage `unRemind <reminderId>`
|
||||
* Description: Cancels this reminder reminder and will cause this reminder to not be executed.
|
||||
Listing all active reminders::
|
||||
* Usage: `reminders`
|
||||
* Description: Lists all the currently not yet executed reminders and information about each of them.
|
||||
|
||||
|
||||
=== Starboard
|
||||
|
||||
Provides the ability to track note worthy posts in a separate channel, identified by the post target `starboard`, because the pins within a channel are limited to 50.
|
||||
This feature works by users reacting to a message with the appropriate emote. By default this is `⭐`, but can be changed via the emote `star`.
|
||||
There is a configurable threshold a message needs to reach in order to be posted to starboard.
|
||||
The post in the starboard is continuously updated and depending on the current star count an associated emote is displayed.
|
||||
When the poster of the message reacts to the message with a star, this is not counted. When the post is deleted from the starboard, the original message cannot appear on the starboard again.
|
||||
|
||||
Feature key: `starboard`
|
||||
|
||||
==== Emotes
|
||||
* `star` to vote on posting something to starboard
|
||||
* `star1` for level 1 of starboard
|
||||
* `star2` for level 2 of starboard
|
||||
* `star3` for level 3 of starboard
|
||||
* `star4` for level 4 of starboard
|
||||
* `starboardBadge1` used as marker for first place in the command `starStats`
|
||||
* `starboardBadge2` used as marker for first place in the command `starStats`
|
||||
* `starboardBadge3` used as marker for first place in the command `starStats`
|
||||
|
||||
|
||||
==== Relevant system configuration
|
||||
`starLvl1` The amount of stars necessary to appear on the starboard. Default: 5
|
||||
|
||||
`starLvl2` The amount of stars necessary in order for the level 2 emote to be used in the starboard post. Default: 8
|
||||
|
||||
`starLvl3` The amount of stars necessary in order for the level 3 emote to be used in the starboard post. Default: 13
|
||||
|
||||
`starLvl4` The amount of stars necessary in order for the level 4 emote to be used in the starboard post. Default: 17
|
||||
|
||||
==== Post targets
|
||||
`starboard`:: The target used for the messages containing the starboard posts with the current star amount
|
||||
|
||||
==== Commands
|
||||
Showing starboard statistics::
|
||||
* Usage `starStats`
|
||||
* Description: Shows the most starred posts, the member with the most received stars and the members rewarding the most stars.
|
||||
|
||||
=== Suggestions
|
||||
|
||||
This feature provides the ability for members to post suggestions containing text to the post target `suggestions`. These suggestions can then be accepted or denied by the moderators.
|
||||
|
||||
Feature key: `suggestion`
|
||||
|
||||
==== Post targets
|
||||
`suggestions`:: the target of the messages containing the suggestions
|
||||
|
||||
==== Emotes
|
||||
* `suggestionYes` for up-voting a suggestion
|
||||
* `suggestionNo` for down-voting a suggestion
|
||||
|
||||
==== Commands
|
||||
Creating a suggestion::
|
||||
* Usage `suggest <text>`
|
||||
* Description: Posts the text to the `suggest` post target and places the emotes for up and down voting.
|
||||
Accepting a suggestion::
|
||||
* Usage `accept <suggestionId> [note]`
|
||||
* Description: Re-posts the suggestion identified by `suggestionId` and marks the suggestion as accepted. The optional `note` will be used in this re-post, if provided.
|
||||
* Example: `accept 1 okay` in order to accept the suggestion `1` with the reason `okay`
|
||||
Rejecting a suggestion::
|
||||
* Usage `reject <suggestionId> [note]`
|
||||
* Description: Re-posts the suggestion identified by `suggestionId` and marks the suggestion as denied. The optional `note` will be used in this re-post, if provided.
|
||||
* Example: `deny 1 not okay` in order to reject the suggestion `1` with the reason `not okay`
|
||||
|
||||
=== Miscellaneous
|
||||
|
||||
This feature provides some utility commands.
|
||||
|
||||
Feature key: `utility`
|
||||
|
||||
==== Commands
|
||||
Retrieving the URL of an emote::
|
||||
* Usage `showEmote <emote>`
|
||||
* Description: Posts the name of the emote accompanied with the URL where the image of the emote is stored.
|
||||
|
||||
Displaying the avatar or a member::
|
||||
* Usage: `showAvatar [member]`
|
||||
* Description: Displays the avatar of the given member accompanied with a URL to access it directly. If no member is provided, the member executing will be used.
|
||||
|
||||
Displaying information about members::
|
||||
* Usage: `userInfo [member]`
|
||||
* Description: Displays information about a member including: username, ID, activity, nickname (if any), date joined the server and date registered on discord.
|
||||
|
||||
Displaying information about server::
|
||||
* Usage: `serverInfo`
|
||||
* Description: Displays information about the server including: ID, server name, owner, member count, creation date, role count, server features and custom emotes of the server.
|
||||
|
||||
=== Link embeds
|
||||
|
||||
==== Emotes
|
||||
* `removeEmbed` to remove the embed of a link
|
||||
|
||||
This feature enables the automatic embedding of messages containing a message link.
|
||||
If a message contains a link to a discord message this will create an embed containing the the message content. This supports image attachments, but not videos or files.
|
||||
A reaction is placed on the embedded message which can be used to delete this embed. Only the original author and the person creating the embed can delete the embed this way.
|
||||
|
||||
Feature key: `link_embeds`
|
||||
Reference in New Issue
Block a user