Skip to content

Latest commit

 

History

History
118 lines (73 loc) · 2.67 KB

README.md

File metadata and controls

118 lines (73 loc) · 2.67 KB

🌟 AFK Remover Bot 🌟

A professional Discord bot designed to manage your server's AFK users effectively. Disconnects users from the configured AFK channel automatically, keeping your server active and organised.


✨ Features

  • 🔄 Auto-disconnects users from AFK channels.
  • 🌐 Multi-server support with independent configurations.
  • 🌎 Multi-language support: Includes English, Spanish, French, and more.
  • 🛠️ Configurable roles and channels using simple commands.
  • 📊 Periodic updates to ensure accurate server data.

🛠️ Prerequisites

Before you start, ensure you have the following installed:


🚀 Installation

1️⃣ Clone the Repository

git clone https://github.com/loadsec/AFK-Remover-Discord-Bot.git
cd afk-remover-bot

2️⃣ Install Dependencies

Using Yarn (🌟 Recommended)

yarn install

Using NPM

npm install

3️⃣ Configure Environment Variables

Create a .env file in the root directory and add the following:

BOT_TOKEN=your-bot-token
CLIENT_ID=your-bot-client-id

Replace your-bot-token and your-bot-client-id with your bot's token and client ID from the Discord Developer Portal.


🎯 Running the Bot

With Yarn 🌟

yarn start

With NPM

npm start

💻 Commands

/setup

  • 📋 Description: Configure the bot for your server.
  • 🔧 Options:
    • channel: Set the AFK voice channel (name or ID).
    • roles: Specify roles allowed to modify configurations (comma-separated).
    • language: Choose the server's language.

/afkinfo

  • 📜 Description: Display the current AFK settings for the server, including the channel, roles, and language.

🌍 Translations

The bot supports multiple languages! You can find translation files in the translations directory. To add a new language:

  1. 📁 Create a new .json file in the translations folder (e.g., es.json for Spanish).
  2. 📝 Follow the structure of existing translation files.

🤝 Contributing

We ❤️ contributions!

  1. Fork the repository.
  2. Make your changes.
  3. Submit a pull request with a detailed description.

💬 Need Help?

If you encounter any issues, feel free to open an issue or reach out to the contributors.

🌟 Thank you for using AFK Remover Bot! 🌟