pklempe / sam Goto Github PK

As with #21 Data can be requested from ufind and we simply need to parse the XML.

Users should be able to pin a message in a channel by reacting to it.
For example: If at least 10 users react to a message with "📌", it will be pinned by SAM.

Current log message format:
INFO 2020-08-20 15:29:01,642: Command ping called by PKlempe#0001 in channel bot-testing

Suggested changes for better readability:
INFO 2020-08-20 15:29:01,642: Command "ping" called by PKlempe#0001 in channel [#bot-testing]

Implement a command which makes the bot post an embeded message containing some information (and maybe some stats) about itself and a link to the GitHub repository.

A command which makes SAM post a message at a specified time. To be more specific, the server owner should be able to specify a message which gets automatically posted by SAM in a specified channel at a specfied time.

For example: Lets say we want SAM to wish everyone on the server "Merry Christmas" on the 24th of December. This could be done by posting a message in the news channel but we don't want to constantly remind ourselves to write it. That's why it would be a good idea to schedule one and SAM does the rest.

A collection of commands which let the moderators do their job.

Possible commands for punishments:

• warn
• kick
• ban
• mute
• setnick (changes nickname on server)
• purge (messages)
• lock (locks a channel by changing its permissions)

Possible commands for information gathering:

• newusers
• notes
• avatar (shows a users avatar)
• info (get some info about a user)
• nicknames (nickname history of a user)

Special version of these commands (e.g.: tempmute, clear warns) or other useful extensions haven't been explicitly mentioned here.

Very handy if you want to keep conversations out of a channel so that only bot messages remain. This way people can invoke commands in there but the channel remains "clean".

Useful for modmail, rule enforcement and similar channels where you want to keep an overview.

A command which adds so called reaction roles to a message posted by the bot. By clicking on one of the reactions, a specified role will be given to the user.

By entering the command the bot gets all the exam dates for a specific course from u:find and posts them as an embed on Discord.

A command which lets users submit suggestions which will then be posted in a specific channels for people to vote on. Voting happens via two reactions. If enough up- or downvotes have been made and the difference between them is kinda significant, the embed of the suggestion should change its color. This signals if the idea is popular or not.

Some other commands for moderators to mark suggestions as "approved", "denied", "considered" or "implemented".

A command which lets user add course roles to themselve so that they can unlock channels for specific courses on their own.

e.g. !add mg1 which would add the server role called "MG1" to a user.

Of course this shouldn't be possible for server roles with higher permissions like "Moderator" for example.

In the case that someone breaks the server rules, users should be able to report specific persons to the moderators. This could be done via a command like !report [User] where you should be able to simply write a users nickname instead of direlcty mentioning him. The second could trigger a notification which will then be sent to the offender, which results in him/her knowing, who informed the moderators.

To inform the moderators, an embed will be posted in a configured report channel on the server.

Title says it all. IDs are unique, names are not. The code breaks if there are two channels with the same name or simply doesn't work if a channel gets renamed.

A command which reminds a user about something after a specified time is over.

A command which shows some interesting stats about our server like amount of users, channels, etc.

A command which lets moderators remove the last x messages in a channel. The command should have a hard coded limit of 100 messages and can only be used in the channel in which it has been invoked (no channel mentions possible).

Instead of parsing IDs or mentions ourselve we should use the converters provided by the library. This way we don't need to handle a lot of stuff like getting a Channel or User object and checking if the input is valid.

Administrative actions like restarting the bot, changing its configuration or simply unloading/reloading cogs.

Improving our code by using the context variable whenever possible instead of making some other method or API calls.

So instead of Bot.get_guild() whe should use the guild attribute of the context and therefore for Bot.get_user() use guild.get_member().

We will need a database access for many operations which require configuration, like commands that should make the bot do something in a special channel or let the bot send a specific message repeatedly. Things like the message or the channel for the specific command need to be persisted so the bot wont forget them once configured.

This issue is only about creating a database with a fitting (and extendable) design for this and creating code to access it correctly.

The bot should automatically send a welcome message to each new user who joins the server.

A command which let's the server admin change the bots presence on Discord. The presence consists of the following:

• activity: The activity being done.
• status: The online status.
• afk: Indicator if you are AFK.

Extend #26 by adding a subcommand so moderators can query for modmails with a specific status. The results should be shown in an embeded message with the entries as hyperlinks to the corresponding messages.

