Skip to content

Latest commit

 

History

9 Commits

Folders and files

NameName
Last commit message
Last commit date
 
 
 
 
 
 
 
 

Repository files navigation

🚀 Union-bot

Union-bot Badge

Union-bot is a modular JavaScript bot designed to automate tasks, manage your community, and bring your server to life! 🎉🤖


🔍 Table of Contents

  1. ✨ Features
  2. 📦 Installation
  3. ⚙️ Configuration
  4. ▶️ Usage
  5. 📜 Commands
  6. 🛠️ Troubleshooting
  7. 🤝 Contributing
  8. ✉️ Contact

✨ Features

  • Modular Command System: Easily add, remove, and customize commands 🔌
  • 🔒 Permission Management: Control access by role 🛡️
  • 🤖 Auto-Moderation: Anti-spam, profanity filter, and link moderation 🚫
  • 🎉 Fun & Utility Commands: Memes, polls, reminders, and more 🎈
  • 🔗 Extensible Plugins: Integrate third-party APIs or your own modules 🌐

📦 Installation

  1. Clone the repository:

    git clone https://github.com/0x062/Union-bot.git
    cd Union-bot
  2. Install dependencies:

    npm install
  3. Create a .env file based on the example:

    # .env
    BOT_TOKEN=your_discord_bot_token 🔑
    PREFIX=! ⚡️

⚙️ Configuration

Configure config.json or environment variables:

{
  "prefix": "!",         // 🔣 Command prefix
  "ownerID": "YOUR_ID", // 👑 Your user ID
  "intents": ["GUILDS", "GUILD_MESSAGES"],
  "partials": ["MESSAGE", "CHANNEL", "REACTION"]
}
  • prefix: Command trigger (e.g., !, ?)
  • ownerID: Discord ID for owner-only commands
  • intents & partials: Discord.js options

▶️ Usage

Start the bot:

npm start 🚀

Or run in development mode with live reload (if configured):

npm run dev 🔄

📜 Commands

Command Description
!help 📖 Display all available commands
!ping ⚡️ Check bot latency
!ban @user 🔨 Ban a user from the server
!kick @user 👢 Kick a user from the server
!mute @user 🤫 Mute a user
!poll "Q?" 📊 Create a yes/no poll
!remind 10m ⏰ Set a reminder (e.g., 10m, 1h)

💡 You can add custom commands in the commands/ folder! 🌟


🛠️ Troubleshooting

  • Bot not responding: Verify your token and bot status.
  • ⚠️ Missing permissions: Ensure the bot has the correct roles and permissions.
  • 🐛 Startup errors: Delete node_modules and run npm install again.

Need more help? Open an issue on the repository.


🤝 Contributing

Contributions are welcome! Follow these steps:

  1. Fork the repository 🍴
  2. Create a feature branch (git checkout -b feature/YourFeature) 🌱
  3. Commit your changes (git commit -m "Add YourFeature") 📝
  4. Push to the branch (git push origin feature/YourFeature) 🚚
  5. Open a pull request 🔃

Please adhere to the Code of Conduct. 🙏


✉️ Contact

Thank you for using Union-bot! 🙌

About

No description, website, or topics provided.

Resources

Stars

1 star

Watchers

1 watching

Forks

Releases

Packages

Used by

Contributors

Languages