Difference between revisions of "Preference:Alias"

From Mibbit Wiki
Jump to: navigation, search
m (Havondale moved page Broken/Alias to Preference:Alias without leaving a redirect)
 
(41 intermediate revisions by 8 users not shown)
Line 4: Line 4:
  
 
==How It Works==
 
==How It Works==
MATCH - This is the first word on the line, that we're matching against. It can start with / but doesn't have to.
 
  
COMMAND - This is what you want to do if the alias matches.
+
Each alias has a Match, or trigger, and a Command, or output.
 
 
Bear in mind that the first match will trigger, so if you have duplicate matches, only the first will be used. The match is also case insensitive.
 
 
 
{| border="1" cellpadding="7"
 
|+ What you can have in COMMAND
 
|-
 
| <nowiki>|</nowiki> || Separate multiple commands
 
|-
 
| # || The current channel
 
|-
 
| $N || (Where N is a number) - replace this with the Nth word from the input
 
|-
 
| $$N || Same as above, but if there is no such word, only ignore this command, not the whole alias
 
|-
 
| $N- || replace with all words from N onward
 
|-
 
| $N-M || replace with all words from N to M
 
|-
 
| $+ || suppress the space between words
 
|-
 
| $me || Your current nickname
 
|-
 
| /say || Say something on the current channel
 
|}
 
  
 +
=== Match ===
  
You can have a .,!? after $me, and you can have a # before any of the $N commands.
+
The match is what triggers the alias. A match can either be a [[command]] used on the [[command line]] or the name of a channel on a server that is triggered when joined.
  
==Examples==
+
Commands start with a forwardslash ( / ) followed by the name of the command.  The name should not already be taken in Mibbit.
  
* [Alias examples]
+
Bear in mind that the first match will trigger, so if you have duplicate matches, only the first will be used. The match is also case insensitive.
 
 
===Hugs===
 
/hug /me hugs $1 tightly.
 
  
Now if you write "/hug jenny", you'll see:
+
Further, matches to commands already in the client such as <tt>/join</tt> will overwrite the original functionality.  Don't do this unless you are trying to remove such functionality.
  
<nowiki>* yournick hugs jenny tightly.</nowiki>
+
=== OnJoin Match ===
 +
A match that triggers when joining a specific channel is also called an onJoin match. Currently, an onJoin alias only works on the [[main client]].  The match follows the following style:
  
You can use an alias you declared before it.  An example is the /multihug command:
+
  >network>#channel
  
