AdiIRC

{{>toc}}

h1. MTS Themes

"MTS" stands for mIRC Theme Standard, which defines a set of events and some options/variables to allow modifying colors and text formatting.

The spec can be read at https://github.com/solbu/Peace-and-Protection/wiki/MTSREF.

AdiIRC uses a mix of the spec and some of it's own events/variables.

h2. Installing a MTS theme

MTS themes can be installed from the [[Themes_Dialog|Theme Manager]] which can be opened by going to [[Menubar_Control|Menubar]] -> File -> Themes or by typing the [[/themes]] command.

h2. How it works

AdiIRC will read the MTS theme file, then generate a script based on the format called "ThemeCache.ini" which will be visible in the [[Scripteditor_Dialog|Script Editor]].

Changing a theme or applying a non MTS theme will overwrite or delete the "ThemeCache.ini" script.

h2. Available Events in the engine

table(#keys).

|*Event*|*Description*|

|*Connect* | Allows adding text when a server is fully connected (Same as [[on CONNECT]])|

|*Disconnect* | Allows custom text when a server is disconnected (Same as [[on DISCONNECT]])|

|*Logon* | Allows adding text when a server is about to logon (Same as [[on LOGON]])|

|*ClientText* | Allows custom client text output. (Same as [[on CLIENTTEXT]])|

|TextChan | Standard text in a channel.|

|TextChanSelf | Your text in a channel.|

|ActionChan | Action performed in a channel.|

|ActionChanSelf | You perform an action in a channel.|

|NoticeChan | You receive a channel or op notice.                 |

|Notice | You receive a private notice.|

|NoticeSelf | You send a private notice.|

|NoticeSelfChan | You send a channel or op notice.|                 

|TextQuery | Private message in a query or chat window.|

|TextQuerySelf | You send a message in a query or chat window.|

|ActionQuery | Action performed in a query or chat window.|

|ActionQuerySelf | You perform an action in a query or chat window.|

|TextMsg | You receive a private message.|

|TextMsgSelf | You send a private message.|

|Mode | Channel mode change. %::modes has full mode string.|

|ModeUser | You change usermodes. %::modes has full mode string.|

|Join | Another user joins a channel.|

|JoinSelf | You join a channel.|

|Part | Another user parts a channel.|

|Kick | Another user is kicked.|

|KickSelf | You are kicked.|

|Quit | A user quits IRC.|

|Topic | Topic changed in a channel.|

|Nick | Your or another user changes nickname.|

|NickSelf | You changes nickname.|

|Invite | You are invited to another channel.|

|ServerError | The server reports an error.|

|Ctcp | You receive a CTCP.|

|CtcpChan | You receive a CTCP on a channel.|

|CtcpSelf | You send a CTCP.|

|CtcpChanSelf | You send a CTCP to a channel.|

|CtcpReply | You receive a CTCP reply.|

|CtcpReplySelf | You send a CTCP reply.|           

|Wallop | A wallop message.|

|NoticeServer | A server notice.|

|RAW.N | Any raw numeric event, e.g RAW.222|

_Bold events are AdiIRC specific._

_Not available yet: UNotify, Notify, Rejoin._

h2. Available options in the engine

table(#keys).

|*Option*|*Description*|

|Name | The name of the theme.|

|Author | The name or nickname of the theme's author.|

|Email | E-mail address of the author.|

|Website | Website for the theme or author.|

|Description | A brief description of the theme.|

|Version | The version of the theme.|

|Colors | Comma separated list of control code colors to apply to various events.|

|RGBColors | These are the RGB values to use for all 16 control code colors in rrr,ggg,bbb format.|

|BaseColors | This is four colors used in the theme itself. These will be used for %::c1 through %::c4 and <c1> through <c4>.|

|SchemeNAME | Adds a new color scheme.|

|FontDefault | Sets the default font for all windows, format is FontName,FontSize|

|Prefix | This value is simply used for %::pre, so that a common prefix does not need to be rewritten on every event.|

|ParenText | This special value is used to surround part, quit, and kick messages with parenthesis.|

|Timestamp | Set to ON or OFF.|

|TimestampFormat | Sets the timestamp format.|

|*NickColumn* | Set to ON or OFF.|

|Script | This item contains the filename of a AdiIRC script to load as part of the theme. This file should contain all aliases used in !Script lines.|

|Load | Displayed (or run) when the theme is loaded. (after any script is loaded and any settings changed.)|

|Unload | Displayed (or run) right before the theme is unloaded.|

_Bold options are AdiIRC specific._

_Colors order: Background, Action text, CTCP text, Highlight text, Info text, Info2 text, Invite text, Join text, Kick text, Mode text, Nick text, Normal text, Notice text, Notify text, Other text, Own text, Part text, Quit text, Topic text, Wallops text, Whois text, Editbox, Editbox text, Listbox, Listbox text, Grayed text_

h2. Available variables in the engine

table(#keys).

|*Text Variable*|*Variable*|*Description*|

|<cmode> | %::cmode | Current mode of %::nick on %::chan, such as @ or +.|

|<modes> | %::modes | For MODE, USERMODE- Channel modes or usermodes being set.|

|<me> | %::me | Your nickname.|

|<nick> | %::nick | Nickname of user triggering event.|

|<cnick> | %::cnick | Current color of %::nick on %::chan, as a number.|

|<text> | %::text | The text or message from the event. (if any)|

|<ctcp> | %::ctcp | For CTCP, CTCPSELF, CTCPREPLY, CTCPREPLYSELF- CTCP or

                CTCPREPLYcommand. (single word) The remainder of the CTCP, if

                any, is in %::text.|

|<chan> | %::chan | Channel raw applies to. (usually from $2)|

|<knick> | %::knick | For KICK, KICKSELF- Nickname of user who was kicked. |

|<newnick> | %::newnick | For NICK, NICKSELF, the new nickname for the user. |

|<target> | %::target | Equivalent to $target, useful for op notices and certain

                other cases.|

|<parentext> | %::parentext | For KICK, KICKSELF, QUIT, PART, NOTIFY, UNOTIFY- This is the

                same as %::text, but surrounded with parenthesis. If there was

                no message, this is blank- not "()".|

|<address> | %::address | Address in ident@host format of %::nick, if available.|

|<value> | %::value | A single value of interest from a raw, usually $2.|

|<numeric> | %::numeric | Number of the raw reply being triggered.|

|<isoper> | %::isoper | WHOIS, WHO- Is this user an IRCop? Set to "is" or "is not".|

|<operline> | %::operline | WHOIS- The text of the "is an ircop" line sent by the server,

                not including the nickname, as different users may have

                different levels of status described in this line.|

|<idletime> | %::idletime | WHOIS- How long the user has been idle, in seconds.|

|<idle> | %::idle | |

|<signontime> | %::signontime | WHOIS- When the user signed on, in $asctime() format.|

|<wserver> | %::wserver | WHOIS, WHOWAS, WHO- IRC server the user is on.|

|<server> | %::server | The server you are currently connected to. (if connected)|

|<serverinfo> | %::serverinfo | WHOIS, WHOWAS- "Info" about the IRC server the user is on.

                (usually just useless text)|

|<isregd> | %::isregd | WHOIS- Is this nickname registered? Set to "is" or "is not".|

|*<isauthd>* | *%::isauthd* | WHOIS- Is this nickname authed? Set to "is" or "is not".|

|*<authnick>* | *%::authnick* | WHOIS- The authed nickname if it's authed.|

|<timestamp> | %::timestamp | The current timestamp, using the script's Timestamp line

                format. Used by <timestamp> in theme files.|

|*<userident>* | *%::userident* | WHOIS, WHOWAS, WHO- the user ident.|

|*<userhost>* | *%::userhost* | WHOIS, WHOWAS, WHO- the user hostname.|

|<realname> | %::realname | WHOIS, WHOWAS, WHO- The "full name" field.|

|*<bantime>* | *%::bantime* | Then bantime formatted in $asctime() format for ban/quiet/except/invite list.|

|*<t>* | *%:t* | The [[Messages_Options#Use-nick-column|nickcolumn character]] used to separate nick and message.|

|<c1> | %::c1 | Base color 1|

|<c2> | %::c2 | Base color 2|

|<c3> | %::c3 | Base color 3|

|<c4> | %::c4 | Base color 4|

|<pre> | %::pre | The value specified in *Prefix*|

|  | %:echo | Command being used to display text. Use in place of [[/echo]].|

_Bold variables are AdiIRC specific._

_<variablename> are used in text events, %::variablename are used in scripts._

h2. Getting themes

Check https://github.com/mIRC-Scripters/MTS-Themes, most should work, if not, please open a issue.

_The themes there can also be used as examples for creating your own._