You cannot select more than 25 topics
Topics must start with a letter or number, can include dashes ('-') and can be up to 35 characters long.
27 lines
1.5 KiB
Markdown
27 lines
1.5 KiB
Markdown
# Mee2 Essentials Cog
|
|
|
|
[![MIT License](https://img.shields.io/badge/License-MIT-blue.svg)](https://opensource.org/licenses/MIT)
|
|
|
|
## Introduction
|
|
|
|
Mee2 Essentials Cog is an official cog for the Mee2 Discord bot. This cog contains essential features that are commonly used in a Discord bot.
|
|
|
|
## Commands
|
|
|
|
- `/embed [title] [content] [color] [footer]`: Creates an embed with the given properties and sends it to the channel where the command was used.
|
|
- `/say [message]`: Sends the given message to the channel where the command was used.
|
|
- `/ping`: Responds with "Pong!".
|
|
- `/serverinfo`: Sends an embed with information about the server, such as role count, member count, owner, text channels, voice channels, boost level, when it was created, max file size, and ID.
|
|
- `/clean [amount]`: Deletes the specified amount of messages in the channel where the command was used. If no amount is specified, it will default to 10.
|
|
- `/lock`: Locks the channel where the command was used.
|
|
- `/unlock`: Unlocks the channel where the command was used.
|
|
- `/lockdown`: Locks the whole server down so the default role can't type in any channel.
|
|
- `/unlockdown`: Unlocks the whole server so the default role can type where they could before
|
|
|
|
## Installation
|
|
|
|
1. Clone the repository or download the code as a ZIP file and extract it.
|
|
2. Copy the essentials folder to your Mee2 bot's cogs folder
|
|
3. Add essentials to your bot's config.toml file under the cogs list example: cogs=["cogs.example","cogs.Essentials.commands"]
|
|
|