/multihug /say I need a hug :( | /hug $$1 | /hug $$2 | /hug $$3 | /say phew! That felt good. I'm glad I'm in # and not in #nohugs!
+
[[Category:Main client]]
  
Now write "/multihug jenny cloe" you'll see:
+
=== Command ===
  
<nowiki>mynick: I need a hug :(
+
If a match triggers, the command section is implemented in the channel that triggers it. The command must be a set of commands. Certain variables and constructs for multiple commands are provided.
* mynick hugs jenny tightly.
 
* mynick hugs cloe tightly.
 
mynick: phew! That felt good. I'm glad I'm in #mychannel and not in #nohugs!</nowiki>
 
  
===Quiet ban===
+
{| border="1" cellpadding="4" style="border-collapse:collapse;padding:3px;border:1px solid #999;"
 
+
|+ COMMAND Variables
Unreal Version
 
/qb /mode # +b ~q:*!*@ $+ $1
 
Freenode Version
 
/qb /mode # +q $1 $+ !*@*
 
 
 
usage: /qb <hostname on Unreal> <nick on Freenode> (prevents a user from talking)
 
 
 
example: /qb B3E473F8.3D842CF7.21EFBB6E.IP
 
 
 
(at least on irc.mibbit.com and other servers that use unreal)
 
 
 
===Default Aliases===
 
 
 
{| class="wikitable" style="text-align:center"
 
 
|-
 
|-
! Alias Name !! Command !! What It Does
+
|&nbsp;<nowiki> | </nowiki>&nbsp;|| (<space><nowiki>|</nowiki><space>) Separate multiple commands (lines)
 
|-
 
|-
| /j || /join $1 || Smaller command to join a channel
+
| # || The current channel
 
|-
 
|-
| /cs || /msg ChanServ $1- || Message ChanServ with only two letters.
+
| $N || (Where N is a number) - replace this with the Nth word from the input
 
|-
 
|-
| /ns || /msg NickServ $1- || Message NickServ with only two letters.
+
| $$N || Same as above, but if there is no such word, only ignore this command, not the whole alias
 
|-
 
|-
| /bs || /msg BotServ $1- || Message BotServ with only two letters.
+
| $N- || replace with all words from N onward (i.e. $3- would take the third word and all following it)
 
|-
 
|-
| /ms || /msg MemoServ $1- || Message MemoServ with only two letters.
+
| $N-M || replace with all words from N to M (i.e. $1-5 would take the first 5 words)
 
|-
 
|-
| /os || /msg OperServ $1- || Message OperServ with only two letters.
+
| $+ || suppress the spaces between variables and following text or other variables
 
|-
 
|-
| /voice || /mode # +v $1 || Voice a hostmask
+
| $me || Your current nickname
 
|-
 
|-
| /devoice || /mode # -v $1 || Remove voice from a hostmask (Unvoice is the same)
+
| /say || Say something on the current channel
 
|-
 
|-
| /ban || /mode # +b $1 || Ban a hostmask
+
| $? || Causes a prompt asking for information, password, etc.
|-
+
 
| /unban || /mode # -b $1 || Remove a ban from a hostmask.  (Deban is the same)
 
|-
 
| /op || /mode # +o $1 || Give operator status to a hostmask.
 
|-
 
| /deop || /mode # -o $1 || Remove operator status from a hostmask (Unop is the same)
 
|-
 
| /halfop || /mode # +h $1 || Give half-operator status to a hostmask.
 
|-
 
| /dehalfop || /mode # -h $1 || Remove half-operator status from a hostmask (Unhalfop is the same)
 
|-
 
| /admin || /mode # +a $1 || Give super-operator status to a hostmask (called Admin on Mibbit)
 
|-
 
| /deadmin || /mode # -a $1 || Remove super-operator status from a hostmask (/unadmin is the same)
 
|-
 
| /owner || /mode # +q $1 || Give owner status to the hostmask
 
|-
 
| /deowner || /mode # -q $1 || Remove owner status from the hostmask (/unowner is the same)
 
 
|}
 
|}
  
=== Multi-Mode Aliases ===
 
  
In Chatzilla, you can do /voice Nick1 Nick2 Nick3 Nick4 (ect) and they all become voiced.  The alias showing is the closest to that.
+
You can have a .,!? after $me, and you can have a # before any of the $N commands.
  
Command:  <nowiki>/mode # [+/-][mode] $1 | /mode # [+/-][mode] $$2 | /mode # [+/-][mode] $$3 | /mode # [+/-][mode] $$4</nowiki>
+
==Default Aliases==
 +
{{DefaultAlias}}
  
Replace <nowiki>[+/-]</nowiki> with plus or minus depending on if you want to add or remove the [[mode]] that you specify in <nowiki>[mode]</nowiki>.
+
==Examples==
 
+
For examples of custom aliases, see [[Alias/Examples]].
Some common examples are:
 
 
 
* /mode # +v $1 | /mode # +v $$2 | /mode # +v $$3 | /mode # +v $$4
 
* /mode # +o $1 | /mode # +o $$2 | /mode # +o $$3 | /mode # +o $$4
 
  
[[Category:Preferences]]
+
[[Category:Preferences]][[Category:Support]]

Latest revision as of 10:16, 3 May 2020

Aliases.png

Aliases are user set commands that reference other commands so that they do not have to repeat themselves each time they want to use a specific line. As they are preferences, they can be set for widgets also.

How It Works

Each alias has a Match, or trigger, and a Command, or output.

Match

The match is what triggers the alias. A match can either be a command used on the command line or the name of a channel on a server that is triggered when joined.

Commands start with a forwardslash ( / ) followed by the name of the command. The name should not already be taken in Mibbit.

Bear in mind that the first match will trigger, so if you have duplicate matches, only the first will be used. The match is also case insensitive.

Further, matches to commands already in the client such as /join will overwrite the original functionality. Don't do this unless you are trying to remove such functionality.

OnJoin Match

A match that triggers when joining a specific channel is also called an onJoin match. Currently, an onJoin alias only works on the main client. The match follows the following style:

 >network>#channel

Command

If a match triggers, the command section is implemented in the channel that triggers it. The command must be a set of commands. Certain variables and constructs for multiple commands are provided.

COMMAND Variables
  |   (<space>|<space>) Separate multiple commands (lines)
# The current channel
$N (Where N is a number) - replace this with the Nth word from the input
$$N Same as above, but if there is no such word, only ignore this command, not the whole alias
$N- replace with all words from N onward (i.e. $3- would take the third word and all following it)
$N-M replace with all words from N to M (i.e. $1-5 would take the first 5 words)
$+ suppress the spaces between variables and following text or other variables
$me Your current nickname
/say Say something on the current channel
$? Causes a prompt asking for information, password, etc.


You can have a .,!? after $me, and you can have a # before any of the $N commands.

Default Aliases

Alias Name Command What It Does
/j /join $1- Smaller command to join channels
/cs /msg ChanServ $1- Message ChanServ with only two letters.
/ns /msg NickServ $1- Message NickServ with only two letters.
/bs /msg BotServ $1- Message BotServ with only two letters.
/ms /msg MemoServ $1- Message MemoServ with only two letters.
/os /msg OperServ $1- Message OperServ with only two letters.
/voice /mode # +v $1 Voice a user/nick
/devoice /mode # -v $1 Remove voice from a user/nick (/unvoice is the same)
/ban /mode # +b $1 Ban a user/hostmask (/ban<space> = show list with unban buttons)
/unban /mode # -b $1 Remove a ban from a user/hostmask (/deban is the same)
/op /mode # +o $1 Give operator status to a user/nick.
/deop /mode # -o $1 Remove operator status from a user/nick (/unop is the same)
/halfop /mode # +h $1 Give half-operator status to a user/nick.
/dehalfop /mode # -h $1 Remove half-operator status from a user/nick (/unhalfop is the same)
/admin /mode # +a $1 Give super-operator status to a user/nick (called Admin on Mibbit, use "/raw admin" for the ircd command)
/deadmin /mode # -a $1 Remove super-operator status from a user/nick (/unadmin is the same)
/owner /mode # +q $1 Give owner status to the user/nick
/deowner /mode # -q $1 Remove owner status from the user/nick (/unowner is the same)


Examples

For examples of custom aliases, see Alias/Examples.