thelounge-plugin-chanmon
v2.5.1
Published
A plugin for TheLounge that creates a local channel monitor to stream all channel activity in real-time
Maintainers
Readme
thelounge-plugin-chanmon
A plugin for TheLounge that creates a channel monitor to stream all channel activity in real-time.
Features
- Real-time monitoring: Automatically creates a
#chanmonchannel that displays all messages from channels you're in - Channel prefixes: Each message is prefixed with the originating channel name for easy identification
- Toggle control: Use
/chanmoncommand to enable/disable monitoring - Clean output: Filters out system messages (joins, parts, quits, etc.) to focus on actual conversations
- Action support: Monitors both regular messages and IRC actions
- Per-network: Each IRC network gets its own chanmon channel
Installation
Via TheLounge package manager (recommended)
If you have installed TheLounge via NPM/Yarn:
thelounge install thelounge-plugin-chanmonIf you have installed TheLounge from source:
node index.js install thelounge-plugin-chanmonManual installation
- Clone or download this repository to your TheLounge's
packagesdirectory - Restart TheLounge
- The plugin will be automatically loaded
Usage
Basic Usage
Once installed, the plugin will automatically:
- Create a
#chanmonchannel on each IRC network you connect to - Start monitoring all channel activity in real-time
- Display messages in the format:
[#channel] <nick> message
Commands
/chanmon- Toggle channel monitoring on/off for the current network
Example Output
[#general] <alice> Hey everyone, how's it going?
[#development] <bob> Just pushed the new feature to staging
[#random] * charlie is away
[#general] <dave> @alice doing great, thanks for asking!Configuration
The plugin works out of the box with no configuration required. It will:
- Automatically enable monitoring when you connect to a network
- Create the
#chanmonchannel if it doesn't exist - Start streaming messages immediately
What gets monitored
Monitored:
- Regular channel messages
- IRC actions (
/mecommands)
Not monitored:
- Join/part/quit messages
- Nick changes
- Mode changes
- Topic changes
- Messages from the
#chanmonchannel itself (prevents loops)
Compatibility
- TheLounge version: 4.0.0 or higher
- Node.js version: 14.0.0 or higher
Development
To contribute to this plugin:
- Fork the repository
- Make your changes
- Test with a local TheLounge installation
- Submit a pull request
License
MIT License - see LICENSE file for details.
Support
If you encounter any issues or have feature requests, please open an issue on the GitHub repository.
Related Plugins
- thelounge-plugin-closepms - Close all open PMs on a network
- thelounge-plugin-autodownload - Autodownload torrents in qBittorrent
