1.3.1 • Published 5 months ago

cross-bot-bridge v1.3.1

Weekly downloads
-
License
MIT
Repository
github
Last release
5 months ago

Cross Bot Bridge

npm version Build Status License: MIT

A simple and customizable cross-bot bridge package that connects Discord and Telegram with admin and owner features, auto-reconnecting, media handling, message formatting conversion, user identity mapping, emoji and reaction support, and a command system.

Features

  • Cross-Platform Messaging: Relay messages between Discord and Telegram.
  • Admin and Owner Features: Special handling for messages from admins and the owner.
  • Auto-Reconnecting: Automatically reconnects on disconnection.
  • Media Handling: Handles images, videos, documents, and stickers.
  • Message Formatting Conversion: Consistent message formatting across platforms.
  • User Identity Mapping: Maps user identities between platforms.
  • Emoji and Reaction Support: Handles emojis and reactions.
  • Unified Messaging: Consistent message formatting across platforms.
  • Real-time Communication: Instant message relay.
  • Secure & Reliable: Built with security and reliability in mind.
  • Command System: Customizable commands.
  • Multi-Cross Bridge: Reply to messages across platforms.
  • Message Caching: Caches messages to handle rate limits and ensure consistent message delivery.
  • Advanced Command System: Supports complex commands and subcommands.
  • Customizable Prefixes: Allows users to set custom prefixes for commands.
  • Low Overhead: Lightweight and efficient.

Installation

Install the package using npm:

npm install cross-bot-bridge

Configuration

Create a config.json file in the root of your project with the following structure:

{
  "discordToken": "YOUR_DISCORD_BOT_TOKEN",
  "telegramToken": "YOUR_TELEGRAM_BOT_TOKEN",
  "telegramChatId": "YOUR_TELEGRAM_CHAT_ID",
  "discordPrefix": "Discord",
  "telegramPrefix": "Telegram",
  "commandPrefix": "!",
  "logLevel": "info",
  "admins": ["admin1", "admin2"],
  "owner": "ownerUsername",
  "userMapping": {},
  "customPrefixes": {
    "discord": "!",
    "telegram": "/"
  },
  "messageCacheSize": 100
}

Replace the placeholders with your actual tokens, chat ID, admin usernames, and owner username.

Usage

Create an index.js file and use the package as follows:

const CrossBotBridge = require('cross-bot-bridge');
const bridge = new CrossBotBridge();

bridge.start();

Run your bot using the following command:

npm start

Example

Here is an example of how you can set up the config.json and index.js files:

config.json

{
  "discordToken": "YOUR_DISCORD_BOT_TOKEN",
  "telegramToken": "YOUR_TELEGRAM_BOT_TOKEN",
  "telegramChatId": "YOUR_TELEGRAM_CHAT_ID",
  "discordPrefix": "Discord",
  "telegramPrefix": "Telegram",
  "commandPrefix": "!",
  "logLevel": "info",
  "admins": ["admin1", "admin2"],
  "owner": "ownerUsername",
  "userMapping": {},
  "customPrefixes": {
    "discord": "!",
    "telegram": "/"
  },
  "messageCacheSize": 100
}

index.js

const CrossBotBridge = require('cross-bot-bridge');
const bridge = new CrossBotBridge();

bridge.start();

Contributing

We welcome contributions to the project! Here are a few ways you can help:

  • Report bugs and suggest features via GitHub Issues.
  • Fork the repository and submit pull requests.
  • Improve documentation.

License

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

Acknowledgments


Made with ❤️ by RishBroProMax