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

/*
 * Core ChanServ module.
 *
 * Provides essential functionality for ChanServ.
 */
module
{
        name = "chanserv"
 
        /*
         * The name of the client that should be ChanServ.
         */
        client = "ChanServ"
 
        /*
         * The default options for newly registered channels. Note that changing these options
         * will have no effect on channels which are already registered. The list must be separated
         * by spaces.
         *
         * The options are:
         * -      keeptopic: Retain topic when the channel is not in use
         * -          peace: Disallow users from kicking or removing modes from others who are of the same
         *                     access level or superior
         * -     cs_private: Hide the channel from ChanServ's LIST command
         * -     restricted: Kick/ban users who are restricted from the channel
         * -      cs_secure: Enable channel security, requiring the user to be identified with NickServ in
         *                     order to be considered for being on the access list of the channel
         * -      secureops: Only allow operator status to be given if the user is on the access list
         * -  securefounder: Only allow the real founder of the channel to drop the channel, change it's
         *                     password, or change the founder or successor
         * -       signkick: Use of ChanServ's KICK command will cause the user's nick to be signed to the kick.
         * - signkick_level: Same as above, but the kick will not be signed if the user is at the same access
         *                     level or superior to the target
         * -      topiclock: Disallow the topic to be changed except with ChanServ's TOPIC command
         * -        persist: Keep the channel open at all times
         * -       noautoop: Disables autoop on the channel
         * -  cs_keep_modes: Enables keep modes on the channel, which retains modes when the channel is
         *                     not in use.
         * -           none: No defaults
         *
         * This directive is optional, if left blank, the options will default to keeptopic, cs_secure, securefounder,
         * and signkick. If you really want no defaults, use "none" by itself as the option.
         */
        defaults = "keeptopic peace cs_secure securefounder signkick"
 
        /*
         * The maximum number of channels which may be registered to a single nickname.
         *
         * This directive is optional, but recommended.
         * If not set, there will be no restriction on the numbers of channels a single nickname can have registered.
         */
        maxregistered = 20
 
        /*
         * The length of time before a channel registration expires.
         *
         * This directive is optional, but recommended.
         * If not set, the default is 14 days.
         */
        expire = 14d
 
        /*
         * The maximum number of entries on a channel's access list.
         * If not set, the default is 1024. This can be set to 0 for unlimited.
         */
        accessmax = 1024
 
        /*
         * The length of time ChanServ stays in a channel after kicking a user from a channel they are not
         * permitted to be in. This only occurs when the user is the only one in the channel.
         */
        inhabit = 15s
        /*
         * Allow only IRC Operators to use ChanServ.
         *
         * This directive is optional.
         */
        #opersonly = yes
 
        /*
         * Modes that will not be allowed to be locked. Oper only modes such as +O
         * are always restricted from regular users and are not affected by this.
         * Comment out for no restrictions.
         */
        #nomlock = "P"
 
        /*
         * Modes that are required to be set and only set on all registered channels.
         * These modes can not be locked or unlocked. The registered channel mode is
         * automatically always required, if such a mode exists.
         */
        #require = "r"
 
        /*
         * The maximum length of the reason field for user commands such as chanserv/kick
         * and chanserv/ban.
         */
        reasonmax = 200
 
        /*
         * If set, prevents channel access entries from containing hostmasks.
         */
        disallow_hostmask_access = false
 
        /*
         * If set, prevents channels from being on access lists.
         */
        disallow_channel_access = false
 
        /*
         * If set, ChanServ will always lower the timestamp of registered channels to their registration date.
         * This prevents several race conditions where unauthorized users can join empty registered channels and set
         * modes etc. prior to services deopping them.
         */
        always_lower_ts = false
}