Sheldan/abstracto
1
0
Fork 0
mirror of https://github.com/Sheldan/abstracto.git synced 2026-03-24 13:44:33 +00:00
Code Issues Packages Projects Releases Wiki Activity

added documentation of user notes

Browse Source
This commit is contained in:
Sheldan
2020-05-17 23:18:49 +02:00
parent 20f8e422a2
commit b45f5abd8e
1 changed files with 22 additions and 0 deletions
Download Patch File Download Diff File Expand all files Collapse all files

22
abstracto-application/documentation/src/main/docs/asciidoc/features/moderation.adoc
View File

@@ -111,8 +111,30 @@ Only *one* role can be used as a mute role.
This feature provides a range of utilities to monitor the server.
The logging includes:
Feature key `logging`
Deleted message logging:: When a message is deleted, the content of the message and the possible attachments of said message will be logged. Post target `deleteLog`.
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. Post target `editLog`.
Member joining logging:: When a member joins the guild, a message indicating this is send. Post target `joinLog`.
Member leaving logging:: When a member leaves the guild, a message indicating this is send. Post target `leaveLog`.
=== 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`.