[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

abstracto-application/documentation/src/main/docs/asciidoc/modules/utility.adoc

@@ -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 `&#11088;`, 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`