Channel Central (v1.1)

Performs some simple stats, basic channel management functions and can also manage a help channel. It can also keep track of the live statistics to a file.

Channel Central can perform very simple channel operations and provide simple channel stats. It is not meant as a replacement for existing channel bots or for protecting a channel from abuse, but it can be used to add a little extra help on top of these existing bots, such as channel wide auto op/voice, allowing certain levels of PPF authed users to perform some channel operations through this plugin. It also has help channel features in too so that you can manage a queued help channel and fairly deal with each person in turn. Live channel statistics can be recorded to a file as well, which can then be parsed and used, for example, on a homepage.

The configuration file for this plugin is system/ChannelCentral/ChannelCentralConfig.xml

	commandStats

The command for showing channel statistics. You can set the authLevel to control who is allowed to access the command.

• authLevel - ANY, ADMIN, MASTER, TRUSTED, NONE

      <commandStats authLevel="none">!stats</commandStats>

    

	commandPeak

The command for showing the highest channel peak. You can set the authLevel to control who is allowed to access the command.

• authLevel - ANY, ADMIN, MASTER, TRUSTED, NONE

      <commandPeak authLevel="none">!peak</commandPeak>

    

	commandShowTopic

The command for showing the topic of the channel. You can set the authLevel to control who is allowed to access the command.

• authLevel - ANY, ADMIN, MASTER, TRUSTED, NONE

      <commandShowTopic authLevel="none">!showtopic</commandShowTopic>

    

	commandTopic

The command for setting the topic of the channel. You can set the authLevel to control who is allowed to access the command.

• authLevel - ANY, ADMIN, MASTER, TRUSTED, NONE

      <commandTopic authLevel="master">!topic</commandTopic>

    

	commandKick

The command for kicking someone from the channel. You can set the authLevel to control who is allowed to access the command.

• authLevel - ANY, ADMIN, MASTER, TRUSTED, NONE

      <commandKick authLevel="master">!kick</commandKick>

    

	commandVoice

The command for voicing someone in the channel. You can set the authLevel to control who is allowed to access the command.

• authLevel - ANY, ADMIN, MASTER, TRUSTED, NONE

      <commandVoice authLevel="master">!voice</commandVoice>

    

	commandDeVoice

The command for devoicing someone in the channel. You can set the authLevel to control who is allowed to access the command.

• authLevel - ANY, ADMIN, MASTER, TRUSTED, NONE

      <commandDeVoice authLevel="master">!voice</commandDeVoice>

    

	commandOp

The command for giving someone op (operator) rights in the channel. You can set the authLevel to control who is allowed to access the command.

• authLevel - ANY, ADMIN, MASTER, TRUSTED, NONE

      <commandOp authLevel="master">!op</commandOp>

    

	commandDeOp

The command for removing op (operator) rights from someone in the channel. You can set the authLevel to control who is allowed to access the command.

• authLevel - ANY, ADMIN, MASTER, TRUSTED, NONE

      <commandDeOp authLevel="master">!deop</commandDeOp>

    

	opAuthLevel

Setting for what auth level is required before automatically opping a user.

• ANY - any auth at all
• ADMIN - only admin level
• MASTER - master or above
• TRUSTED - trusted or above
• NONE - no auth required

        <opAuthLevel>ADMIN</opAuthLevel>

    

	voiceAuthLevel

Setting for what auth level is required before automatically voicing a user.

• ANY - any auth at all
• ADMIN - only admin level
• MASTER - master or above
• TRUSTED - trusted or above
• NONE - no auth required

        <voiceAuthLevel>NONE</voiceAuthLevel>

    

	channel (help channel)

The channel to be treated as a help channel. You can have multiple help channels.

• name - name of the channel to be treated as a help channel
• open - the open message to use in the topic for the help channel
• closed - the closed message to use in the topic for the help channel

      <channel name="#deaded" open="An admin will voice you as soon as possible. Admins online are: "
       	closed="Sorry no admins are about at present"/>

    

	commandNext (help channel)

The command for getting the next person in the queue, voicing them and sending a channel message with their nick in to get their attention. You can set the authLevel to control who is allowed to access the command.

• authLevel - ANY, ADMIN, MASTER, TRUSTED, NONE

      <commandNext authLevel="master">!next</commandNext>

    

	commandDone (help channel)

