Ecosyste.ms: Awesome

An open API service indexing awesome lists of open source software.

Awesome Lists | Featured Topics | Projects

https://github.com/hoshikoooo/discord-moderation-bot

A Discord moderation bot built with Node.js and Discord.js, designed to manage server members, enforce rules, and provide useful server information
https://github.com/hoshikoooo/discord-moderation-bot

bot-development discord discord-bot discord-js moderation moderation-bot open-source

Last synced: 2 days ago
JSON representation

A Discord moderation bot built with Node.js and Discord.js, designed to manage server members, enforce rules, and provide useful server information

Awesome Lists containing this project

README

        

---

# ๐ŸŒŸ Moderation Bot

A simple Discord moderation bot built with [Discord.js](https://discord.js.org/) to help manage your server effectively.

## โœจ Features
- ๐Ÿ”จ **Kick** users
- ๐Ÿšซ **Ban** users
- ๐Ÿ”‡ **Mute** and ๐Ÿ”Š **Unmute** users
- ๐Ÿงน **Clear** messages in bulk
- ๐Ÿ“œ Log moderation actions to a channel
- ๐Ÿ”’ Permission checks for moderation commands

## ๐Ÿš€ Setup

1. **Clone the Repository**
```bash
git clone
cd moderation-bot

2. Install Dependencies

npm install

3. Configure the Bot

Create a .env file (refer to .env.example for structure).

Add your bot token:

DISCORD_TOKEN=your-bot-token

4. Run the Bot

npm start

## ๐Ÿ“œ License
This project is licensed under the MIT License. See the [LICENSE](LICENSE) file for more information.

---

Feel free to reach out with any questions or open an issue if you encounter any problems! ๐Ÿค–

---
## ๐Ÿค Contributing

We welcome contributions to improve the **Moderation Bot**! Please follow the steps below to get started.

### ๐Ÿ› ๏ธ How to Contribute

1. **Fork the repository**: Click on the "Fork" button at the top right.
2. **Clone the repository**:
```bash
git clone https://github.com/hoshikoooo/moderation-bot.git

3. Create a new branch:

git checkout -b feature/YourFeature

4. Make your changes.

5. Commit your changes:

git commit -m "Add your descriptive commit message"

6. Push to your branch:

git push origin feature/YourFeature

7. Create a Pull Request: Submit your changes for review.

When submitting a Pull Request, please use the following template:

## ๐Ÿ“ Pull Request Title

### Description
- Briefly describe what this PR does.

### Related Issue
- Reference any related issues (if applicable).

### Checklist
- [ ] I have tested my changes.
- [ ] I have updated the documentation (if applicable).

๐Ÿ“œ Code of Conduct

Please adhere to our Code of Conduct.

---

Thank you for contributing to the Moderation Bot! Your help is greatly appreciated! ๐ŸŒŸ

### Notes

1. **Simplified Language**: The section is made straightforward to make it easy for newcomers.
2. **Contributor Template**: This template provides clear instructions for contributors when creating a pull request.
3. **Contact Information**: You can add your Discord or email at the end if you want.

### Final Steps

1. **Add this section** to your existing `README.md`.
2. **Save and commit the changes**:

```bash
git add README.md
git commit -m "Add simplified contribution guidelines and contributor template"
git push
```

## โญ Contributors

Thank you to all the contributors who helped improve the **Moderation Bot**! โค๏ธ




Hoshikoooo

Hoshikoooo