Difference between revisions of "Module:StickyChan"

From BNC4FREE
Jump to navigation Jump to search
(Initial Page)
 
(Add documentation for the stickychan module)
 
Line 1: Line 1:
Information about this module will appear shortly
+
This module can stick you to channels so that if you accidentally part or otherwise lose your channel window, it will re-appear. The bouncer will intercept part messages that you send to the channel and prevent the part message from being sent to the IRC server. The bouncer will also automatically rejoin the channel if you are SAPART'd or SVSPART'd from a channel that has been stickied. 
  
[[Category:Modules]]
+
= Usage =
 +
 
 +
== Arguments ==
 +
 
 +
This module takes 1 argument
 +
 
 +
{| class="wikitable"
 +
! style="font-weight:bold;" | Argument
 +
! style="font-weight:bold;" | Type
 +
! style="font-weight:bold;" | Description
 +
|-
 +
| Channels
 +
| Optional
 +
| A comma separated list of channels to be stuck
 +
|}
 +
 
 +
== Commands ==
 +
 
 +
The following command can be used to stick a channel:
 +
    /msg *stickychan stick <channel>
 +
'''''Note:''''' ''If the channel requires a a channel key, the channel key should be specified after the channel name''
 +
 
 +
 
 +
The following command can be used to unstick a channel:
 +
    /msg *stickychan unstick <channel>
 +
 
 +
[[Category:Modules]] [[Category:Network_Modules]]

Latest revision as of 19:21, 27 December 2020

This module can stick you to channels so that if you accidentally part or otherwise lose your channel window, it will re-appear. The bouncer will intercept part messages that you send to the channel and prevent the part message from being sent to the IRC server. The bouncer will also automatically rejoin the channel if you are SAPART'd or SVSPART'd from a channel that has been stickied.

Usage

Arguments

This module takes 1 argument

Argument Type Description
Channels Optional A comma separated list of channels to be stuck

Commands

The following command can be used to stick a channel:

   /msg *stickychan stick <channel>

Note: If the channel requires a a channel key, the channel key should be specified after the channel name


The following command can be used to unstick a channel:

   /msg *stickychan unstick <channel>