Difference between revisions of "Module:Perform"

From BNC4FREE
Jump to navigation Jump to search
m (Protected "Module:Perform": Core Page/Module ([Edit=Allow only administrators] (indefinite) [Move=Allow only administrators] (indefinite)))
m (Format Changes)
 
Line 1: Line 1:
= perform =
 
 
This module is used to perform or send commands to the IRC server when connecting to the IRC network.  
 
This module is used to perform or send commands to the IRC server when connecting to the IRC network.  
  
Line 6: Line 5:
 
'''Note²:''' This module supports [[ExpandString|Expandable Strings]]
 
'''Note²:''' This module supports [[ExpandString|Expandable Strings]]
  
== Usage ==
+
= Usage =
  
=== Arguments ===
+
== Arguments ==
 
This module takes no arguments
 
This module takes no arguments
  
=== Commands ===  
+
== Commands ==  
 
This module will send perform commands to the IRC server when the bouncer connects to it. Below is a list of commands to manage the list of commands that will be sent.
 
This module will send perform commands to the IRC server when the bouncer connects to it. Below is a list of commands to manage the list of commands that will be sent.
  
Line 32: Line 31:
 
Shows the list of available commands for this module with the ability to optionally search for word/phrase in help output.
 
Shows the list of available commands for this module with the ability to optionally search for word/phrase in help output.
  
=== Examples ===
+
== Examples ==
 
Below are a few useful examples of how perform can be used
 
Below are a few useful examples of how perform can be used
  
==== Use with NickServ ====
+
=== Use with NickServ ===
 
This module can be used to regain your nickname and identify with NickServ. See <code>/msg NickServ help identify</code> for the syntax that corresponds to the network you are connected to. Most networks use <code>/msg NickServ identify [username] [password]</code> or <code>/msg NickServ identify [password]</code>. These can be added to perform using the following:
 
This module can be used to regain your nickname and identify with NickServ. See <code>/msg NickServ help identify</code> for the syntax that corresponds to the network you are connected to. Most networks use <code>/msg NickServ identify [username] [password]</code> or <code>/msg NickServ identify [password]</code>. These can be added to perform using the following:
  
Line 52: Line 51:
 
  /msg *perform add PRIVMSG NickServ :ghost [password]
 
  /msg *perform add PRIVMSG NickServ :ghost [password]
  
==== Use with Undernet's X Service ====
+
=== Use with Undernet's X Service ===
 
