Project

General

Profile

MTS Themes » History » Revision 4

Revision 3 (Per Amundsen, 06/03/2018 05:04 PM) → Revision 4/16 (Per Amundsen, 06/03/2018 05:05 PM)

{{>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 -> 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 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 codes 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 mIRC 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*| 
 |&lt;cmode&gt; | %::cmode | | 
 |&lt;modes&gt; | %::modes | | 
 |&lt;me&gt; | %::me | | 
 |&lt;nick&gt; | %::nick | | 
 |&lt;cnick&gt; | %::cnick | | 
 |&lt;text&gt; | %::text | | 
 |&lt;ctcp&gt; | %::ctcp | | 
 |&lt;chan&gt; | %::chan | | 
 |&lt;knick&gt; | %::knick | | 
 |&lt;newnick&gt; | %::newnick | | 
 |&lt;target&gt; | %::target | | 
 |&lt;parentext&gt; | %::parentext | | 
 |&lt;address&gt; | %::address | | 
 |&lt;value&gt; | %::value | | 
 |&lt;numeric&gt; | %::numeric | | 
 |&lt;isoper&gt; | %::isoper | | 
 |&lt;operline&gt; | %::operline | | 
 |&lt;idletime&gt; | %::idletime | | 
 |&lt;idle&gt; | %::idletime | | 
 |&lt;signontime&gt; | %::signontime | | 
 |&lt;wserver&gt; | %::wserver | | 
 |&lt;server&gt; | %::server | | 
 |&lt;serverinfo&gt; | %::serverinfo | | 
 |&lt;isregd&gt; | %::isregd | | 
 |&lt;isauthd&gt; | %::isauthd | | 
 |&lt;authnick&gt; | %::authnick | | 
 |&lt;timestamp&gt; | %::timestamp | | 
 |&lt;userident&gt; | %::userident | | 
 |&lt;userhost&gt; | %::userhost | | 
 |&lt;realname&gt; | %::realname | | 
 |&lt;bantime&gt; | %::bantime | | 
 |&lt;t&gt; | %:t | | 
 |&lt;c0&gt; | %::c0 | | 
 |&lt;c1&gt; | %::c1 | | 
 |&lt;c2&gt; | %::c2 | | 
 |&lt;c3&gt; | %::c3 | | 
 |&lt;c4&gt; | %::c4 | | 
 |&lt;pre&gt; | %::pre | | 
 |    | %:echo | |