Difference between revisions of "2.0/Modules/cs set"

Latest revision as of 20:36, 6 May 2014

Description

Allows the channel founder to set various channel options and other information.

Commands

SET AUTOOP channel on|off

Enables or disables ChanServ's autoop feature for a channel. When disabled, users who join the channel will not automatically gain any status from ChanServ.

SET BANTYPE channel bantype

Sets the ban type that will be used by services whenever they need to ban someone from your channel.

Bantype is a number between 0 and 3 that means:

0: ban in the form *!user@host

1: ban in the form *!*user@host

2: ban in the form *!*@host

3: ban in the form *!*user@*.domain    >Recommended<

SET DESC channel [description]

Sets the description for the channel, which shows up with the LIST and INFO commands.

SET DESCRIPTION channel [description]

Sets the description for the channel, which shows up with the LIST and INFO commands.

SET FOUNDER channel nick

Changes the founder of a channel. The new nickname must be a registered one.

SET KEEPMODES channel {on|off}

Enables or disables keepmodes for the given channel. If keep modes is enabled, services will remember modes set on the channel and attempt to re-set them the next time the channel is created.

SET KEEPTOPIC channel {on|off}

Enables or disables the topic retention option for a channel. When set keeptopic is set, the topic for the channel will be remembered by ChanServ even after the last user leaves the channel, and will be restored the next time the channel is created.

SET NOEXPIRE channel {on|off}

Sets whether the given channel will expire. Setting this to ON prevents the channel from expiring. NOTE: Access to this command requires the permission chanserv/saset/noexpire to be present in your opertype.

SET PEACE channel {on|off}

Enables or disables the peace option for a channel. When peace is set, a user won't be able to kick, ban or remove a channel status of a user that has a level superior or equal to his via ChanServ commands.

SET PERSIST channel {on|off}

When persistent is set, the service bot will remain in the channel when it has emptied of users.

If your IRCd does not have a permanent (persistent) channel mode you must have a service bot in your channel to set persist on, and it can not be unassigned while persist is on.

If this network does not have BotServ enabled and does not have a permanent channel mode, ChanServ will join your channel when you set persist on (and leave when it has been set off).

If your IRCd has a permanent (persistent) channel mode and it is set or unset (for any reason, including MODE LOCK), persist is automatically set and unset for the channel aswell. Additionally, services will set or unset this mode when you set persist on or off.

SET PRIVATE channel {on|off}

Enables or disables the private option for a channel. When private is set, the channel will not appear in ChanServ's LIST command.

SET RESTRICTED channel {on|off}

Enables or disables the restricted access option for a channel. When restricted access is set, users not on the access list will instead be kicked and banned from the channel.

SET SECURE channel {on|off}

Enables or disables security features for a channel. When set secure is set to ON', only users who have registered their nicknames and IDENTIFY'd with their password will be given access to the channel as controlled by the access list.

SET SECUREFOUNDER channel {on|off}

Enables or disables the secure founder' option for a channel. When secure founder is set, only the real founder will be able to drop the channel, change its founder and its successor, and not those who have founder level access through the access/qop command.

SET SECUREOPS channel {on|off}

Enables or disables the secure ops option for a channel. When secure ops is set, users who are not on the userlist will not be allowed chanop status.

SET SIGNKICK channel {on|level|off}

Enables or disables signed kicks for a channel. When SIGNKICK is set, kicks issued with the KICK command will have the nick that used the command in their reason.

If you use LEVEL, those who have a level that is superior or equal to the SIGNKICK level on the channel won't have their kicks signed.

SET SUCCESSOR channel nick

Changes the successor of a channel. If the founder's nickname expires or is dropped while the channel is still registered, the successor will become the new founder of the channel. The new nickname must be a registered one. However, if the successor already has too many channels registered (20), the channel will be dropped instead, just as if no successor had been set.

Examples

/msg ChanServ SET #myChannel SIGNKICK on

