Skip to content

Latest commit

 

History

History
66 lines (55 loc) · 9.01 KB

README.md

File metadata and controls

66 lines (55 loc) · 9.01 KB

User Made-with-Python Database-MongoDB Code-Style GitHub-License

Modmail Plugins

Custom plugins for Modmail bot. Checkout the wiki for latest news and additional info.

Important: Plugins with * mark after their names in the table below require Extended Utils plugin to work. It must be installed before those ones with *. Otherwise you have to remove and reinstall those plugins. To install Extended Utils plugin, use command:

?plugin add Jerrie-Aries/modmail-plugins/utils

List of plugins

Announcement Embed Manager Extended Utils General Info Giveaway Invites Keepalive Logviewer Moderation Role Manager RTFM Support Utility Trivia

Name Name for command Description
Announcement announcement Post announcements on your server with this plugin. Publishing announcements to subscribed channels is also supported.
Embed Manager* embedmanager Manage, post, edit, store embeds with this plugin. This plugin is a modified version of embedutils cog made by PhenoM4n4n. Any credits must go to original developer of this cog. Original repository can be found here.
Extended Utils utils Entended utils from various sources to work with other plugins.
General Info generalinfo Get general information about bot, guild member, Discord user, server and many more.
Giveaway giveaway Host giveaways on your server with this plugin. The source code was from officialpiyush/modmail-plugins/giveaway.
Invites* invites Checks which invite is used when someone joins the server, and the log embed will be posted in the designated channel.
Keep Alive keepalive Hosting on Replit? Keep Alive plugin is specifically for those who host their bots on Replit. This plugin will keep your bots up using UptimeRobot service to ping the web server created by the plugin. Read Keep Alive plugin wiki for more info.
Logviewer logviewer Start the logviewer server with plugin? Yes. This plugin is a modified version of modmail-dev/logviewer. Any credits must go to original developers. If you want to use this plugin, make sure to read the wiki first.
Moderation* moderation Moderate your server with moderation plugin. This plugin supports kick, ban, add/remove roles, mute and temp mute, change nicknames, and many more.
Role Manager* rolemanager Manage roles on your server. This plugin includes Auto Role, Mass Roling, Reaction Roles, and Targeter (a tool to search members that match the given args). This plugin is a combination and modified version of roleutils cog made by PhenoM4n4n, and targeter cog made by NeuroAssassin.
RTFM rtfm RTFM commands for developers to easily fetch discord.py and python documentation links. Converted from RoboDanny.
Support Utility* supportutils Addtional tools to enhance Support members' experience. Contact Modmail using button or dropdown. Users submit their feedback after the ticket is closed.
Trivia* trivia Play trivia with friends on your server. This is a modified version of cogs trivia of Red-DiscordBot. I just made it compatible with Modmail bot. Any credits must go to original developer. You can find the source here.

* : Requires Extended Utils plugin to work.

How to install

Use the format of ?plugin add Jerrie-Aries/modmail-plugins/<plugin_name><@branch> where <plugin_name> (use without < and >) is the name of the plugin file. <@branch> is optional, defaults to master.

Example:

?plugin add Jerrie-Aries/modmail-plugins/moderation

to add the Moderation plugin.

Reporting bugs and errors

If you encounter any bugs or errors, just open a new issue here and report it. Or you can report it on Modmail's support server in #plugin-support channel.