Difference between revisions of "Module:AutoCycle"

From BNC4FREE
Jump to navigation Jump to search
(Initial Page)
 
(Add documentation for the autocycle module)
 
Line 1: Line 1:
Information about this module will appear shortly
+
This module will make the bouncer cycle a channel when you are the only user in the channel and do not have operator status. This is particularly useful for regaining channels on networks such as [https://efnet.org EFNet] which have no services.
  
[[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 space separated list of channels that autocycle should or shouldn't be enabled on
 +
|}
 +
 
 +
== Commands ==
 +
 
 +
The following command can be used to add a channel that you would like the bouncer to auto cycle:
 +
    /msg *autocycle add #somechannel
 +
 
 +
Wildcards can also be used to add range of channels that are prefixed in the same way:
 +
    /msg *autocycle add #somechannels-*
 +
 
 +
It is also possible to explicitly disable autocycle on a channel using the following:
 +
    /msg *autocycle add !#someotherchannel
 +
 
 +
To delete a channel so that autocycle is no longer enabled on it, use the following:
 +
    /msg *autocycle del #somechannel
 +
 
 +
To list all the channels on the autocycle list, use the following command:
 +
    /msg *autocycle list
 +
 
 +
[[Category:Modules]] [[Category:Network_Modules]]

Latest revision as of 20:28, 27 December 2020

This module will make the bouncer cycle a channel when you are the only user in the channel and do not have operator status. This is particularly useful for regaining channels on networks such as EFNet which have no services.

Usage

Arguments

This module takes 1 argument

Argument Type Description
Channels Optional A space separated list of channels that autocycle should or shouldn't be enabled on

Commands

The following command can be used to add a channel that you would like the bouncer to auto cycle:

   /msg *autocycle add #somechannel

Wildcards can also be used to add range of channels that are prefixed in the same way:

   /msg *autocycle add #somechannels-*

It is also possible to explicitly disable autocycle on a channel using the following:

   /msg *autocycle add !#someotherchannel

To delete a channel so that autocycle is no longer enabled on it, use the following:

   /msg *autocycle del #somechannel

To list all the channels on the autocycle list, use the following command:

   /msg *autocycle list