Chatty/chatty.github.io
1
0
Fork 0
mirror of https://github.com/chatty/chatty.github.io.git synced 2024-11-08 12:02:28 +01:00
Code Issues Projects Releases Wiki Activity

v0.9.3

Browse Source
This commit is contained in:
tduva 2018-12-31 07:36:39 +01:00
parent a4fe711bd7
commit 72abd84be1
11 changed files with 368 additions and 110 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

6
help/help-addressbook.html
View File

@ -50,7 +50,7 @@
<ul>
<li><code>add &lt;name&gt;</code> - Adds a name</li>
<li><code>add &lt;name&gt; &lt;categories&gt;</code> - Adds a name and directly assigns it the given categories, or adds the
categories to the name if it already exists (categories are comma-seperated, without spaces)</li>
categories to the name if it already exists (categories are comma-separated, without spaces)</li>
<li><code>set &lt;name&gt; &lt;categories&gt;</code> - Sets the categories for this name, adding it if necessary, replacing
any present categories for this name</li>
<li><code>remove &lt;name&gt;</code> - Completely removes the given name</li>
@ -62,7 +62,7 @@
<li><code>get &lt;name&gt;</code> - Shows the categories for this name</li>
<li><code>info</code> - Shows number of entries and used categories</li>
</ul>
<p>Categories are given as a comma-seperated list without spaces, e.g. <code>cat1,cat2,cat3</code>.</p>
<p>Categories are given as a comma-separated list without spaces, e.g. <code>cat1,cat2,cat3</code>.</p>
<p>The following commands edit all entries at once, so they should be used with care:</p>
<ul>
<li><code>renameCategory &lt;currentName&gt; &lt;newName&gt;</code> - Renames a category, which means all occurences
@ -117,7 +117,7 @@
<dd><code>/set abCommandsChannel #yourchannel</code></dd>
<dt><code>abCommands</code></dt>
<dd>A comma-seperated list of commands you want the mods to be able to
<dd>A comma-separated list of commands you want the mods to be able to
use. Commands can be anything that is
listed in the <a href="#commands">Commands</a> section above. So for
example if you wanted to allow the <code>add</code> and <code>set</code>

78
help/help-custom_commands.html
View File

