GalaxyCogs/README.md
Seaswimmer cc6f20c62a
All checks were successful
Pylint / Pylint (3.10) (push) Successful in 1m1s
Pylint / Pylint (3.11) (push) Successful in 52s
Pylint / Pylint (3.9) (push) Successful in 54s
Update README.md
2023-10-20 14:37:21 +00:00

72 lines
2.3 KiB
Markdown

# GalaxyCogs
Repository for Redbot cogs developed by the Galaxy Discord Management team.
## ExportChannels **(WIP)**[^incomplete]
This cog allows you to easily export channels using Discord Chat Exporter.
**THIS COG IS NOT INTENDED FOR EXTERNAL USE. YOU WILL LIKELY HAVE TO RUN THIS COG LOCALLY AND MODIFY CODE SHOULD YOU WISH TO USE IT.**
### **Credit to Tyrrrz for the bundled version of Discord Chat Exporter within this cog. The original repository can be found [here](https://github.com/Tyrrrz/DiscordChatExporter).**
## Galaxy
Utility cog designed specifically for use on the Galaxy Discord server.
Includes:
* Warehouse command
* FAQ command
* Unix command
## Info
Combination of a few built-in Red cogs + some custom code to provide commands that show information of specific Discord objects.
Currently supports:
* Users
* Servers/Guilds
* Roles
## MusicDownloader[^incomplete]
Allows users to download **just the audio files** from any YouTube video. Currently only supports YouTube and does not work for video.
Currently partially broken on **just old versions of Red**, if you're on an old version (such as `3.4.18`) please download [this database file](https://zip.seaswimmer.cc/u/Music%20Downloader.db) and put it in your cog data directory for this cog, which should be
```md
<where-ever you've installed red>/Red-DiscordBot/data/<instance name>/cogs/MusicDownloader
```
## Podcast **(WIP)**[^incomplete]
Allows users to submit questions to a specified channel, intended for use with podcasts.
Also features user blacklists, both configurable per-server and globally.
[^incomplete]:
This cog currently is non-functional. This notice will be removed once the Cog is completed.
## Shortmute
Allows staff members to shortmute individuals for up to 30 minutes, using Discord's Timeouts feature.
## Suggestions
Allows users to submit suggestions to a specified channel. Highly cut-down modification of [SauriCog's Suggestions Cog](https://github.com/elijabesu/SauriCogs).
Features:
* Separate approved and denied channels
* Custom emoji support
## SugonCredit[^incomplete]
Implements a way for moderators to give out social-credit like points, dubbed 'sugoncredits' by the community.
Features:
* Add Credit to people.
* Remove Credit from people.
* Supports custom currency names and bank names.