Skip to content

Latest commit

 

History

History
116 lines (81 loc) · 4.56 KB

README.md

File metadata and controls

116 lines (81 loc) · 4.56 KB
Raw

interchat logo

InterChat

A powerful Discord bot for easy and real-time chatting hubs across multiple Discord servers.

Maintainability GitHub package.json version Discord Bots Discord


🌟 Features

  • 🔗 Cross-Server Messaging: Connect channels from different servers and allow users to chat in real-time.
  • 🕸️ Flexible Webhooks: Utilizes webhooks per channel to ensure uninterrupted communication.
  • ⛔ Block Word Lists: Set up custom block word lists to filter or block specific words and regex patterns in messages.
  • 🛠️ Cross-Server Moderation: Manage users with built-in NSFW detection and infraction system. Track blacklists, infractions, and appeal requests through modals.
  • 🆓 Generous Free Tier: Enjoy most features at no cost!
  • 🌱 Mini-Communities: Form your own "Hubs" by connecting specific channels across multiple servers for shared conversations.

🚀 Getting Started

  1. Invite InterChat to your Discord server using this link.
  2. Use the /hub browse command to configure your first hub.
  3. Connect a channel to a hub containing many other discord servers using the /hub join command.
  4. Start chatting across servers!

For detailed instructions, check out our Documentation.

💻 Self-Hosting

While InterChat is available as a hosted bot, you can also self-host it. Follow these steps:

  1. Clone the repository:

    git clone https://github.com/discord-interchat/interchat.git

  2. Install dependencies:

    pnpm install

  3. Set up your .env file with your Discord bot token and other required environment variables.

  4. Run the bot:

    pnpm dev

🤝 Contributing

We welcome contributions to InterChat! Here's how you can help:

  1. Fork the repository.
  2. Create a new branch for your feature or bug fix.
  3. Make your changes and commit them with a clear commit message.
  4. Push your changes to your fork.
  5. Submit a pull request to the main repository.

Please read our Contributing Guidelines for more details.

📜 License

InterChat is licensed under the GNU Affero General Public License v3.0 (AGPL-3.0). This license requires that the software and any modifications remain free and open source and that the source code must be made available when the software is used as a network service. For full terms and conditions, see the LICENSE file in the repository.

📞 Support

If you need help or have any questions, join our Discord support server.

✨ Acknowledgements

Thanks to the Discord community and all our contributors:

Made with ❤️ by the InterChat Team!