/lui-cogs-v3

Cogs for Red-DiscordBot (v3), used by the SFU Anime Club. Branches for dpy1 and dpy2. See Injabie3/lui-cogs for Redv2/dpy0 cogs.

Primary LanguagePython

lui-cogs-v3

Custom cogs for Red-DiscordBot v3, used by the SFU Anime Club.

Red-DiscordBot v3.5.x / discord.py v2.x Only!

This branch contains cogs suitable for Red-DiscordBot v3.5.x/discord.py v2.x only. For Red-DiscordBot v3.4.x/discord.py v1.7.3, please use the dpy1 branch!

Cogs

Below are some of the cogs we have.

Ready

  • birthday: Ping a guild member on their birthday, and assign a special role to them.
  • goodsmileinfo: Post updates from Good Smile Company to a guild text channel.
  • highlight: Get notified outside of at-mentions about words that you care about.
  • heartbeat: Ping an uptime checker to report that all is well with the bot.
  • qrchecker: Scan image attachments for QR codes, and post their contents.
  • respects: Press f to pay respects. Has the ability to group multiple fs into one message, and supports replies.
  • roleassigner: Randomly assign roles to guild members from a pool of roles. Can also remove roles from guild members from a pool of roles.
  • servermanage: A cog to manage a server's icon and banner images. It can schedule icon and banner changes on certain days at midnight.
  • sfu: Access publicly available information from Simon Fraser University, including campus webcams, course information, and road report.
  • slashsync: Automatically sync slash commands when the bot starts up, and exposes a [p]sync command to sync commands on demand after loading or unloading a cog.
  • spoilers: A v3 port of our legacy v2 emoji-based spoiler cog, before Discord implemented spoilers natively in the client.
  • tags: A v3 port of tags from Rapptz's RoboDanny bot, with additional functions such as limiting the number of tags per role, ability to transfer ownership of tags. Generic tags are disabled.
  • triggered: A triggered GIF image creator.
  • welcome: Welcome a new guild member with a custom message in a guild text channel. Also has the ability to send them a DM with a custom message, and logging member names and IDs when they join and leave a guild to a particular text channel.
  • wordfilter: Regular expression-based filtering, with the ability to turn it off in exceptional cases such as moderators or above, or in certain channels. Includes hooks for other cogs to use.
  • yourlsClient: Control your YOURLS instance from Discord! Configurable on a per guild basis.

Experimental

  • afterhours: An SFU Anime Discord-specific cog used to add special exceptions. It is used in tandem with the tempchannels cog. Its usage is limited outside the scope of this guild.
  • catgirl: A v3 port of my previous catgirl cog on v2. Needs refactoring. Adding new images requires backend console access.
  • rss: An RSS feed poster. Requires backend console access.
  • smartreact: A v3 port of smartreact from flapjax/FlapJack-Cogs. There is probably a v3 port from the original author.
  • tempchannels: Create 1 temporary channel that is automatically deleted after the configured duration expires.

Unsupported

The following cogs are currently not supported with discord.py v2.x:

  • avatar: Save avatar images of all users when they change, which is useful for making videos for the server. Requires backend console access.
  • stats: WIP.

Important Notes

  1. tags
    • Using the alias toggle requires modification to Red's Alias cog.
  2. yourlsClient
    • The edit and rename commands requires the yourls-api-edit-url plugin to be installed on your YOURLS instance.
    • The delete command requires the yourls-api-delete plugin to be installed on your YOURLS instance.
    • The search keyword requires the yourls-api-search-keywords plugin to be installed on your YOURLS instance.

Installation

This assumes that you have a functioning deployment of Red-DiscordBot v3, and that your prefix is ren (replace with your bot's prefix).

  1. Make sure the Downloader cog is loaded: renload downloader
  2. Add the repo to your instance: renrepo add lui-cogs https://github.com/Injabie3/lui-cogs-v3
  3. Install the cog you want: rencog install lui-cogs <cogName>
  4. Load the newly installed cog: renload <cogName>

Support

As this is a side project, I am not able to provide support in a particularly timely manner. That being said, if you find any issues, please feel free to open an issue in this repo or the SFUAnime/Ren repo, and we can take a look into it.