Skip to content

Latest commit

 

History

History
87 lines (60 loc) · 3.36 KB

README.md

File metadata and controls

87 lines (60 loc) · 3.36 KB

📚 Pairing Bot (It's like Tinder but on Discord! 💌)

Pairing Bot is a versatile and powerful tool created specifically for Discord servers. 🌟 It is designed to help users connect with each other based on shared interests and preferences. This bot can automatically match users who have similar hobbies, topics of interest, or goals, encouraging meaningful interactions and discussions within your server. 🤝

Whether you're managing a community server focused on a specific topic, a social group looking to deepen connections, or any server where you want to promote engagement among members, Pairing Bot is the perfect solution. By facilitating these connections, the bot helps foster a more interactive and supportive community environment. 🌐

With Pairing Bot, you'll be able to:

  • Enhance Engagement: Encourage members to participate more actively by connecting them with like-minded individuals. 🔗
  • Promote Networking: Help users expand their network within the server by introducing them to others with similar interests. 🤗
  • Build Community: Strengthen relationships and build a more cohesive community by facilitating meaningful interactions between members. 🏗️💬

🌟 Features

  • 🔗 User Pairing: Match users based on shared interests.
  • Cooldown Period: Prevents rapid re-pairing with a configurable cooldown.
  • 📊 User Profiles: Display user profiles with their interests, bio, and links.
  • 📝 Logging: Comprehensive logging system to monitor bot activities.
  • 🔄 Automated Status Updates: Keep your server informed about the bot's status.
  • 🛠️ Custom Commands: Easily extendable with custom commands.

🚀 Getting Started

Follow these instructions to get the bot up and running on your server.

Prerequisites

Installation

  1. Clone the repository:

    git clone https://github.com/yourusername/pairing-bot.git
    cd pairing-bot
  2. Install dependencies:

    yarn install
  3. Set up environment variables:

    Create a .env file in the root directory and add your Discord bot token:

    DISCORD_TOKEN=your_discord_bot_token
  4. Build the project:

    yarn build
  5. Run the bot:

    yarn dev

🛠️ Usage

Once the bot is online in your server, use the available commands to interact with it. The bot will automatically start pairing users and updating statuses based on server activity.

Available Commands

  • /pair - Initiates a pairing session.
  • /profile - Displays your current profile.
  • /update - Update your profile details.
  • /help - Lists all available commands.

🛡️ Contributing

We welcome contributions! Follow these steps to contribute to the project:

  1. Fork the repository.
  2. Create a new branch: git checkout -b feature/your-feature-name
  3. Commit your changes: git commit -m 'Add a new feature'
  4. Push to the branch: git push origin feature/your-feature-name
  5. Submit a pull request.

📜 License

This project is licensed under the MIT License - see the LICENSE file for details.

Enjoy using Pairing Bot and watch your server's engagement and connectivity flourish! 🎉🚀