A command which lets users write a message to all the mods. This could be achieved by posting them in a specified channel in the hidden category for moderators.

We need a way to save and provide uploaded files to discord.

Main challenges :
-save space
-only upload files that are relevant
-get metainformation about the files without too much hassle for the user providing
-provide in a easily searchable way

Ideas:
-Compress files after uploading
-Add reactions to each file posted. If the author (or a mod) clicks the reaction, the file will be added to the corresponding category
-Enforce a naming scheme that provides information (ideas?)
-Command for search where bot lists available files to user based on search and sends the selected to him (all in DM)

Implement a command which returns the current ping in milliseconds.

The command should be inside the Admin Cog and can therefore only be invoked by the server owner.

This way we can deactivate specific kinds of commands or introduce new ones without taking the bot offline. Once the extension reloads, any changes that we did will be applied.

We need to set up the project in a manner that allows it to be extensible and to properly organize the code in a way, that we do not lose the overview.
Suggestion: https://the-hitchhikers-guide-to-packaging.readthedocs.io/en/latest/quickstart.html

As the title says. This could be a single command like !role [Role] [User] which adds/removes the specified role depending on if the user already has it or not.

Trakt.tv integration for getting information about movies, series and newly released stuff.

A command which lists all the different Cogs and if they are loaded/unloaded at the moment. This should be a part of the Admin Cog and can therefore only be invoked by the server owner.

When a user changes his nickname, the old one should be stored in our database. This way we can implement a command which shows us all the different names a user had on our server so that moderators always know who is who and people cannot simply change their name to hide from them.

Add a command that allows users to report bugs or feedback directly related to the bot and its implementation (the bot could eventually even create a github issue)

A command for posting a weather report for Vienna.

The current layout used for the embed listing all currently opne/assigned modmail tickets isn't mobile friendly. Inline embed fields will simply be put beneath each other which results in all timestamps being under the actual tickets. This makes it hard to see which timestamp belongs to which ticket.

A command which makes the bot post a message. If a channel has been specified, the bot should post the message there and if not, it should post it in the current channel where the command has been invoked.

Functionality to log calls to the commands.
Logs which command was when called by which user in which channel.
Possibility to log to console and to file.

Also check which exceptions will actually be thrown and why.

We need a Github Action that performs our build process each time a Pull Request is created to master.

The build process should consist of at least:

1. Running pylint on the code
2. Running mypy on the code
3. Running pytest to run all tests

All precoditions must be met (pip install requirements etc.)

A command which makes SAM post an embedded message in a specified channel.

A dedicated text channel where users can exchange their assigned groups via a bot command. This could be combined with #41 so that only SAMs messages remain in the channel and therefore keeping it clear.

After a user has made an offer, an embeded message should be posted which contains every relevant information for an exchange (e.g. user, course, group, etc).
SAM should also be able to inform users via DM about possible exchange partners. Users should also be able to revoke their offer if they've successfully changed groups or simply changed their mind.

Title says it all. Could be useful if a command is being abused in some way and we have to act quickly. While it's disabled we have all the time we need to work on a solution.

Fixed channels (modmail, report, group_exchange,...) should be loaded when the bot starts in the init_function and held there as a class variable to be used.
This has several advantages:

Code is shorter and better to read:

await ctx.guild.get_channel(constants.CHANNEL_ID_REPORT).send(embed=embed)
#vs
await report_channel.send(embed=embed)

Probably speeds up the command minimally as no search (through all guilds) for the channel has to happen when the command is invoked.

Bot throws an Error immediately on startup if the channel id is invalid instead of on first command invokation.

Improve existing code by implementing #85, #94, moving server specific values into .env, improving message layouts and other miscellaneous stuff that will be found on the way.

Discord added the possibility to convert a normal Discord server to a Community Server. This means that there is now a new server feature "COMMUNITY" which now has to be considered for our "serverinfo" command to work.

Implement functionality so that the bot can independently detect Spam or other unwanted stuff and act accordingly by removing messages and punishing users.

Possible things the bot should look out for:

• Spam
  • too many messages
  • too many attachments
  • too many mentions
  • too many links
• Capslimit
• Bad words
• Bad links
• Line break limit

Possible punishments:

• Warnings
• Tempmutes
• Kick
• Ban
• Tempban

One could even implement punishment levels which get triggered by getting a specific amount of warnings.

Regarding #67: Show the total number of warnings which the accused person has.