The command for finishing with a person in the channel, devoicing them and sending a notice for them to leave the channel. You can set the authLevel to control who is allowed to access the command.

• authLevel - ANY, ADMIN, MASTER, TRUSTED, NONE

      <commandDone authLevel="master">!done</commandDone>

    

	commandAddHelper (help channel)

The command for adding a help channel helper to the channel topic. You can set the authLevel to control who is allowed to access the command.

• authLevel - ANY, ADMIN, MASTER, TRUSTED, NONE

      <commandAddHelper authLevel="master">!add</commandAddHelper>

    

	commandOpen (help channel)

The command for setting the help channel as open and adding the nick of the person using the command to the topic as a helper. The text for the topic is set from the open message set for the help channel. You can set the authLevel to control who is allowed to access the command.

• authLevel - ANY, ADMIN, MASTER, TRUSTED, NONE

      <commandOpen authLevel="master">!open</commandOpen>

    

	commandClosed (help channel)

The command for setting the help channel as closed and changing the topic to the closed message set for the help channel. You can set the authLevel to control who is allowed to access the command.

• authLevel - ANY, ADMIN, MASTER, TRUSTED, NONE

      <commandClosed authLevel="master">!close</commandClosed>

    

	Show channel stats

Command: !stats
Description: Show current channel statistics
Auth Level: none
Where to give command: channel
Outputs to: channel
Example(s):

• !stats

	Show channel peak

Command: !peak
Description: Shows the highest number of simultaneous users
Auth Level: none
Where to give command: channel
Outputs to: channel
Example(s):

• !peak

	Show channel topic

Command: !showtopic
Description: Show current topic
Auth Level: none
Where to give command: channel
Outputs to: channel
Example(s):

• !showtopic

	Set channel topic

Command: !topic
Description: Sets the current topic
Auth Level: master
Where to give command: channel
Outputs to: channel
Example(s):

• !topic this is the new topic

	Kick someone

Command: !kick
Description: Kick a user from the channel. Any text after the name will be given as a reason for the kick
Auth Level: master
Where to give command: channel
Outputs to: channel
Example(s):

• !kick DeadEd
• !kick DeadEd you asked me to kick you

	Voice someone

Command: !voice
Description: Voice a user
Auth Level: master
Where to give command: channel
Outputs to: channel
Example(s):

• !voice DeadEd

	Devoice someone

Command: !devoice
Description: Devoice a user
Auth Level: master
Where to give command: channel
Outputs to: channel
Example(s):

• !devoice DeadEd

	Op someone

Command: !op
Description: Op a user
Auth Level: master
Where to give command: channel
Outputs to: channel
Example(s):

• !op DeadEd

	De-op someone

Command: !deop
Description: De-op a user
Auth Level: master
Where to give command: channel
Outputs to: channel
Example(s):

• !deop DeadEd

	De-op someone

Command: !deop
Description: De-op a user
Auth Level: master
Where to give command: channel
Outputs to: channel
Example(s):

• !deop DeadEd

	Help channel: next in queue

Command: !next
Description: Takes the next person in the queue, voices them, and says their name in the channel
Auth Level: master
Where to give command: channel
Outputs to: channel
Example(s):

• !next

	Help channel: finished with a person

Command: !done
Description: Marks the person as dealt with. Devoices them and sends them a notice asking them to leave the channel
Auth Level: master
Where to give command: channel
Outputs to: channel
Example(s):

• !done
• !done DeadEd

	Help channel: register as a helper

Command: !add
Description: Add the person to the topic as a helper
Auth Level: master
Where to give command: channel
Outputs to: channel
Example(s):

• !add

	Help channel: sign off as a helper

Command: !del
Description: Remove the person from the topic as a helper
Auth Level: master
Where to give command: channel
Outputs to: channel
Example(s):

• !del

	Help channel: open the channel

Command: !open
Description: Sets the channel as open and adds the person to the topic
Auth Level: master
Where to give command: channel
Outputs to: channel
Example(s):

• !open

	Help channel: close the channel

Command: !close
Description: Sets the channel as close and changes the topic
Auth Level: master
Where to give command: channel
Outputs to: channel
Example(s):

• !close

v1.1	added handlers for onPrivateMessage and onNotice
v1.0	First Version by DeadEd