Plugins

Lightning uses a plugin system in order to support multiple platforms while remaining extensible and light, allowing you to choose which messaging apps you support. There are a number of existing plugins which are available:

@lightning/discord

@lightning/discord adds support for Discord to Lightning. To use it, you’ll first need to create a Discord bot at the Discord Developer Portal. After you do that, you will need to add the following to your config file:

prefix = "!"

[database]
type = "postgres"
config = "postgresql://server@localhost:5432/lightning"

[[plugins]]
plugin = "jsr:@lightning/discord@0.8.0-alpha.1"
config.token = "your_bot_token"

@lightning/guilded

@lightning/guilded adds support for Guilded. To use it, you’ll first need to create a Guilded bot. After you do that, you’ll need to add the following to your config file:

prefix = "/lightning "

[database]
type = "redis"
config.hostname = "redis"
config.port = 6379
config.transport = "tcp"

[[plugins]]
plugin = "jsr:@lightning/guilded@0.8.0-alpha.1"
config.token = "your_bot_token"

@lightning/revolt

@lightning/telegram adds support for Revolt. To use it, you’ll need to create a Revolt bot first. After that, you need to add the following to your config file:

prefix = "!bolt "

[database]
type = "postgres"
config = "postgresql://server@localhost:5432/lightning"

[[plugins]]
plugin = "jsr:@lightning/revolt@0.8.0-alpha.1"
config.token = "your_bot_token"
config.user_id = "your_bot_user_id"

@lightning/telegram

@lightning/telegram adds support for Telegram. Before using it, you’ll need to talk with @BotFather to create a bot. After that, you need to add the following to your config:

prefix = "l!"

[database]
type = "redis"
config.hostname = "redis"
config.port = 6379
config.transport = "tcp"

[[plugins]]
plugin = "jsr:@lightning/telegram"
config.token = "your_bot_token"
config.proxy_port = 9090
config.proxy_url = "https://example.com:9090"

Additionally, you will need to expose the port provided at the URL provided for attachments sent from Telegram to work properly

Adding a plugin

To develop a plugin and get it added to this list, please read the Developer Docs