Project

General

Profile

MTS Themes » History » Version 20

Per Amundsen, 03/27/2021 05:58 AM

1 1 Per Amundsen
{{>toc}}
2
3
h1. MTS Themes
4
5 3 Per Amundsen
"MTS" stands for mIRC Theme Standard, which defines a set of events and some options/variables to allow modifying colors and text formatting.
6 1 Per Amundsen
7
The spec can be read at https://github.com/solbu/Peace-and-Protection/wiki/MTSREF.
8
9
AdiIRC uses a mix of the spec and some of it's own events/variables.
10
11
h2. Installing a MTS theme
12
13 19 Per Amundsen
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.
14 1 Per Amundsen
15
h2. How it works
16
17 20 Per Amundsen
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]].
18 1 Per Amundsen
19
Changing a theme or applying a non MTS theme will overwrite or delete the "ThemeCache.ini" script.
20
21
h2. Available Events in the engine
22
23
table(#keys).
24
|*Event*|*Description*|
25
|*Connect* | Allows adding text when a server is fully connected (Same as [[on CONNECT]])|
26
|*Disconnect* | Allows custom text when a server is disconnected (Same as [[on DISCONNECT]])|
27
|*Logon* | Allows adding text when a server is about to logon (Same as [[on LOGON]])|
28
|*ClientText* | Allows custom client text output. (Same as [[on CLIENTTEXT]])|
29
|TextChan | Standard text in a channel.|
30
|TextChanSelf | Your text in a channel.|
31
|ActionChan | Action performed in a channel.|
32
|ActionChanSelf | You perform an action in a channel.|
33
|NoticeChan | You receive a channel or op notice.                 |
34
|Notice | You receive a private notice.|
35
|NoticeSelf | You send a private notice.|
36
|NoticeSelfChan | You send a channel or op notice.|                 
37
|TextQuery | Private message in a query or chat window.|
38
|TextQuerySelf | You send a message in a query or chat window.|
39
|ActionQuery | Action performed in a query or chat window.|
40
|ActionQuerySelf | You perform an action in a query or chat window.|
41
|TextMsg | You receive a private message.|
42
|TextMsgSelf | You send a private message.|
43
|Mode | Channel mode change. %::modes has full mode string.|
44
|ModeUser | You change usermodes. %::modes has full mode string.|
45
|Join | Another user joins a channel.|
46
|JoinSelf | You join a channel.|
47
|Part | Another user parts a channel.|
48
|Kick | Another user is kicked.|
49
|KickSelf | You are kicked.|
50
|Quit | A user quits IRC.|
51
|Topic | Topic changed in a channel.|
52
|Nick | Your or another user changes nickname.|
53
|NickSelf | You changes nickname.|
54
|Invite | You are invited to another channel.|
55
|ServerError | The server reports an error.|
56
|Ctcp | You receive a CTCP.|
57
|CtcpChan | You receive a CTCP on a channel.|
58
|CtcpSelf | You send a CTCP.|
59
|CtcpChanSelf | You send a CTCP to a channel.|
60
|CtcpReply | You receive a CTCP reply.|
61
|CtcpReplySelf | You send a CTCP reply.|           
62
|Wallop | A wallop message.|
63
|NoticeServer | A server notice.|
64
|RAW.N | Any raw numeric event, e.g RAW.222|
65
66
_Bold events are AdiIRC specific._
67
68
_Not available yet: UNotify, Notify, Rejoin._
69
70
h2. Available options in the engine
71
72
table(#keys).
73
|*Option*|*Description*|
74
|Name | The name of the theme.|
75
|Author | The name or nickname of the theme's author.|
76
|Email | E-mail address of the author.|
77
|Website | Website for the theme or author.|
78
|Description | A brief description of the theme.|
79
|Version | The version of the theme.|
80 5 Per Amundsen
|Colors | Comma separated list of control code colors to apply to various events.|
81 1 Per Amundsen
|RGBColors | These are the RGB values to use for all 16 control code colors in rrr,ggg,bbb format.|
82
|BaseColors | This is four colors used in the theme itself. These will be used for %::c1 through %::c4 and <c1> through <c4>.|
83
|SchemeNAME | Adds a new color scheme.|
84
|FontDefault | Sets the default font for all windows, format is FontName,FontSize|
85
|Prefix | This value is simply used for %::pre, so that a common prefix does not need to be rewritten on every event.|
86
|ParenText | This special value is used to surround part, quit, and kick messages with parenthesis.|
87
|Timestamp | Set to ON or OFF.|
88
|TimestampFormat | Sets the timestamp format.|
89
|*NickColumn* | Set to ON or OFF.|
90 14 Per Amundsen
|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.|
91 1 Per Amundsen
|Load | Displayed (or run) when the theme is loaded. (after any script is loaded and any settings changed.)|
92
|Unload | Displayed (or run) right before the theme is unloaded.|
93
94
_Bold options are AdiIRC specific._
95
96
_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_
97
98
h2. Available variables in the engine
99
100
table(#keys).
101 2 Per Amundsen
|*Text Variable*|*Variable*|*Description*|
102 8 Per Amundsen
|&lt;cmode&gt; | %::cmode | Current mode of %::nick on %::chan, such as @ or +.|
103
|&lt;modes&gt; | %::modes | For MODE, USERMODE- Channel modes or usermodes being set.|
104
|&lt;me&gt; | %::me | Your nickname.|
105
|&lt;nick&gt; | %::nick | Nickname of user triggering event.|
106
|&lt;cnick&gt; | %::cnick | Current color of %::nick on %::chan, as a number.|
107 10 Per Amundsen
|&lt;text&gt; | %::text | The text or message from the event. (if any)|
108
|&lt;ctcp&gt; | %::ctcp | For CTCP, CTCPSELF, CTCPREPLY, CTCPREPLYSELF- CTCP or
109
                CTCPREPLYcommand. (single word) The remainder of the CTCP, if
110
                any, is in %::text.|
111
|&lt;chan&gt; | %::chan | Channel raw applies to. (usually from $2)|
112
|&lt;knick&gt; | %::knick | For KICK, KICKSELF- Nickname of user who was kicked. |
113
|&lt;newnick&gt; | %::newnick | For NICK, NICKSELF, the new nickname for the user. |
114
|&lt;target&gt; | %::target | Equivalent to $target, useful for op notices and certain
115
                other cases.|
116
|&lt;parentext&gt; | %::parentext | For KICK, KICKSELF, QUIT, PART, NOTIFY, UNOTIFY- This is the
117
                same as %::text, but surrounded with parenthesis. If there was
118
                no message, this is blank- not "()".|
119
|&lt;address&gt; | %::address | Address in ident@host format of %::nick, if available.|
120
|&lt;value&gt; | %::value | A single value of interest from a raw, usually $2.|
121
|&lt;numeric&gt; | %::numeric | Number of the raw reply being triggered.|
122
|&lt;isoper&gt; | %::isoper | WHOIS, WHO- Is this user an IRCop? Set to "is" or "is not".|
123
|&lt;operline&gt; | %::operline | WHOIS- The text of the "is an ircop" line sent by the server,
124
                not including the nickname, as different users may have
125
                different levels of status described in this line.|
126
|&lt;idletime&gt; | %::idletime | WHOIS- How long the user has been idle, in seconds.|
127
|&lt;idle&gt; | %::idle | |
128
|&lt;signontime&gt; | %::signontime | WHOIS- When the user signed on, in $asctime() format.|
129
|&lt;wserver&gt; | %::wserver | WHOIS, WHOWAS, WHO- IRC server the user is on.|
130
|&lt;server&gt; | %::server | The server you are currently connected to. (if connected)|
131
|&lt;serverinfo&gt; | %::serverinfo | WHOIS, WHOWAS- "Info" about the IRC server the user is on.
132
                (usually just useless text)|
133
|&lt;isregd&gt; | %::isregd | WHOIS- Is this nickname registered? Set to "is" or "is not".|
134 11 Per Amundsen
|*&lt;isauthd&gt;* | *%::isauthd* | WHOIS- Is this nickname authed? Set to "is" or "is not".|
135
|*&lt;authnick&gt;* | *%::authnick* | WHOIS- The authed nickname if it's authed.|
136 10 Per Amundsen
|&lt;timestamp&gt; | %::timestamp | The current timestamp, using the script's Timestamp line
137
                format. Used by <timestamp> in theme files.|
138 12 Per Amundsen
|*&lt;userident&gt;* | *%::userident* | WHOIS, WHOWAS, WHO- the user ident.|
139
|*&lt;userhost&gt;* | *%::userhost* | WHOIS, WHOWAS, WHO- the user hostname.|
140 1 Per Amundsen
|&lt;realname&gt; | %::realname | WHOIS, WHOWAS, WHO- The "full name" field.|
141 12 Per Amundsen
|*&lt;bantime&gt;* | *%::bantime* | Then bantime formatted in $asctime() format for ban/quiet/except/invite list.|
142 11 Per Amundsen
|*&lt;t&gt;* | *%:t* | The [[Messages_Options#Use-nick-column|nickcolumn character]] used to separate nick and message.|
143 10 Per Amundsen
|&lt;c1&gt; | %::c1 | Base color 1|
144
|&lt;c2&gt; | %::c2 | Base color 2|
145
|&lt;c3&gt; | %::c3 | Base color 3|
146
|&lt;c4&gt; | %::c4 | Base color 4|
147
|&lt;pre&gt; | %::pre | The value specified in *Prefix*|
148 17 Per Amundsen
|  | %:echo | Command being used to display text. Use in place of [[/echo]].|
149 1 Per Amundsen
150
_Bold variables are AdiIRC specific._
151 13 Per Amundsen
152
_<variablename> are used in text events, %::variablename are used in scripts._
153 15 Per Amundsen
154
h2. Getting themes
155
156 18 Per Amundsen
Check https://github.com/mIRC-Scripters/MTS-Themes, most should work, if not, please open a issue.
157 16 Per Amundsen
158
_The themes there can also be used as examples for creating your own._