Perform can be used to identify on the [https://www.undernet.org/ Undernet] IRC Network. Identifying is usually done by sending the command <code>/msg X@Channels.undernet.org LOGIN <username> <password></code>. This can be added to perform using the following command:
 
Perform can be used to identify on the [https://www.undernet.org/ Undernet] IRC Network. Identifying is usually done by sending the command <code>/msg X@Channels.undernet.org LOGIN <username> <password></code>. This can be added to perform using the following command:
  
 
  /msg *perform add PRIVMSG X@Channels.undernet.org :LOGIN <username> <password>
 
  /msg *perform add PRIVMSG X@Channels.undernet.org :LOGIN <username> <password>
  
==== Use with Quakenet's Q Service ====
+
=== Use with Quakenet's Q Service ===
 
Perform can be used to identify on the [https://www.quakenet.org/ Quakenet] IRC Network. Identifying is usually done by sending the command <code>/msg Q@CServe.quakenet.org AUTH <username> <password></code>. This can be added to perform using the following command:
 
Perform can be used to identify on the [https://www.quakenet.org/ Quakenet] IRC Network. Identifying is usually done by sending the command <code>/msg Q@CServe.quakenet.org AUTH <username> <password></code>. This can be added to perform using the following command:
  
 
  /msg *perform add PRIVMSG Q@CServe.undernet.org :AUTH <username> <password>
 
  /msg *perform add PRIVMSG Q@CServe.undernet.org :AUTH <username> <password>
  
==== Use with GameSurge's Auth Service ====
+
=== Use with GameSurge's Auth Service ===
 
Perform can be used to identify on the [https://gamesurge.net/ GameSurge] IRC Network. Identifying is usually done by sending the command <code>/msg AuthServ@Services.GameSurge.net AUTH <username> <password></code>. This can be added to perform using the following command:
 
Perform can be used to identify on the [https://gamesurge.net/ GameSurge] IRC Network. Identifying is usually done by sending the command <code>/msg AuthServ@Services.GameSurge.net AUTH <username> <password></code>. This can be added to perform using the following command:
  
 
  /msg *perform add PRIVMSG AuthServ@Services.GameSurge.net :AUTH <username> <password>
 
  /msg *perform add PRIVMSG AuthServ@Services.GameSurge.net :AUTH <username> <password>
  
==== Setting user modes ====
+
=== Setting user modes ===
 
Perform can be used to set usermodes when you connect to the IRC Server (for example on some networks, setting +R to only allow users registered with services to message you). Lists of user modes can be found for most networks by using <code>/helpop umodes</code>. These modes can be set by using the <code>%nick%</code> [[ExpandString|Expandable String]] in the perform command as follows:
 
Perform can be used to set usermodes when you connect to the IRC Server (for example on some networks, setting +R to only allow users registered with services to message you). Lists of user modes can be found for most networks by using <code>/helpop umodes</code>. These modes can be set by using the <code>%nick%</code> [[ExpandString|Expandable String]] in the perform command as follows:
  
Line 75: Line 74:
 
  /msg *perform add mode %nick +iwxR
 
  /msg *perform add mode %nick +iwxR
  
==== Opering Up ====
+
=== Opering Up ===
 
Perform can be used to login as IRC operator on a network. This is often done using <code>/oper [username] [password]</code> and example can be found below:
 
Perform can be used to login as IRC operator on a network. This is often done using <code>/oper [username] [password]</code> and example can be found below:
 
  /msg *perform add oper [username] [password]
 
  /msg *perform add oper [username] [password]
Line 81: Line 80:
 
This can also be used in conjunction with the [[Module:Perform#Setting_User_Modes|Setting user modes]] section above to set snomasks after you have opered.
 
This can also be used in conjunction with the [[Module:Perform#Setting_User_Modes|Setting user modes]] section above to set snomasks after you have opered.
  
==== Identifying to other bots/services ====
+
=== Identifying to other bots/services ===
 
Perform can be used to identify to many other bots and services around IRC, for example your own bots, IdleRPG etc... An example of how to send your login command can be found below:
 
Perform can be used to identify to many other bots and services around IRC, for example your own bots, IdleRPG etc... An example of how to send your login command can be found below:
 
  /msg *perform add privmsg [bot name] :login [username] [password]
 
  /msg *perform add privmsg [bot name] :login [username] [password]

Latest revision as of 15:41, 20 June 2020

This module is used to perform or send commands to the IRC server when connecting to the IRC network.

Note: This module can be loaded either as a user module or a network. We recommend loading this as a network module which will allow you to set different perform commands for different networks however, if you would like the same perform commands sent to all your connected networks, you should load this as a user module.

Note²: This module supports Expandable Strings

Usage

Arguments

This module takes no arguments

Commands

This module will send perform commands to the IRC server when the bouncer connects to it. Below is a list of commands to manage the list of commands that will be sent.

   /msg *perform add <command>

Adds a command to the list of perform commands to be sent to the server

   /msg *perform del <number>

Delete a perform command from the perform list. (Number can be obtained from list)

   /msg *perform list

List the commands currently on your perform list

   /msg *perform execute

Manually execute all of the commands currently on your perform list

   /msg *perform swap <number> <number>

Swap two perform commands that are in the perform list (for re-ordering purposes)

   /msg *perform help <?search>

Shows the list of available commands for this module with the ability to optionally search for word/phrase in help output.

Examples

Below are a few useful examples of how perform can be used

Use with NickServ

This module can be used to regain your nickname and identify with NickServ. See /msg NickServ help identify for the syntax that corresponds to the network you are connected to. Most networks use /msg NickServ identify [username] [password] or /msg NickServ identify [password]. These can be added to perform using the following:

/msg *perform add PRIVMSG NickServ :identify [username] [password]

or

/msg *perform add PRIVMSG NickServ :identify [password]

It is also possible to use this module in conjunction with the keepnick module to regain your nickname and identify to services. Most networks will have a command such as /msg NickServ RELEASE [username] [password] or /msg NickServ GHOST [username] [password]. This releasing of your nickname can be added to perform using the following:

/msg *perform add PRIVMSG NickServ :release [username] [password]

or

/msg *perform add PRIVMSG NickServ :ghost [password]

Use with Undernet's X Service

Perform can be used to identify on the Undernet IRC Network. Identifying is usually done by sending the command /msg X@Channels.undernet.org LOGIN <username> <password>. This can be added to perform using the following command:

/msg *perform add PRIVMSG X@Channels.undernet.org :LOGIN <username> <password>

Use with Quakenet's Q Service

Perform can be used to identify on the Quakenet IRC Network. Identifying is usually done by sending the command /msg Q@CServe.quakenet.org AUTH <username> <password>. This can be added to perform using the following command:

/msg *perform add PRIVMSG Q@CServe.undernet.org :AUTH <username> <password>

Use with GameSurge's Auth Service

Perform can be used to identify on the GameSurge IRC Network. Identifying is usually done by sending the command /msg AuthServ@Services.GameSurge.net AUTH <username> <password>. This can be added to perform using the following command:

/msg *perform add PRIVMSG AuthServ@Services.GameSurge.net :AUTH <username> <password>

Setting user modes

Perform can be used to set usermodes when you connect to the IRC Server (for example on some networks, setting +R to only allow users registered with services to message you). Lists of user modes can be found for most networks by using /helpop umodes. These modes can be set by using the %nick% Expandable String in the perform command as follows:

/msg *perform add mode %nick% +R

Multiple modes can be specified on one perform, for example:

/msg *perform add mode %nick +iwxR

Opering Up

Perform can be used to login as IRC operator on a network. This is often done using /oper [username] [password] and example can be found below:

/msg *perform add oper [username] [password]

This can also be used in conjunction with the Setting user modes section above to set snomasks after you have opered.

Identifying to other bots/services

Perform can be used to identify to many other bots and services around IRC, for example your own bots, IdleRPG etc... An example of how to send your login command can be found below:

/msg *perform add privmsg [bot name] :login [username] [password]

* Change the command to suit your needs as necessary