/msg ChanServ SET #myChannel KEEPTOPIC on

/msg ChanServ SET #myChannel SUCCESSOR Fred

Default Configuration

/*
 * cs_set
 *
 * Provides the commands:
 *   chanserv/set and chanserv/saset - Dummy help wrappers for the SET commands.
 *   chanserv/set/autoop - Used for configuring whether or not ChanServ automatically gives channel status to users.
 *   chanserv/set/bantype - Used for controlling what format of bans are placed on channels.
 *   chanserv/set/description - Used for changing channels descriptions.
 *   chanserv/set/founder - Used for changing a channel's founder.
 *   chanserv/set/keepmodes - Used for enabling or disabling keepmodes, which retains channel modes.
 *   chanserv/set/peace - Used for configuring if users are able to kick other users with higher access than them.
 *   chanserv/set/persist - Used for setting whether ChanServ should stay in channels after the last user leaves.
 *   chanserv/set/restricted - Used for setting whether users not on a channel's access list can join.
 *   chanserv/set/secure - Used for setting whether users who are recognized for accounts should have their access in channels.
 *   chanserv/set/securefounder - Used for setting whether users with founder level access in channels have true founder or not.
 *   chanserv/set/secureops - Used for restricting who can have channel op privilege in a channel to those whom have access in the channel.
 *   chanserv/set/signkick - Used for setting signkick, which appends the kicker's name to kicks sent through ChanServ.
 *   chanserv/set/successor - Used for setting channel successors, which become channel founders if the founders' account expires.
 *   chanserv/saset/noexpire - Used for setting noexpire, which prevents channels from expiring.
 *
 * This is a dummy command to provide a help wrapper for the various SET commands.
 */
module
{
        name = "cs_set"
 
        /*
         * The default ban type for newly registered channels.
         *
         * defbantype can be:
         *
         * 0: ban in the form of *!user@host
         * 1: ban in the form of *!*user@host
         * 2: ban in the form of *!*@host
         * 3: ban in the form of *!*user@*.domain
         */
        defbantype = 2
 
        /*
         * If set, persisent channels have their creation times lowered to their
         * original registration dates.
         */
        persist_lower_ts = true
}
command { service = "ChanServ"; name = "SET"; command = "chanserv/set"; group = "chanserv/management"; }
command { service = "ChanServ"; name = "SET AUTOOP"; command = "chanserv/set/autoop"; }
command { service = "ChanServ"; name = "SET BANTYPE"; command = "chanserv/set/bantype"; }
command { service = "ChanServ"; name = "SET DESCRIPTION"; command = "chanserv/set/description"; }
command { service = "ChanServ"; name = "SET DESC"; command = "chanserv/set/description"; }
command { service = "ChanServ"; name = "SET FOUNDER"; command = "chanserv/set/founder"; }
command { service = "ChanServ"; name = "SET KEEPMODES"; command = "chanserv/set/keepmodes"; }
command { service = "ChanServ"; name = "SET PEACE"; command = "chanserv/set/peace"; }
command { service = "ChanServ"; name = "SET PERSIST"; command = "chanserv/set/persist"; }
command { service = "ChanServ"; name = "SET RESTRICTED"; command = "chanserv/set/restricted"; }
command { service = "ChanServ"; name = "SET SECURE"; command = "chanserv/set/secure"; }
command { service = "ChanServ"; name = "SET SECUREFOUNDER"; command = "chanserv/set/securefounder"; }
command { service = "ChanServ"; name = "SET SECUREOPS"; command = "chanserv/set/secureops"; }
command { service = "ChanServ"; name = "SET SIGNKICK"; command = "chanserv/set/signkick"; }
command { service = "ChanServ"; name = "SET SUCCESSOR"; command = "chanserv/set/successor"; }
command { service = "ChanServ"; name = "SET NOEXPIRE"; command = "chanserv/saset/noexpire"; permission = "chanserv/saset/noexpire"; }