@ -10,7 +10,12 @@
customize some Context Menus (and the User Info Dialog) with your own entries.</p>
<ul>
<li><a href="#custom-commands">Custom Commands</a></li>
<li>
<a href="#custom-commands">Custom Commands</a>
<ul>
<li><a href="#anonymous-custom-commands">Anonymous Custom Commands</a></li>
</ul>
</li>
<li>
<a href="#replacements">Replacements</a>
<ul>
@ -66,6 +71,26 @@
Commands list as well, it will fallback to that in other channels. This
way to can add variations of commands for specific channels.</p>
<h3><a name="anonymous-custom-commands">Anonymous Custom Commands</a></h3>
<p>Custom Commands that aren't defined in the Custom Commands list do not
have a name and can thus only be executed from the context they are
defined, for example when adding <a href="#inline-commands">Inline-Commands</a>
to the User Dialog or Context Menus.</p>
<p>You can also execute Anynomous Custom Commands directly from the
inputbox, by prepending <code>//</code>, which allows you to use
Replacements:</p>
<dl class="defList">
<dt><code>/echo Open Channels: $(chans)</code></dt>
<dd>Executes as a normal command (nothing replaced)</dd>
<dd>Outputs <code>Open Channels: $(chans)</code></dd>
<dt><code>//echo Open Channels: $(chans)</code></dt>
<dd>Executes as an Anonymous Custom Command</dd>
<dd>Outputs <code>Open Channels: joshimuz lotsofs cirno_tv</code></dd>
</dl>
<h2><a name="replacements">Replacements</a></h2>
<ul>
<li><a href="#simple-replacements">Simple Replacements</a></li>
@ -117,7 +142,7 @@
<p><code>/me slaps <strong>moobot</strong> around a bit with a large trout</code></p>
<p>This is the syntax for specifying parameters (word in this context means
anything seperated by a space):</p>
anything separated by a space):</p>
<dl>
<dt><code>$1, $2, $3</code></dt>
<dd>First word, second word, third word etc.</dd>
@ -153,10 +178,20 @@
<th>Description</th>
</tr>
<tr>
<td rowspan="7"><em>All</em></td>
<td rowspan="9"><em>All</em></td>
<td><code>chan</code></td>
<td>The current channel context (without leading #)</td>
</tr>
<tr>
<td><code>stream</code></td>
<td>The stream name of the current channel context (different from
<code>chan</code> for Chatrooms)</td>
</tr>
<tr>
<td><code>chans</code></td>
<td>All currently open regular channels (separated by spaces,
without leading #)</td>
</tr>
<tr>
<td><code>streamstatus</code></td>
<td>Stream Status (Title/Game or Offline)</td>
@ -180,13 +215,26 @@
<tr>
<td colspan="2">The stream info is of the current channel context</td>
</tr>
<!-- User Context Menu -->
<tr>
<td>User Context Menu</td>
<td rowspan="3">User Context Menu</td>
<td><code>1</code></td>
<td>Name of the user</td>
</tr>
<tr>
<td rowspan="2">User Dialog</td>
<td><code>msg-id</code></td>
<td>Message id of the selected message (depending on the line in
chat you opened the User Contex Menu from)</td>
</tr>
<tr>
<td><code>automod-msg-id</code></td>
<td>Message id of the selected message filtered by AutoMod, for
approving or denying the message (when opened by clicking on
an appropriate message in chat)</td>
</tr>
<!-- User Dialog -->
<tr>
<td rowspan="4">User Dialog</td>
<td><code>1</code></td>
<td>Name of the user</td>
</tr>
@ -194,11 +242,24 @@
<td><code>2-</code></td>
<td>Ban reason (if selected)</td>
</tr>
<tr>
<td><code>msg-id</code></td>
<td>Message id of the selected message (<code>&gt;</code> in front
of message, depending on the line in chat you opened it from)</td>
</tr>
<tr>
<td><code>automod-msg-id</code></td>
<td>Message id of the selected message filtered by AutoMod, for
approving or denying the message (when opened by clicking on
an appropriate message in chat)</td>
</tr>
<!-- Channel Context Menu -->
<tr>
<td>Channel Context menu</td>
<td><code>1</code></td>
<td>Name of the currently active channel (without leading #)</td>
</tr>
<!-- Streams Context Menu -->
<tr>
<td>Streams Context menu</td>
<td><code>1-</code></td>
@ -256,6 +317,13 @@
<dd>Makes the given input lowercase.</dd>
<dd><em>Example:</em> <code>$lower(1)</code> with <code>1</code>
referring to <code>Fremily</code> turns into <code>fremily</code>.</dd>
<dt><code>$rand(&lt;output1&gt;,&lt;output2&gt;,&lt;output3&gt,..)</code></dt>
<dd>Randomly chooses one of the outputs.</dd>
<dd><em>Example:</em> <code>$rand(cheesecake,strawberry cake,$1-)</code>
with <code>1-</code> referring to <code>apple pie</code> turns into
either <code>cheesecake</code>, <code>strawberry cake</code> or
<code>apple pie</code>.</dd>
</dl>
<p class="note"><em>Note:</em> The <code>&lt;identifier&gt;</code> parameter means <em>only</em>

2
help/help-guide1.html
View File

@ -14,7 +14,7 @@
<p>This means that when you run more than one instance on the same computer,
the last one you close always overwrites the settings.</p>
<h2>Seperate settings</h2>
<h2>Separate settings</h2>
<p>You can change the default settings directory by using the <code>-cd</code>
commandline paramter, which changes the settings directory to the current
working directory, meaning the settings are loaded and saved in the same

2
help/help-livestreamer.html
View File

@ -12,7 +12,7 @@
</p>
<p><a href="https://github.com/chrippa/livestreamer">Livestreamer</a>
is a commandline program that can be used to watch streams in a player like
VLC Player. It has to be downloaded and installed seperately from Chatty.</p>
VLC Player. It has to be downloaded and installed separately from Chatty.</p>
<p><strong>Note:</strong> Since Livestreamer doesn't appear to be developed anymore, there is an
updated fork called <a href="https://streamlink.github.io/">Streamlink</a>, which works the same way. If you want to

80
help/help-releases.html
View File

@ -17,6 +17,7 @@
<h1><a name="top">Release Information</a></h1>
<p>
<a href="#0.9.3">0.9.3</a> |
<a href="#0.9.2">0.9.2</a> |
<a href="#0.9.1">0.9.1</a> |
<a href="#0.9">0.9</a> |
@ -52,7 +53,74 @@
full list of changes.</p>
<h2>
<a name="0.9.2">Version 0.9.2</a> <a name="latest">(This one!)</a> (2018-10-26)
<a name="0.9.3">Version 0.9.3</a> <a name="latest">(This one!)</a> (2018-12-31)
<a href="#top" class="top">[back to top]</a>
</h2>
<p>Custom Message Colors and Highlights can now also apply to Info Messages
and allow you to set the background color, so it's possible to customize
the foreground/background of almost any message in the chat window.</p>
<p>Moderators can now delete individual messages and get who performed a
moderation action directly appended to the associated message.</p>
<pre>
### Chat
- Added ability to customize message background color (through Message Colors
settings and the "bgcolor:" prefix for Highlights)
- Added prefix "config:info" to Message Colors settings and Highlights as well,
allowing you to customize the foreground/background color for more messages
(e.g. `config:info [Notification]` in Msg. Colors to customize the color of
subscriber notifications)
- Added prefix "config:any" to match both Regular Messages and Info Messages
- Added prefix "config:firstmsg" to only match the first message of a user in
a channel during the current session
- Added "replacement:none" prefix to Filter list to have no replacement at all
### Moderation
- Added support for deletion of single messages (Delete button automatically
added to the User Dialog)
- Append which mod performed an action (e.g. ban/timeout), and only show
separate ModAction message if no associated message is present in chat
- Output ban/timeout reason from Modlogs, since Twitch removed it from chat
### Custom Commands
- Added "/chain" command to perform several commands at once
- Added $(chans) parameter containing all open regular channels
- Added $(msg-id) and $(automod-msg-id) parameters to User Context Menu
- Added $rand() function, to choose one random entry from the parameter list
- Extended Click-On-User-Holding-Ctrl command to allow anonymous commands
- Added "//" prefix to inputbox to directly run anonymous command
(e.g. `//echo $(chans)`)
### TAB Completion
- Changed TAB Completion for Emoji to search within codes without min. character
limit, but only search at the beginning of words (separated by underscores)
and only at the very beginning if already too many matches
- Changed TAB Completion for Emotes/Commands to search at the beginning of words
as well (capitalized), so e.g. "chair"+TAB will find both "joshChair" and
"broughyChair" (setting options for previous behaviour or to search anywhere)
### Misc
- Added Splash Screen that shows while Chatty is starting
- Added /marker support to add Stream Markers (also extended Stream Highlights
feature to add Stream Marker at the same time, added to Settings Dialog)
- Added ability to revoke (not just remove) Login token directly out of Chatty
- Improved debug output
- Improved performance
- Made links in info messages clickable
- Improved Username Color Correction, added several modes to choose from
- Changed "/join" command to allow joining several space-seperated channels
- Some other improvements
- Updated help
### Bugfixes
- Fixed Custom Usericons matching a 3rd Party badge type inadvertently applying
to every user
- Fixed colors in Viewer History graph for dark Look&amp;Feel
</pre>
<h2>
<a name="0.9.2">Version 0.9.2</a> (2018-10-26)
<a href="#top" class="top">[back to top]</a>
</h2>
<p>Highlights of this update include the changed Color Settings &amp; Chat
@ -1191,7 +1259,7 @@ New features:
Changes:
- Changed message parsing to support "&lt;name&gt; is now hosting you" notification
(only works on Twitch Client Version 3 though, see Settings - Advanced)
- Added setting to specify the timezone of the timestamp seperately from the
- Added setting to specify the timezone of the timestamp separately from the
system timezone setting
- Added kadgar.net to open live streams from the context menu
- Added optional filter to remove combining characters used in some languages
@ -1250,7 +1318,7 @@ Changes:
- Added Ctrl+J shortcut for opening Join Dialog
- Save Channel Favorites sort order between sessions
- Increased number of saved lines per user from 20 to 100
- Reorganized Settings Dialog a bit (Usericons/Emoticons on seperate pages)
- Reorganized Settings Dialog a bit (Usericons/Emoticons on separate pages)
- Added context menu to Race Id (blue link) in Race Viewer
- Possibly improved debugging of emoticon loading errors a bit
- Updated help
@ -1273,7 +1341,7 @@ Bugfixes:
username, addressbook category and channel, then choose whether to
completely hide them, show how many were ignored every 30s (if any)
or show which users where ignored. Ignored messages also get added
to a seperate window so you can check them if you want to.</li>
to a separate window so you can check them if you want to.</li>
<li>Improved Update Notification.</li>
<li><a href="help-livestreamer.html">Livestreamer</a> context menu
quality selection customizable.</li>
@ -1602,7 +1670,7 @@ Changes:
<h3>Full Changelog</h3>
<pre>Changes:
- FrankerFaceZ: Show custom mod icons (available in some channels)
- FrankerFaceZ settings, Emoticons/Icon settings seperate
- FrankerFaceZ settings, Emoticons/Icon settings separate
- Prevent dialogs that can open automatically (error messages) from
stealing focus
- Added chat buffer size setting
@ -1685,7 +1753,7 @@ New features:
Changes:
- Nicks in JOIN/PART/MOD/UNMOD lines now clickable
- Settings now saved in seperate files for general settings, login data and
- Settings now saved in separate files for general settings, login data and
history/favorites
- Fixed tab colors, added indicator for new stream status
- Added delay for global hotkey so it doesn't repeat as much if kept pressed

7
help/help-setting_commands.html
View File

@ -312,7 +312,7 @@
<tr>
<td class="setting">portDefault</td>
<td>String</td>
<td>One or more ports, seperated by comma</td>
<td>One or more ports, separated by comma</td>
<td class="settingDefault">6667,80</td>
<td>Default port to connect to, which can be changed in the
Settings Dialog and is saved between sessions</td>
@ -328,7 +328,7 @@
<tr class="settingExclusive">
<td class="setting">port</td>
<td>String</td>
<td>One or more ports, seperated by comma</td>
<td>One or more ports, separated by comma</td>
<td class="settingDefault"><em>empty</em></td>
<td>If set, overrides the <code>defaultPort</code>, can be
set by commandline options, not saved in between sessions</td>
@ -406,7 +406,8 @@
<tr>
<td class="setting">commandOnCtrlClick</td>
<td>String</td>
<td>Command to run (only the command name)</td>
<td>Command to run (single word interpreted as command name,
otherwise anonymous command)</td>
<td><em>empty</em></td>
<td>The command to run when clicking on a user while holding
<kbd>Ctrl</kbd></td>

183
help/help-settings.html
View File

@ -29,6 +29,7 @@
| <a href="#Advanced">Advanced</a>
| <a href="#TAB_Completion">TAB Completion</a>
| <a href="#History">History</a>
| <a href="#Stream">Stream Highlights</a>
| <a href="#Hotkeys">Hotkeys</a></p>
<p>This page details some of the settings in the Settings Dialog
@ -81,8 +82,8 @@
<a name="Message_Colors">Message Colors</a>
<a href="#top" class="top">[back to menu]</a>
</h2>
<p>You can customize the color of messages based on the same message
matching rules and patterns that are used for the
<p>You can customize the foreground and background color of messages based
on the same message matching rules and patterns that are used for the
<a href="#Highlight_Matching">Highlight system</a> (not all prefixes
apply). Add a new item, enter what messages you want to match and select
the color you want them to have.</p>
@ -90,8 +91,7 @@
<p>The order of entries can matter, the first color from the top that
matches is used.</p>
<p><em>Note:</em> The default message color is set on the "Colors" settings
page ("Normal message").</p>
<p><em>Note:</em> The default colors are set on the "Colors" settings page.</p>
<p><em>Note:</em> This feature only changes the message <em>color</em>. Use
the Highlight system instead if you want
@ -634,10 +634,32 @@
<a href="#top" class="top">[back to menu]</a>
</h2>
<dl class="dl-settings">
<dt>Show moderator actions in chat</dt>
<dt>Show Moderator Actions in chat</dt>
<dd>Show commands that moderators execute directly in chat. You can also
view the same messages under <code>Extra - Moderation Log</code>.
Only works if you are a moderator yourself.</dd>
Only works if you are a moderator yourself.
<dl class="dl-settings dl-settings-sub">
<dt>Hide if associated action already visible in chat (e.g. ban)</dt>
<dd>Example: If a mod turns on Subscriber-Only mode, everyone
will get an info message about it, which means (if enabled,
for mods) @Mod will be appended to that info message. Due to
this, no separate Mod Action message will be shown.</dd>
<dd>On the other hand, if a mod unbans someone, there is no
associated message in chat, so (if enabled) a separate Mod
Action message will always be shown.</dd>
<dd>In addition, if a mod bans someone, but no message of that
user is currently visible in chat, then a separate Mod
Action message might be shown.</dd>
</dl>
</dd>
<dt>Append which @Mod caused an Action (e.g. ban)</dt>
<dd>Append the name of the moderator to actions in chat, for example
behind a deleted message or an info message such as
<code>[Info] This room is now in subscribers-only mode. (@tduva)</code>.</dd>
<dd>Note that the association of Mod Action and existing message in chat
may not always be perfect, especially if different mods perform the
same or similiar action at the same time.</dd>
<dt>Show messages rejected by AutoMod</dt>
<dd>Show messages that have to be approved directly in chat. To approve
@ -710,12 +732,24 @@
<li><strong>Check ignored messages</strong>: Only checks ignored messages
for highlights if this is enabled.</li>
</ul>
<h3>Add terms to be highlighted</h3>
<h3>Overview</h3>
<p>Add items to the list to make a message highlighted if any one of them
match the message. The <code>Users to never highlight</code> and
<code>Highlight Blacklist</code> settings can be used to prevent some of
those Highlights.</p>
<p>The following sections list different kinds of prefixes that can modify
the behaviour of the system:</p>
<ul>
<li><a href="#Highlight_Matching">Text Matching Prefixes</a></li>
<li><a href="#Highlight_Meta_Matching">Meta Prefixes (Matching)</a> (e.g. matching by channel, user or message type)</li>
<li><a href="#Highlight_Meta_Behaviour">Meta Prefixes (Behaviour)</a> (e.g. changing resulting text color)</li>
</ul>
<p>By default only regular chat messages are matched, however with the
<code>config:info</code> prefix info messages (e.g. subs, chat status)
can be matched instead.</p>
<h3><a name="Highlight_Matching">Text Matching Prefixes</a></h3>
<p>By default, matching is performed <em>case-insensitive</em> and <em>anywhere</em> in the
message. However, you can add one of the following prefixes in front of
@ -753,23 +787,26 @@
</li>
</ul>
<h3>Meta Prefixes</h3>
<p>The following prefixes don't change the matching of the text itself, but
rather provide other information for the highlight system. You can place
one or several of these prefixes before the search text (separated by
<h3><a name="Highlight_Meta_Matching">Meta Prefixes (Matching)</a></h3>
<p>The following prefix don't match on the text itself, but define other
things that should or should not trigger a Highlight. You can place one
or several of these prefixes before the search text (separated by
spaces):
<code>[meta-prefix:value]&nbsp;[..]&nbsp;[text-prefix:]&lt;search text&gt;</code></p>
<ul>
<li><code>user:</code> to specifiy one exact username (case-insensitive)
<li><code>user:</code> to specify one exact username (case-insensitive)
which should highlight only if this user send the message, doesn't
search in the message itself.</li>
<li><code>reuser:</code> to specify a regex to match usernames against.
Behaves like the <code>regm:</code>/<code>re:</code> prefix, in that
it always tries to match the entire username. Example:
<code>reuser:(?i)a.*</code> would match all names starting with "a".</li>
<li><code>cat:</code> to specify a category the user who send the message
should be in (as defined in the <a href="help.html#addressbook">Addressbook</a>).</li>
<li><code>!cat:</code> to specify a category the user who send the message
can NOT be in.</li>
<li><code>chan:</code> to specify one or more channels the message has
to be send in to match (several channels are specified as comma-seperated
to be send in to match (several channels are specified as comma-separated
list, without spaces).</li>
<li><code>!chan:</code> to specify one or more channels the message must
NOT be send in to match.</li>
@ -799,27 +836,69 @@
the given status codes (see <code>status:</code> for codes). For example:
<code>!status:stM</code> matches all 'normal' users that have no
badge by default (NOT a Subscriber, Turbo User or any kind of Moderator).</li>
<li><code>color:</code> to specify a color other than the default one
for displaying this highlight. <em>If you have items with a custom
color defined, which match something that might also be matched
by other items (with another color or custom color)
then the order of items is important so it displays the desired color.
Items on the top are matched first, so move items up that should take
precedence. For example <code>test</code> and
<code>color:blue test2</code>. If <code>test</code> is on the top
it will never get to the blue one, because <code>test</code> will
always match when <code>test2</code> would match as well.</em></li>
<li><code>config:</code> to specify one or more options (seperated
by comma) that changes the behaviour):
<li><code>config:</code> to specify on or more options (separated by comma, no spaces):
<ul>
<li><code>silent</code> - Disable sounds for this item</li>
<li><code>!notify</code> - Disable notifications for this item</li>
<li><code>info</code> - This item applies to info messages instead
of regular user messages (works only for Ignoring messages at the
moment)</li>
<li><code>config:firstmsg</code> - Restrict matching to the
first message of this user in this channel during the
current session (first message in User Dialog)</li>
<li><code>config:info</code> - This item applies to info
messages instead of regular user messages</li>
<li><code>config:any</code> - This item applies to both info
messages and regular user messages</li>
</ul>
</li>
</ul>
<h3><a name="Highlight_Meta_Behaviour">Meta Prefixes (Behaviour)</a></h3>
<p>The following prefixes don't change what is highlighted, but rather
change what a Highlight does. You can place one or several of these
prefixes before the search text (separated by spaces):
<code>[meta-prefix:value]&nbsp;[..]&nbsp;[text-prefix:]&lt;search text&gt;</code></p>
<ul>
<li><code>color:</code> to specify a color other than the default
Highlight color for displaying this Highlight (HTML Color Codes as
well as some Named Colors such as "blue").</li>
<li><code>bgcolor:</code> to specify a background color other than the
default Highlight background color for displaying this Highlight.</li>
<li><code>config:</code> to specify one or more options (separated
by comma, no spaces):
<ul>
<li><code>config:silent</code> - Disable sounds for this item</li>
<li><code>config:!notify</code> - Disable notifications for this item</li>
</ul></li>
</ul>
<p><em>Note:</em> If you're using the <code>color:</code> or <code>bgcolor:</code>
prefix to merely change the message color, but are not interested in
actually Highlighting it - which includes a Notification and adding the
message to the Highlighted Messages window - then consider using Custom
Message Colors instead.</p>
<h3>Order of items</h3>
<p>When using prefixes that change the behaviour (like setting a color) the
order of Highlight items may be important, since the settings of the
first matching item (from the top of the list) will be used. Contrary to
that, if the choice is merely whether or not to highlight, then the
order matter less (it can still matter for which matches in the message
are emphasized).
<p>Example: If you have one item <code>bgcolor:yellow&nbsp;user:joshimuz</code>
that makes all messages of "Joshimuz" have a yellow background and
another item <code>start:!bet</code> that highlights all messages
starting with "!bet", then messages from "Joshimuz" that also happen to
be starting with "!bet" will either have a yellow background or not,
depending on the order of the two items in the list, so which one comes
first.</p>
<p><em>Note:</em> If you have the "Highlight own name" setting enabled, then
it creates a Highlight item containing your name that will always be
checked first. So if you want to e.g. change the color of messages
containing your name as well, then you should disable that option and
manually add an appropriate entry to the list (e.g.
<code>w:&lt;yourname&gt;</code>), so that you can control it's position
in the list in relation to other items yourself.</p>
<h3><a name="Highlight_Examples">Examples</a></h3>
<dl>
<dt><code>word1 word2</code></dt>
@ -973,12 +1052,10 @@
For example if you add <code>regw:a\w*</code> to the list, it will
remove all words starting with <code>a</code> from messages in chat and
replace it with <code><u>..</u></code>, which can be hovered over to
show the original text. If you prepend <code>replacement:Wordwitha</code>,
then instead of replacing it with the default <code><u>..</u></code>,
the removed text gets replaced with <code><u>Wordwitha</u></code>. If
you don't just want to use this as a fun word guessing game, then a more
useful application might be to e.g. filter out parts of bot messages
that are always the same.</p>
show the original text.</p>
<p>An example usage for this could be to shorten bot messages by removing
parts that are always the same.</p>
<p>The text matching syntax is the same as for the <a href="#Highlight">Highlight</a> list,
although you have to remember that only the the parts of a message that
@ -989,12 +1066,22 @@
also only uses the matches from the first item in the list that matches
any part of the message. This may be changed in the future.</p>
<h3>Customize replacement</h3>
<p>The <code>replacement:</code> prefix can be used to change the default
<code><u>..</u></code> the filtered text is replaced with to something
more meaningfull. For example if your entry is
<code>replacement:Wordwitha regw:a\w*</code> then the removed text gets
replaced with <code><u>Wordwitha</u></code>.</p>
<p>You can use <code>replacement:none</code> to output no replacement at
all.</p>
<h2>
<a name="Log_to_file">Log to file</a>
<a href="#top" class="top">[back to menu]</a>
</h2>
<p>If you enable logging, chat messages (and more if enabled) will be written
into a seperate textfile for each channel.</p>
into a separate textfile for each channel.</p>
<h3>Channels</h3>
<p>You can specify which channels should be logged:</p>
<ul>
@ -1054,6 +1141,10 @@
<dd>The reason is specified by the mod taking the action, so it may be
consist of any text.</dd>
<dt>Deleted Messages</dt>
<dd>Single deleted messages, specifying the username and message text.</dd>
<dd><code>DELETED: name1 (msg1), name1 (msg2), name2 (msg3)</code></dd>
<dt>Mod/Unmod</dt>
<dd>When someone in chat is modded or unmodded. Remember that this info
may be inaccurate, since mod/unmod events are not send immediately
@ -1684,6 +1775,22 @@
<p>Both of these lists also allow you to manually add favorites, in addition
to the automatic history.</p>
<h2>
<a name="Stream">Stream Highlights</a>
<a href="#top" class="top">[back to menu]</a>
</h2>
<p>Allows your mods to trigger <a href="help.html#streamhighlights">Stream Highlights</a>,
which writes the current uptime/optional note to a textfile.</p>
<dl class="dl-settings">
<dt>Mod Command Channel</dt>
<dd>Allows moderators in the given channel to run the command.</dd>
<dd>For example if your channel/stream is called <code>zoton2</code> you would enter <code>zoton2</code>.</dd>
<dt>Mod Command</dt>
<dd>The command the mods have to use to add a Stream Highlight.</dd>
<dd>With the default <code>!highlight</code> mods would enter <code>!highlight [optional message]</code>.</dd>
</dl>
<h2>
<a name="Hotkeys">Hotkeys</a>

4
help/help-short_guides.html
View File

@ -124,7 +124,7 @@
<p>Since Chatty can only connect to one server at a time, you either have
to only join channels that are on the Event Chat servers, or run two
<a href="help-guide1.html">seperate instances</a> of Chatty at the
<a href="help-guide1.html">separate instances</a> of Chatty at the
same time.</p>
<p>There are different ways of connecting to a different server:</p>
@ -137,7 +137,7 @@
<li>The <code>Server</code> and <code>Port</code> settings in the
Settings Dialog under <code>Advanced</code> allows you to set
fixed settings for the server to connect to. This especially makes sense
if you are using <a href="help-guide1.html">seperate settings for different instances</a> of Chatty.</li>
if you are using <a href="help-guide1.html">separate settings for different instances</a> of Chatty.</li>
</ul>
<p>If you want to switch between servers sometimes, you can create a

2
help/help-troubleshooting.html
View File

@ -278,7 +278,7 @@
<code>PATH</code> environment variable (that defines where to look
for programs of which only the filename has been entered, not the whole path).</p>
<p>You can enter <code>PATH</code> in a commandline window to check what is
in it. It should show a list of semicolon-seperated directories, one of which
in it. It should show a list of semicolon-separated directories, one of which
should point to Java.</p>
<h3>Find errors in debug.log</h3>

90
help/help.html
View File

@ -5,7 +5,7 @@
<link rel="stylesheet" type="text/css" href="style.css" />
</head>
<body>
<h1><a name="top">Chatty (Version: 0.9.2)</a></h1>
<h1><a name="top">Chatty (Version: 0.9.3)</a></h1>
<table>
<tr>
<td valign="top">
@ -53,7 +53,7 @@
<li><a href="help-livestreamer.html">Livestreamer / Streamlink</a>
<li><a href="help-srl.html">SpeedrunsLive (SRL)</a></li>
<li><a href="#followers">Followers/Subscribers List</a></li>
<li><a href="#streamhighlights">Stream Highlights</a></li>
<li><a href="#streamhighlights">Stream Highlights / Markers</a></li>
<li><a href="#streamchat">Stream Chat</a></li>
</ul>
</td>
@ -105,7 +105,7 @@
<a name="title">Title and Tabs</a>
<a href="#top" class="top">[back to menu]</a>
</h2>
<img src="0_4_overview_top.png" />
<img src="0_4_overview_top.png" alt="Top of the main Chatty window, explaining the data in the title and the meaning of TAB colors" />
<p>When in a channel, Chatty shows some information about that channel
in the titlebar, e.g.:<br /><cite>[40|59] - GTA:SA Speedruns (Grand Theft Auto: San Andreas)</cite></p>
<p>The first number is the number of people in the chat, the second is the
@ -132,16 +132,14 @@
<a name="shortcuts">Hotkeys</a>
<a href="#top" class="top">[back to menu]</a>
</h2>
<p><em>You can customize most of these hotkeys in the settings, and also
add hotkeys for some functions not listed here.</em></p>
<p>Default hotkeys which can't be changed:</p>
<ul>
<li><kbd>PageUp/PageDown</kbd> - Scroll up or down in chat</li>
<li><kbd>Arrow Up/Down</kbd> (with <kbd>Ctrl</kbd> for multline) - Go through <a href="#inputHistory">Input History</a></li>
<li><kbd>TAB</kbd> - For <a href="#TAB_Completion">TAB Completion</a></li>
</ul>
<p>The following are more default hotkeys, however these can be changed
in the settings:</p>
<p>The following default hotkeys can be changed in the Settings:</p>
<ul>
<li><kbd>F1</kbd> - Open help</li>
<li><kbd>Ctrl-F</kbd> - Find text in chat</li>
@ -157,6 +155,9 @@
<li><kbd>F11</kbd> - Toggle "Fullscreen"-Mode (actually only removes the menubar and maximizes the window)</li>
</ul>
<p>In the Settings you can configure hotkeys for many more functions than
are listed here.</p>
<h2>
<a name="commands">Commands</a>
<a href="#top" class="top">[back to menu]</a>
@ -200,16 +201,20 @@
directly by prepending them with a dot <code>.</code> instead of a slash,
for example: <code>.mods</code>.</p>
<h3><a name="commands-twitch">Other Twitch Commands</a></h3>
<ul>
<li><a href="#streamhighlights">Stream Highlights / Markers commands</a> (including <code>/marker</code>)</li>
<li><code>/follow [user]</code>, <code>/unfollow [user]</code> - Follow
or unfollow the given user, or the current channel if no user is given</li>
</ul>
<h3><a name="commands-settings">Settings / Customization commands:</a></h3>
<ul>
<li><a href="#settings">Setting commands</a></li>
<li><a href="help-setting_commands.html">Setting commands</a></li>
<li><code>/setcolor &lt;name&gt;</code> - Opens the usercolor settings
for the given name</li>
<li><a href="#addressbook">Addressbook commands</a></li>
<li><a href="#streamhighlights">Stream Highlights commands</a></li>
<li><a href="#streamchat">Stream Chat commands</a></li>
<li><code>/follow [user]</code>, <code>/unfollow [user]</code> - Follow
or unfollow the given user, or the current channel if no user is given</li>
</ul>
<h3><a name="commands-gui">GUI commands:</a></h3>
@ -225,7 +230,7 @@
the current caret position (can be useful for Custom Commands put
in a menu)</li>
<li><code>/insertword &lt;text&gt;</code> - Same as <code>/insert</code>,
but adds spaces so it's seperated from text before and after (if present)</li>
but adds spaces so it's separated from text before and after (if present)</li>
<li><code>/openUrl &lt;url&gt;</code> - Opens the given url (see <a href="help-setting_commands.html#openurl">Open URL Command settings</a>)</li>
<li><code>/openUrlPrompt &lt;url&gt;</code> - Opens the given url after
showing a prompt for confirmation</li>
@ -284,6 +289,20 @@
is valid and sets it as new token if it is</li>
</ul>
<h3><a name="commands-chain">Execute several commands</a></h3>
<p>The <code>/chain</code> command allows you to run several commands at the
same time. Each part separated by a <code>|</code> is basicially
entered into the inputbox again. Whitespace around each part is trimmed.
Escape <code>|</code> with <code>|</code> to use it directly.</p>
<dl class="defList">
<dt><code>/chain /echo a | /echo b</code></dt>
<dd>Outputs <code>a</code> and <code>b</code></dd>
<dt><code>/chain /echo a | /echo ||b||</code></dt>
<dd>Outputs <code>a</code> and <code>|b|</code></dd>
</dl>
<h2>
<a name="login">Twitch Login</a>
<a href="#top" class="top">[back to menu]</a>
@ -305,6 +324,10 @@
<dd>Allows you to change the title/game of your stream and streams you
are an editor in via the <a href="help-admin.html">Admin Dialog</a>.</dd>
<dt><code>Edit broadcast</code></dt>
<dd>Allows you to create Stream Markers on your streams and streams that
you are an editor for.</dd>
<dt><code>Run commercials</code></dt>
<dd>Allows you to run comercials on your stream
via the <a href="help-admin.html">Admin Dialog</a> (if you are partnered).</dd>
@ -732,7 +755,7 @@
<a href="#top" class="top">[back to menu]</a>
</h2>
<p>The highlight system allows you to add words or phrases that make chat
messages appear in another color and appear in a seperate window, which you can
messages appear in another color and appear in a separate window, which you can
open under <code>View - Highlights</code> (you can clear the highlights window
in it's context menu).</p>
<div class="moreInfo">More information: <a href="help-settings.html#Highlight">Highlight Settings</a></div>
@ -743,7 +766,7 @@
</h2>
<p>The ignore system works very similiar to the highlight system, just that
it hides messages instead of highlighting them. They however also get
added to a seperated window, which you can open under <code>View - Ignored</code>
added to a separated window, which you can open under <code>View - Ignored</code>
(you can clear the messagess in the window in it's context menu).</p>
<p>Right-click on a user in chat to open the User Context Menu, where you
@ -969,7 +992,7 @@ MiniK http://static-cdn.jtvnw.net/emoticons/v1/25/1.0 set:793 id:3287</pre
<a name="streamchat">Stream Chat</a>
<a href="#top" class="top">[back to menu]</a>
</h2>
<p>Stream Chat is a seperate dialog, opened via the <code>/openStreamChat</code>
<p>Stream Chat is a separate dialog, opened via the <code>/openStreamChat</code>
command or the <code>Extra</code> menu, that can have chat messages from one or several
channels redirected to it (only regular chat messages, so no JOINS/PARTS, info messages
and so on). It also can have a message timeout set, so messages will
@ -978,7 +1001,7 @@ MiniK http://static-cdn.jtvnw.net/emoticons/v1/25/1.0 set:793 id:3287</pre
<p>The idea is to capture Stream Chat to display chat on stream and
messages will only be displayed if the chat has been recently active. So
this doesn't really make a lot of sense for busier channels, unless you
simply prefer to only have regular messages or to have a seperate dialog
simply prefer to only have regular messages or to have a separate dialog
for the capture.</p>
<h3>Getting started</h3>
@ -1335,7 +1358,7 @@ MiniK http://static-cdn.jtvnw.net/emoticons/v1/25/1.0 set:793 id:3287</pre
show refollows on the top of the list.</p>
<h2>
<a name="streamhighlights">Stream Highlights</a>
<a name="streamhighlights">Stream Highlights / Markers</a>
<a href="#top" class="top">[back to menu]</a>
</h2>
<p>Chatty can help you with creating Highlights of your stream by recording
@ -1361,29 +1384,20 @@ MiniK http://static-cdn.jtvnw.net/emoticons/v1/25/1.0 set:793 id:3287</pre
<code>/dir</code> command).</p>
<h3>Allow your moderators to add highlights</h3>
<p>You can also let your moderators add stream highlights
(<code>!highlight [comment]</code>), but you first have to set the channel with a
<a href="help-setting_commands.html#streamhighlights">setting command</a>:</p>
<p>You can also let your moderators add Stream Highlights
(<code>!highlight [comment]</code>), which you can configure under
<code>Main - Settings - Stream Highlights</code>.</p>
<dl class="defList">
<dt><code>/set streamHighlightChannel #&lt;yourchannelname&gt;</code></dt>
<dd>Allows moderators in the given channel to run the command.</dd>
<dd>For example if your channel/stream is called <code>zoton2</code> the
command you have to enter would be: <code>/set&nbsp;streamHighlightChannel&nbsp;#zoton2</code></dd>
</dl>
<h3>Stream Markers</h3>
<p>Twitch offers a way to add
<a href="https://help.twitch.tv/customer/portal/articles/2955281-creating-highlights-and-stream-markers">Stream Markers</a>
which show up when creating Highlights on the website. You can use the
<code>/marker</code> command or add a Stream Marker automatically when
adding a Stream Highlight (changeable in the Stream Highlights settings).</p>
<p>Optionally you can also set the following settings:</p>
<dl class="defList">
<dt><code>/set streamHighlightChannelRespond 1</code></dt>
<dd>Send a response to chat when the mod command is used (otherwise the
message is just shown locally).</dd>
<dt><code>/set streamHighlightCommand !highlight</code></dt>
<dd>Change the mod command (in this example to <code>!highlight</code>,
which is the default)</dd>
</dl>
<p><em>Tip:</em> <a href="help-setting_commands.html">Setting commands</a>
are entered into the chat input box, just like Twitch Chat commands.</p>
<p>For creating Stream Markers you need the <code>Edit broadcast</code>
<a href="#login">scope</a>, so if you don't have that yet, you have to
request a new login token.</p>
<h2>
<a name="ignoreJoinsParts">Ignore joins/parts</a>

18
index.html
View File

@ -16,9 +16,9 @@ function loaded() {
{ ceiling: null, text: "$years years ago" }
]
}
document.getElementById("ago").innerHTML = "Version 0.9.2 released "+humanized_time_span("2018/10/26", Date(), custom_date_formats)+"";
document.getElementById("ago").innerHTML = "Version 0.9.3 released "+humanized_time_span("2018/12/31", Date(), custom_date_formats)+"";
getDownloads("v0.9.2");
getDownloads("v0.9.3");
slideshow_init("slideshow");
}
@ -156,7 +156,7 @@ function getDownloads(tag) {
<h2 id="download">Download</h2>
<p>Choose one of the following downloads of <strong>Chatty Version 0.9.2</strong><span id="dlCount" style="margin-bottom:7px;"></span>. For older versions or betas go to <a href="https://github.com/chatty/chatty/releases">GitHub</a>.</p>
<p>Choose one of the following downloads of <strong>Chatty Version 0.9.3</strong><span id="dlCount" style="margin-bottom:7px;"></span>. For older versions or betas go to <a href="https://github.com/chatty/chatty/releases">GitHub</a>.</p>
<p>If this is your first time using Chatty check out the <a href="help/help-getting-started.html"><strong>Getting Started Guide</strong></a>.</p>
<h3>Windows</h3>
@ -168,11 +168,11 @@ function getDownloads(tag) {
<tr>
<td>
<dl>
<dt><a href="https://github.com/chatty/chatty/releases/download/v0.9.2/Chatty_0.9.2_win_standalone_setup.exe"><strong>Download Windows Standalone (Installer)</strong></a> <span class="recommended"><sup>Recommended</sup></span></dt>
<dt><a href="https://github.com/chatty/chatty/releases/download/v0.9.3/Chatty_0.9.3_win_standalone_setup.exe"><strong>Download Windows Standalone (Installer)</strong></a> <span class="recommended"><sup>Recommended</sup></span></dt>
<dd>Install into a folder of your choice and start <code>Chatty.exe</code> (or optionally created shortcuts).</dd>
</dl>
<dl>
<dt><a href="https://github.com/chatty/chatty/releases/download/v0.9.2/Chatty_0.9.2_win_standalone.zip">Download Windows Standalone (.zip)</a></dt>
<dt><a href="https://github.com/chatty/chatty/releases/download/v0.9.3/Chatty_0.9.3_win_standalone.zip">Download Windows Standalone (.zip)</a></dt>
<dd>Extract the .zip into a folder of your choice and start <code>Chatty.exe</code>.</dd>
</dl>
@ -180,13 +180,13 @@ function getDownloads(tag) {
</td>
<td>
<dl>
<dt><a href="https://github.com/chatty/chatty/releases/download/v0.9.2/Chatty_0.9.2_win_setup.exe">Download JAR-Version (Installer)</a></dt>
<dt><a href="https://github.com/chatty/chatty/releases/download/v0.9.3/Chatty_0.9.3_win_setup.exe">Download JAR-Version (Installer)</a></dt>
<dd>Can select global hotkey support during installation.</dd>
<dd>Install into a folder of your choice and start <code>Chatty.jar</code> (or optionally created shortcuts).</dd>
</dl>
<dl>
<dt><a href="https://github.com/chatty/chatty/releases/download/v0.9.2/Chatty_0.9.2.zip">Download JAR-Version (.zip)</a></dt>
<dd>Also available with global hotkey support for <a href="https://github.com/chatty/chatty/releases/download/v0.9.2/Chatty_0.9.2_hotkey_32bit.zip">32bit-Java</a> / <a href="https://github.com/chatty/chatty/releases/download/v0.9.2/Chatty_0.9.2_hotkey_64bit.zip">64bit-Java</a></dd>
<dt><a href="https://github.com/chatty/chatty/releases/download/v0.9.3/Chatty_0.9.3.zip">Download JAR-Version (.zip)</a></dt>
<dd>Also available with global hotkey support for <a href="https://github.com/chatty/chatty/releases/download/v0.9.3/Chatty_0.9.3_hotkey_32bit.zip">32bit-Java</a> / <a href="https://github.com/chatty/chatty/releases/download/v0.9.3/Chatty_0.9.3_hotkey_64bit.zip">64bit-Java</a></dd>
<dd>Extract the .zip into a folder of your choice and start <code>Chatty.jar</code>.</dd>
</dl>
</td>
@ -194,7 +194,7 @@ function getDownloads(tag) {
</table>
<h3>Non-Windows</h3>
<p>For OS other than Windows (e.g. Linux or MacOS) you will need to download the <a href="https://github.com/chatty/chatty/releases/download/v0.9.2/Chatty_0.9.2.zip">JAR-Version (.zip)</a> and must have Java 8 or later installed on your system. Extract the .zip into a folder of your choice and start <code>Chatty.jar</code>.</p>
<p>For OS other than Windows (e.g. Linux or MacOS) you will need to download the <a href="https://github.com/chatty/chatty/releases/download/v0.9.3/Chatty_0.9.3.zip">JAR-Version (.zip)</a> and must have Java 8 or later installed on your system. Extract the .zip into a folder of your choice and start <code>Chatty.jar</code>.</p>
<h2 id="feedback">Contact</h2>
<p>If you have any feedback or questions feel free to contact me. You can <a href="https://discord.gg/WTuqGeJ">join the Chatty Discord</a> <sup>preferred</sup>, write me an <a href="mailto:chattyclient@gmail.com">E-Mail</a> or use <a href="https://twitter.com/chattyclient">Twitter</a>.</p>