README.md

Telegram Relay Module

Telegram relay module for WildPHP.

System Requirements

If your setup can run the main bot, it can run this module as well. For the file server, a system is needed with sufficient disk space to host a very small webserver (will grow over time).

Installation

To install this module, we will use composer:

composer require wildphp/module-tgrelay

That will install all required files for the module. In order to activate the module, add the following line to your modules array in config.neon:

- WildPHP\Modules\TGRelay\TGRelay

The bot will run the module the next time it is started.

Configuration

First setup a Telegram bot. There are many guides on the internet for this. Add and adjust the following snipped in your config.neon:

telegram:
    port: 9093
    listenOn: '0.0.0.0'
    uri: 'http://localhost:9093'
    botID: 'your bot ID here'
    channels:
        'chat_id': 'irc_channel'

Usage

Link channels in the config. Use the /command command to send commands to the channel (to other bots e.g.).

Other modules can add commands to the bot.

License

This module is licensed under the MIT license. Please see LICENSE to read it.