GalaxyCogs/README.md

84 lines
2.8 KiB
Markdown
Raw Normal View History

2023-02-27 11:36:15 -05:00
# GalaxyCogs
2023-03-04 16:25:59 -05:00
<p align="center">
<a href="https://discord.com/invite/robloxgalaxy">
2023-03-04 16:27:44 -05:00
<img src="https://discordapp.com/api/guilds/204965774618656769/widget.png?style=shield" alt="Galaxy Discord Server">
2023-03-04 16:25:59 -05:00
</a>
<a href="https://www.python.org/downloads/">
<img alt="PyPI - Python Version" src="https://img.shields.io/pypi/pyversions/Red-Discordbot">
</a>
<a href="https://github.com/Rapptz/discord.py/">
<img src="https://img.shields.io/badge/discord-py-blue.svg" alt="discord.py">
</a>
</p>
Repository for Redbot cogs developed by the Galaxy Discord Management team.
2023-03-04 16:28:12 -05:00
## ExportChannels **(WIP)**[^incomplete]
2023-08-01 15:34:27 -04:00
2023-03-20 13:02:20 -04:00
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).**
2023-03-20 13:01:10 -04:00
2023-03-04 16:25:59 -05:00
## Galaxy
Utility cog designed specifically for use on the Galaxy Discord server.
2023-03-04 16:25:59 -05:00
Includes:
2023-03-04 16:25:59 -05:00
* Warehouse command
* FAQ command
* Unix command
2023-03-04 16:34:58 -05:00
2023-03-04 16:25:59 -05:00
## Info
2023-03-04 16:25:59 -05:00
Combination of a few built-in Red cogs + some custom code to provide commands that show information of specific Discord objects.
2023-03-04 16:34:58 -05:00
2023-03-04 16:25:59 -05:00
Currently supports:
2023-03-04 16:25:59 -05:00
* Users
* Servers/Guilds
2023-08-08 22:03:51 -04:00
* Roles
2023-03-04 16:34:58 -05:00
## MusicDownloader
Allows users to download **just the audio files** from any YouTube video. Currently only supports YouTube and does not work for video.
2023-08-08 22:03:51 -04:00
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://drive.google.com/file/d/11Ena7bPrF7eVhR9ZVmdXb0hHCg-0I76d/view?usp=sharing) and put it in your cog data directory for this cog, which should be
```md
2023-08-02 01:17:33 -04:00
<where-ever you've installed red>/Red-DiscordBot/data/<instance name>/cogs/MusicDownloader
```
## Podcast **(WIP)**[^incomplete]
2023-03-04 16:34:58 -05:00
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]:
2023-08-08 22:03:51 -04:00
This cog currently is non-functional. This notice will be removed once the Cog is completed.
## Shortmutes **(WIP)**[^incomplete]
2023-03-04 16:34:58 -05:00
Allows staff members to shortmute individuals for up to 30 minutes, using Discord's Timeouts feature.
## Suggestions
2023-03-04 16:34:58 -05:00
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
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.