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.8.4 files

Browse Source
This commit is contained in:
tduva 2016-10-23 17:05:29 +02:00
parent 9e0a32fee7
commit 0032afe7ce
11 changed files with 653 additions and 254 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

59
changes.txt
View File

@ -1,5 +1,62 @@
0.8.3 (2016-06-28) Latest Version
0.8.4 (2016-10-23) Latest Version
### Emotes/Badges
- Added Emoji support (are shown in chat and can be favorited as Emotes)
- Added displaying of received Cheering emotes (sending Cheers is not possible)
- Added support for new Twitch Badge system (e.g. Bits Badge, Prime Badge)
- Updated Custom Usericon settings, added $badge: restriction, other stuff
- Allow Custom Usericons without an image, to hide the matching default badge
- Recognize users with Prime Badge as Turbo users for some stuff like status
smybol (+) or matching users
- Added Status Symbols: $ (Bits), + (Prime Turbo), ' (Addon), ? (Unknown)
(last two only being used in chat, when you copy&paste the message)
- Implemented proper FFZ Bots API
- Only show one set of emotes in Emote Dialog if user has both Prime and Turbo
### Settings
- Added setting whether to show the userlist by default
- Added setting to save Addressbook to file on change
- Livestreamer: Added some variables to base command ($stream, $url, $quality)
- Added Sound Output Device selection
### Commands
- Added "/ffz following" command
- Added /setsize command to set size of main window
- Added Hotkey action to close Chatty
### Moderation
- Added initial support for displaying mod actions (Broadcaster/Mods only)
- Added initial support for unofficial way of deleting single messages
- Added automatic showing of Chat Rules and menu entries to show manually
- Changed "More.." info in User Info Dialog to stay shown until clicked again
- Changed account age to show years and days
- Added User Info Dialog to window manager, so it can keep position
- Chatlog: Added account age to BAN messages, but only if info was loaded before
### Other
- Added support for Localized Names (you can configure how these are shown)
- Some changes to the build process
- Updated Context Menus:
- Removed entries for pages that Twitch removed (Twitch Profile, old Popout)
- Added some icons to some Context Menus, added some margin so mouse doesn't
hide entries
- Added Context Menu for badges, showing some info
- Added "Set color" and "Set name" User Context Menu entries
- Add Livestreams Dialog Context Menu entry to manually refresh streams
- Removed version from URL when opening Help website out of Chatty
### Bugfixes
- Fixed some dialogs not reopening even with the appropriate setting
- Fixed bug with empty Whisper TAB appearing
- Fixed reconnect delay off-by-one error
- Fixed Whisper notification typo/encoding
- Only send Content-Type header to Twitch API when sending data, which otherwise
may trip up the API
- Fixed ignoring of info messages not respecting the "Enable Ignore" setting
0.8.3 (2016-06-28)
Improvements
============

8
help/help-addressbook.html
View File

@ -16,6 +16,7 @@
<a href="#advanced">Advanced Usage</a>
<ul>
<li><a href="#modcommands">Mod Commands</a></li>
<li><a href="#saveOnChange">Save to file on change</a></li>
<li><a href="#file">Change via file</a></li>
<li><a href="#unique-cats">Unique Categories</a></li>
<li><a href="#subs-cats">Automatic Subscriber Categories</a></li>
@ -133,6 +134,13 @@
actual response, you need to have Chatty on stream (which means the response
is also affected by stream delay of course).</p>
<h3><a name="saveOnChange">Save to file on change</a></h3>
<p>If you enable the <code>abSaveOnChange</code> setting, the Addressbook
will be saved to file on each change (like adding a user, changing a
category). This can be useful if e.g. some other program is using
information from that file.</p>
<p>Example: <code>/set abSaveOnChange 1</code> to enable</p>
<h3><a name="file">Change Addressbook via file</a></h3>
<p><em>This is a rather experimental feature, so it might not work reliably.</em></p>

19
help/help-guide_folders.html
View File

@ -125,14 +125,17 @@
</table>
<h3><a name="wdir">Working Directory</a></h3>
<p>This directory is associated with Chatty when you start it. This is usually
the directory the program is started from. If you created a shortcut to start
Chatty with, this may point to the Java-executable instead of Chatty itself,
which can lead to errors. In Windows, you can change the Working Directory
in the shortcut settings by changing what is defined under <code>Run in</code>.
Make sure this points to the same folder the <code>Chatty.jar</code> is in
(or something else if you want to customize it, just make sure the files you
need are there).</p>
<p>This directory is associated with Chatty when you start it. This is
usually the directory the program is started from. In some cases,
depending on how Chatty is started, this may point to a different
directory, which can cause issues.</p>
<p>You can change the Working Directory by specifying it when you start
Chatty, usually by <a href="help-guide_create_shortcut.html">creating a shortcut</a>
and changing what is defined under <code>Run in</code> in the shortcut
settings. Make sure this points to the same folder the <code>Chatty.jar</code>
is in (or something else if you want to customize it, just make sure the
files you need are there).</p>
<p>Use the command <code>/wdir</code> to display and <code>/openWdir</code>
to open the Working Directory.</p>

111
help/help-livestreamer.html
View File

@ -10,7 +10,7 @@
<a href="#settings">Settings</a> |
<a href="#troubleshooting">Troubleshooting</a>
</p>
<p><a href="http://livestreamer.readthedocs.org/en/latest/">Livestreamer</a>
<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>
@ -35,52 +35,83 @@
<h2><a name="settings">Settings</a></h2>
<p>The settings can be changed in the Livestreamer dialog.</p>
<ul>
<li><strong>Enable context menu entry</strong>: Adds Livestreamer to all
context menus that can be used to open streams (like User Context Menu,
Channel Context Menu or Live Streams Context Menu).</li>
<li><strong>Show dialog when opening stream</strong>: Automatically open
the Livestreamer Dialog when you open a stream out of the context menu.</li>
<li><strong>Context menu qualities</strong>: You can customize which
quality options appear in the context menu. The options you enter here
are directly given as a parameter to Livestreamer, except <code>Select</code>
which tells Chatty you want to select a quality in the dialog. Seperate
qualities by space or comma. Add a <code>|</code> (vertical bar) to add
a seperator to the menu.
<dl class="dl-settings">
<dt>Enable context menu entry</dt>
<dd>Adds a Livestreamer submenu to all context menus that can be used to
open streams (for example right-click on channel, username or Live
Streams dialog).</dd>
<br /><br />
Examples:
<dt>Show dialog when opening stream</dt>
<dd>Auto-opens the Livestreamer Dialog when you open a stream out of a
context menu.</dd>
<dt>Context menu qualities</dt>
<dd>You can customize which quality options appear in the context menu.
The options you enter here are directly given as a parameter to
Livestreamer, except <code>Select</code> which tells Chatty you want
to select a quality in the dialog.</dd>
<dd>Separate qualities by space or comma, add a <code>|</code> (vertical
bar) to add a separator to the menu.</dd>
<dd><em>Examples:</em>
<ul>
<li><code>Best, High, Worst | Select</code></li>
<li><code>Source High Medium Low Mobile | Select</code></li>
</ul>
</li>
<li><strong>Base command or commandline options</strong>: This is used to
construct the command to run Livestreamer and is basicially the part
before the URL and the quality. This should point to the Livestreamer
program itself, including any commandline options you always want to have included. The default is just <code>livestreamer</code>, which
should usually be sufficient if the program is correctly included in
the systems PATH variable (or similiar), but it may also include the
full path to Livestreamer. Surround the path or any other parameter with quotes if it contains
spaces (e.g. <code>"C:\My Programs\Livestreamer\livestreamer.exe"</code>).
<br /><br />
Examples:
<ul>
<li><code>"C:\My Programs\Livestreamer\livestreamer.exe" --player "C:\Program
Files\MPC-HC\mpc-hc64.exe"</code> (specify full path to Livestreamer
and use a different player)</li>
<li><code>/usr/local/bin/livestreamer</code> (this might work on Linux/Mac
if it can't find Livestreamer without the full path)</li>
</ul>
</dd>
</li>
<li><strong>Use Authorization (Twitch Oauth Token)</strong>: Supplies to
Twitch Access Token that is used for Chatty to Livestreamer to authenticate
you when watching a stream via Livestreamer (probably only necessary to
be able to watch sub-only streams).</li>
<dt>Base command (Livestreamer path and parameters)</dt>
<dd>This must contain the Livestreamer executable, including any
commandline options that you always want to be included when running
Livestreamer out of Chatty.</dd>
<dd>The URL and quality are automatically appended to this when running
Livestreamer, so the overall command that is executed is build like
this:
<code>&lt;Base&nbsp;command&gt; &lt;url&gt;&nbsp;&lt;quality&gt;</code>.</dd>
<dd>You can use the variables <code>$stream</code>, <code>$url</code>
and <code>$quality</code> in this setting (see Examples).</dd>
<dd>The default is just <code>livestreamer</code>, which is sufficient
if Livestreamer is correctly included in the systems PATH variable,
but you may also specify the full path.</dd>
<dd>Remember to surround the path or any parameters with quotes if they
contain spaces, so the commandline knows they belong together.</dd>
<dd><em>Examples:</em>
<ul class="example-list">
<li><code>"C:\My&nbsp;Programs\Livestreamer\livestreamer.exe"</code><br />
(specify full path to the Livestreamer executable)</li>
<li><code>"C:\My Programs\Livestreamer\livestreamer.exe" --player "C:\Program Files\MPC-HC\mpc-hc64.exe"</code><br />
(specify full path to Livestreamer and use a different player)</li>
<li><code>/usr/local/bin/livestreamer</code><br />
(this might work on Linux/Mac if it can't find Livestreamer
without the full path)</li>
<li><code>livestreamer -p "C:\Program Files (x86)\VideoLAN\VLC\vlc.exe --meta-title $stream/$quality"</code><br />
(change VLC Player window title to something more descriptive)</li>
</ul>
</dd>
<dt>Use Authorization (Twitch Oauth Token)</dt>
<dd>Tell Livestreamer to authenticate at Twitch with your Chatty access
token.</dd>
<dd>Enabling this may help if you get an error when running Livestreamer
(Bad Request).</dd>
<dd>This is necessary for sub-only streams.</dd>
</dl>
<h2><a name="troubleshooting">Troubleshooting</a></h2>
<h3>Bad Request</h3>
<p>Recently Twitch changed their API to require a Client ID being supplied,
which Livestreamer doesn't do by default, so may get a Bad Request
error. You can fix this either by:</p>
<ul>
<li>Enabling the <code>Use Authorization</code> setting to authenticate
with Twitch, which makes the Twitch API derive the Client ID from
the access token.</li>
<li>Adding a Client ID to the <code>Base command</code>, for eaxmple to
add Livestreamer's Client ID:<br />
<code>livestreamer --http-header Client-ID=ewvlchtxgqq88ru9gmfp1gmyt6h2b93</code>
</li>
</ul>
<h3>Can't run Livestreamer</h3>
<p>If you get an error like <code>Error: java.io.IOException: Cannot run
program "&lt;...&gt;": CreateProcess error=2 [..]</code>, then
Chatty probably can't find Livestreamer on your system.</p>
@ -90,8 +121,8 @@
not come bundled with Chatty. If you are sure it is installed (and you maybe can
run it from the commandline just fine), you may have to tell Chatty the full
path to the Livestreamer executable for it to work by entering it in the
<code>Base command or commandline options</code> field. See the Settings section
above for examples and help on that.</p>
<code>Base command</code> field. See the Settings section above for examples
and help on that.</p>
</body>
</html>

73
help/help-releases.html
View File

@ -15,6 +15,7 @@
<h1><a name="top">Release Information</a></h1>
<p>
<a href="#0.8.4">0.8.4</a> |
<a href="#0.8.3">0.8.3</a> |
<a href="#0.8.2">0.8.2</a> |
<a href="#0.8.1">0.8.1</a> |
@ -41,7 +42,77 @@
full list of changes.</p>
<h2>
<a name="0.8.3">Version 0.8.3</a> <a name="latest">(This one!)</a> (2016-06-28)
<a name="0.8.4">Version 0.8.4</a> <a name="latest">(This one!)</a> (2016-10-23)
<a href="#top" class="top">[back to top]</a>
</h2>
<p>This update implements the new Badge system that Twitch introduced, which
is much more flexible and allows for all the new special Badges like
Bits, Prime or Loyalty Badges.</p>
<p>Weed out rogue mods with the new Mod Action Log. Twitch added a way for
mods to see what commands other mods have executed in the channel. In
Chatty you can view these mod actions in a separate window via
<code>Extra - Moderation&nbsp;Log</code> or enable them to appear as
additional messages directly in chat (<code>Main - Settings - Messages</code>).</p>
<pre>
### Emotes/Badges
- Added Emoji support (are shown in chat and can be favorited as Emotes)
- Added displaying of received Cheering emotes (sending Cheers is not possible)
- Added support for new Twitch Badge system (e.g. Bits Badge, Prime Badge)
- Updated Custom Usericon settings, added $badge: restriction, other stuff
- Allow Custom Usericons without an image, to hide the matching default badge
- Recognize users with Prime Badge as Turbo users for some stuff like status
smybol (+) or matching users
- Added Status Symbols: $ (Bits), + (Prime Turbo), ' (Addon), ? (Unknown)
(last two only being used in chat, when you copy&paste the message)
- Implemented proper FFZ Bots API
- Only show one set of emotes in Emote Dialog if user has both Prime and Turbo
### Settings
- Added setting whether to show the userlist by default
- Added setting to save Addressbook to file on change
- Livestreamer: Added some variables to base command ($stream, $url, $quality)
- Added Sound Output Device selection
### Commands
- Added "/ffz following" command
- Added /setsize command to set size of main window
- Added Hotkey action to close Chatty
### Moderation
- Added initial support for displaying mod actions (Broadcaster/Mods only)
- Added initial support for unofficial way of deleting single messages
- Added automatic showing of Chat Rules and menu entries to show manually
- Changed "More.." info in User Info Dialog to stay shown until clicked again
- Changed account age to show years and days
- Added User Info Dialog to window manager, so it can keep position
- Chatlog: Added account age to BAN messages, but only if info was loaded before
### Other
- Added support for Localized Names (you can configure how these are shown)
- Some changes to the build process
- Updated Context Menus:
- Removed entries for pages that Twitch removed (Twitch Profile, old Popout)
- Added some icons to some Context Menus, added some margin so mouse doesn't
hide entries
- Added Context Menu for badges, showing some info
- Added "Set color" and "Set name" User Context Menu entries
- Add Livestreams Dialog Context Menu entry to manually refresh streams
- Removed version from URL when opening Help website out of Chatty
### Bugfixes
- Fixed some dialogs not reopening even with the appropriate setting
- Fixed bug with empty Whisper TAB appearing
- Fixed reconnect delay off-by-one error
- Fixed Whisper notification typo/encoding
- Only send Content-Type header to Twitch API when sending data, which otherwise
may trip up the API
- Fixed ignoring of info messages not respecting the "Enable Ignore" setting
</pre>
<h2>
<a name="0.8.3">Version 0.8.3</a> (2016-06-28)
<a href="#top" class="top">[back to top]</a>
</h2>
<p>Twitch has added information on the length of timeouts, which Chatty will

391
help/help-settings.html
View File

@ -202,31 +202,18 @@
</dl>
</dd>
<dt>Show moderator actions in chat</dt>
<dd>Outputs extra messages for commands that moderators execute in the
channel, except for the commands you exexcute yourself.</dd>
<dd>This is only available for the broadcaster and moderators.</dd>
<dd>This is a Twitch Beta, so it may still change and break things.</dd>
<dd>To view mod actions you can also open a separate dialog via
<code>Extra - Moderation Log</code>.</dd>
</dl>
<h3><a name="capitalization">Name Capitalization</a></h3>
<p>Names in Twitch Chat are send all-lowercase by default, however there is
an IRCv3 tag send with each message with the display name which Chatty
can use to show correct capitalization. You have the following settings:</p>
<ul>
<li><strong>Capitalized Names (First Letter)</strong> simply makes the
first letter of names uppercase. This will be correct for many names,
but by far not for all (names might have capital letters in the middle
or be all-lowercase). You can enable this if you simply prefer it this
way.</li>
<li><strong>Correctly Capitalized Names</strong> uses the capitalization
send in the IRCv3 tag with each message and should be what the user
configured. In very rare cases the display nick may differ more than the
capitalization. This is enabled by default.</li>
</ul>
<p><em>The previous function that requested correctly capitalized names from the
Twitch API has been removed. This also means that the associated commands
(<code>/refreshCase</code>, <code>/setCase</code> and <code>/getCase</code>)
have been removed as well. If you want to customize the capitalization of someone else's
name locally, you can now use the <a href="help.html#customNames">Custom Names feature</a>.
The names in the userlist will not be correctly capitalized until Chatty has
received a message from that user during this session.</em></p>
<p>This has been moved to it's own <a href="#Names">settings page</a>.</p>
<h2>
<a name="Chat">Chat</a>
@ -282,27 +269,56 @@
<a href="#top" class="top">[back to menu]</a>
</h2>
<h3>General Settings</h3>
<ul>
<li><strong>Show emoticons</strong>: Shows emoticons as images instead
of just the text</li>
<li><strong>Enable BetterTTV Emotes</strong>: Shows some of the BetterTTV emotes.
<em>Requires a restart to take effect when you change it.</em></li>
<li><strong>Enable FrankerFaceZ (FFZ)</strong>: Downloads <a href="help.html#emoticons">FrankerFaceZ</a>
emotes and Mod Icons (where available). <em>Requires a restart to take
effect when you change it.</em></li>
<li><strong>Enable FFZ Mod Icon</strong>: Show the FFZ Mod Icon instead of the regular
Mod Icon (where available). <em>Requires FrankerFaceZ setting to be enabled.</em></li>
<li><strong>Enable FFZ Featured Emotes</strong>: Show special FFZ emotes
available in some channels (mainly Speedrunning Events). To receive
these emotes Chatty maintains a connection to the FFZ Socket Server.</li>
<li><strong>Allow animated emotes</strong>: Show animated emotes (BTTV GIF emotes).</li>
<li><strong>Scale</strong>: The relative size of how emotes are displayed in chat (100% is regular size).</li>
<li><strong>Maximum Height</strong>: The maximum height of emotes in chat (in pixels). Use 0 to allow any height.</li>
<li><strong>Emotes Dialog</strong>: The relative size of how emotes are displayed in the Emotes Dialog (100% is regular size).</li>
<li><strong>Double-click on emote closes Emote Dialog</strong>: If
enabled, double-clicking on an emote in the Emote Dialog closes the
Emote Dialog.</li>
</ul>
<dl class="dl-settings">
<dt>Show emoticons</dt>
<dd>Turns emoticon codes into images. This needs to be enabled for any
emotes to show up.</dd>
<dt>Enable BetterTTV Emotes</dt>
<dd>Shows BetterTTV emotes (Personal Emotes not supported at this time).</dd>
<dt>Enable FrankerFaceZ (FFZ)</dt>
<dd>Downloads <a href="help.html#emoticons">FrankerFaceZ</a> emotes and
Mod Icons (where available).</dd>
<dd><em>Requires a restart to take full effect when you change it.</em></dd>
<dt>Enable FFZ Mod Icon</dt>
<dd>Show the FFZ Mod Icon in place of the default Mod Icon (where available).</dd>
<dt>Enable FFZ Featured Emotes</dt>
<dd>Show special FFZ emotes available in some channels (mainly
Speedrunning Events). To receive these emotes Chatty maintains a
connection to the FFZ Socket Server.</dd>
<dt>Allow animated emotes</dt>
<dd>Show animated emotes (BTTV GIF emotes).</dd>
<dt>Scale</dt>
<dd>The relative size of how emotes are displayed in chat (100% is regular size).</dd>
<dt>Maximum Height</dt>
<dd>The maximum height of emotes in chat (in pixels). Use 0 to allow any height.</dd>
<dt>Emotes Dialog</dt>
<dd>The relative size of how emotes are displayed in the Emotes Dialog (100% is regular size).</dd>
<dt>Double-click on emote closes Emote Dialog</dt>
<dd>If enabled, double-clicking on an emote in the Emote Dialog closes
the Emote Dialog.</dd>
<dt>Emoji Set</dt>
<dd>Turns Emoji characters into images. You can choose between different
sets of Emoji images, or choose <code>None</code> to turn off Emoji
images altogether.</dd>
<dt>Cheers (Bits)</dt>
<dd>You can choose whether to show <a href="https://help.twitch.tv/customer/portal/articles/2449458">Cheering</a>
emotes in chat animated, as static images (like other emotes) or
not at all (so they'll just show up as text).</dd>
<dd>Showing Cheering Badges and sending Cheers is not supported at this
point.</dd>
</dl>
<h3>Ignored Emotes</h3>
<p>Emotes added to this list will not be turned into an image, but instead
@ -337,21 +353,43 @@
</ul>
<h3>Custom Usericons</h3>
<p>By adding entries to the table you can either replace the default icons (Mod, Turbo, Subscriber, ..)
or add additional icons for certain users or addressbook categories. The order
of the entries can matter, they are matched from the top, so if more than one
icon matches that is supposed to replace a default icon, then the first one
is used. If more than one <code>Addon</code> icon matches, then all are used
(unless you use the <code>$stop</code> restriction, see section <em>Restriction</em> below).</p>
<p>Add entries to the table to show additional icons (<code>Addon</code>-Type)
or replace the default icons (all other Types).</p>
<p>The order of the entries can matter, they are looked at from the top:</p>
<ul>
<li>All <code>Addon</code> icons that match are shown, unless you use
the <code>$stop</code> restriction (see section <em>Restriction</em>
below).</li>
<li>When replacing default icons (all other Types), the first entry that
matches is used. For example if you have several entries for
replacing the Turbo badge, then the first one from the top that
matches is used.</li>
</ul>
<p>You have the following options when you add/edit an item:</p>
<dl class="paragraphs">
<h3>Custom Usericon Properties</h3>
<dl class="dl-settings">
<dt>Type</dt>
<dd>The type determines whether a default icon will be replaced
(if you choose <code>Moderator, Subscriber, Turbo, ..</code>) or if
it should be an additional icon added after the default ones (<code>Addon</code>).
Currently, you can have as many Addon-Icons as you want and they are
all displayed at once (if they match the requirements of course).</dd>
<dd>A type of <code>Addon</code> will add an additional badge. All
Addon-badges that matche the Restrictions are shown at once.</dd>
<dd>Other types replace an already shown default badge. For example
adding an entry of Type <code>Turbo</code> allows you to define a
custom icon for all Turbo badges shown in chat.</dd>
<dd>The Type <code>Other Twitch</code> allows you to directly select a
default icon via Twitch's own Badge ID/Version, which allows you to
target badges that are not a supported Type.</dd>
<dt>ID/Version</dt>
<dd>You can only use this when you have the <code>Other Twitch</code>
Type selected. This specifies the Badge ID/Version that Twitch uses
to identify Badges, which gives you a bit more flexibilities on what
badges you match.</dd>
<dd>For example if you wanted to replace the 100-Bits Badge, you'd want
to use <code>bits/100</code>. If you don't specify a Version, for
example just <code>bits</code>, then it matches all versions, in
this case it would match all Bits Badges.</dd>
<dd>If you are already connected to a channel, it should automatically
populate the list with known ID/Version combinations. Note that some
of these may only be used in some channels.</dd>
<dt>Restriction</dt>
<dd>This is similiar to the <a href="#Usercolors">Usercolors</a> settings,
@ -365,8 +403,7 @@
implicit restriction, since e.g. the default moderator icons are only
displayed if the user is a moderator.</dd>
<dd>Normally you can only specify <em>one</em> restriction, but you can
also add <strong>special restrictions</strong> for <code>Addon</code>
icons:
also add <strong>special restrictions</strong>:
<ul>
<li><code>$stop</code> means if this icon matches (and is thus used),
it stops searching for further <code>Addon</code> icons. So
@ -377,33 +414,45 @@
the regular icons. The <code>$stop</code> restriction only
applies to one group of <code>Addon</code> icons separately
(before or after the regular icons).</li>
<li><code>$badge:&lt;ID/Version&gt;</code> matches a Twitch
Badge a user has. For example <code>$badge:bits/100</code>
will only target users that currently have the 100-Bits
Badge</li>
</ul>
</dd>
<dd>Examples: <code>$cat:streamer $first</code>, <code>lotsofs</code></dd>
<dd><em>Example:</em> <code>$cat:streamer $first</code> - Matches users
in the Addressbook category <code>streamer</code> and puts the badge
in front of the default ones.</dd>
<dd><em>Example:</em> <code>lotsofs</code> - Matches a user by the name
<code>lotsofs</code>.</dd>
<dd><em>Example:</em> <code>$cat:vip $badge:bits</code> - Matches users
in the Addresbook category <code>vip</code>, but only if they also
have a Bits-Badge displayed.</dd>
<dt>Channel</dt>
<dd>This is another requirement that also has to be met in order for the
icon to be displayed. You can entere a channel name here, so that the
icon will only be displayed in that channel. You can add an exclamation
mark in front of the channel name (like <code>!#channel</code>) to have
it displayed in all channels except the one you specified. If you keep
this empty, then it will be displayed in all channels.</dd>
<dd>You can enter a channel name here, so that the icon will only be
displayed in that channel. You can add an exclamation mark in front
of the channel name (like <code>!#channel</code>) to have it
displayed in all channels <em>except</em> the one you specified.</dd>
<dd>If you keep this empty, then it will be displayed in all channels.</dd>
<dt>Image File</dt>
<dd>The image file to use for the icon. Must be a <code>.png</code> and
should usually be about 18x18 pixels (because that is the size of the
default icons). The image files are looked for in the <code>/img</code>
subfolder of the working directory (similiar to the <code>/sounds</code>
folder). You can click on <code>Image Folder</code> to show information
about it and rescan it to update the list of images in the dropdown menu.</dd>
<dd>You can add the special Image File name <code>$ffz</code> which will
make it use a FrankerFaceZ icon for that, if available (this only really
applies if you use the <em>Type</em> <code>Moderator</code> and want to
replace the moderator icon in all channels execept the ones that have a
FFZ Mod Icon).</dd>
<dd>You should also be able to specify the full path to an image, if you
don't want to use the dedicated image folder. A filename starting with
<code>http</code> is interpreted as URL.</dd>
<dd>The image to use. Must be a <code>.png</code> and is recommended to
be about 18x18 pixels (because that is the default size). If you
specify no image, then the matching default icon is removed.</dd>
<dd>Chatty lookes for images in <code>&lt;working_directory&gt;/img/</code>
(<a href="help-guide_folders.html#wdir">Chatty directories help</a>).
You can click on <code>Image Folder</code> to show information about
it and rescan to update the list.</dd>
<dd>The <em>special image file name</em> <code>$default</code> will use
the default image file, that would be shown without defining
Custom Usericons. This can be useful if you e.g. want to replace all
Badge Types, except for one, so you can define that one to use the
default.</dd>
<dd><em>Tip:</em> You should also be able to manually enter the full
path to an image, in case you don't want to use the dedicated image
folder. A filename starting with <code>http</code> is interpreted as
URL.</dd>
</dl>
<p><em>Tip:</em> Jump to entries in the table by clicking into a column and
@ -448,6 +497,51 @@
also happen if it doesn't recognize the given color or the item is just in
an invalid format.</p>
<h2>
<a name="Names">Names</a>
<a href="#top" class="top">[back to menu]</a>
</h2>
<h3>Names / Localized Names</h3>
<p>Users can customize the capitalization of their name, or set a localized
name for some locales, like Japanese.</p>
<p><strong>Chat</strong> messages and the <strong>Userlist</strong> can be
configured separately with the following options:</p>
<dl class="dl-settings">
<dt>Username Only</dt>
<dd>Always show the non-capitalized username for all users.</dd>
<dt>Capitalized Only</dt>
<dd>Show the capitalized name, if available (but never localized names).</dd>
<dt>Localized Only</dt>
<dd>Show the localized name, if set by the user, or the capitalized name
otherwise.</dd>
<dt>Localized+Username</dt>
<dd>If the user has a localized name set, show both the localized
name and the original username in parentheses, or the capitalized
name otherwise.</dd>
</dl>
<p>If you have a <a href="help.html#customNames">Custom Name</a> set for a
user, then only that Custom Name will be shown.</p>
<p>Other related settings:</p>
<dl class="dl-settings">
<dt>Capitalize First Letter if no display name available</dt>
<dd>If there is no capitalized/localized name for a user available then
capitalize the first letter. This especially applies to names in the
userlist of people who haven't said anything in chat yet.</dd>
</dl>
<h3>Custom Names</h3>
<div class="moreInfo">More information: <a href="help.html#customNames">Custom Names</a></div>
<h2>
<a name="Highlight">Highlight</a>
<a href="#top" class="top">[back to menu]</a>
@ -719,6 +813,10 @@
make the files show up in the list. You can open the folder in your standard
file browser from here to add files to it more quickly.</p>
<p>The <strong>Output Device</strong> lets you choose the device on your
computer the sounds gets output to. This is kind of experimental and may
not work properly.</p>
<h3>Sound Types Settings</h3>
<p>You can specify requirements, soundfile, volume and delay for
different types of events:</p>
@ -875,6 +973,10 @@
any processing, except being formatted depending on the current
locale.</dd>
<dd><code>VIEWERS: 12,521</code></dd>
<dt>Mod Actions</dt>
<dd>Logs the commands performed by mods in your channel (Broadcaster/Mods only).</dd>
<dd><code>MOD_ACTION: tduva (host coollertmb)</code></dd>
</dl>
<h2>
@ -933,7 +1035,10 @@
userlist in pixels.</li>
<li><strong>Min. Width</strong>: The minimum width of the userlist in
pixels.</li>
<li><strong>Enable userlist by default</strong>: Show the userlist by
default. When you disable this the userlist will be entirely hidden
from the start. You can always use a shortcut (<kbd>Shift+F10</kbd>
by default) to toggle the userlist per channel.</li>
</ul>
<h3>Popout</h3>
@ -1324,64 +1429,92 @@
use TAB Completion <a href="help.html#nickCompletion">check out the general help</a>.</p>
<h3>TAB Completion</h3>
<ul>
<li><strong>Show popup:</strong>
If enabled, shows a small window with information about the
current completion if there is more than one matching result.
It shows at which result of how many you are when cycling
through results as well as a limited overview of which results
there actually are.</li>
<li><strong>Max Items Shown:</strong> How many items
(e.g. names that match what you entered) to show
in the popup at once. You can set this to 0 to not show any
items.</li>
<li><strong>Complete to common prefix</strong>:
Pressing TAB only completes up to the common prefix for
all found matches, giving you the opportunity to add
more characters and then press TAB again to refine the
results or just press TAB again to start cycling through
the results.
<br /><br />
With this
setting disabled, it immediately completes the first found
result, allowing you to directly cycle through by pressing TAB repeatedly.</li>
<li><strong>Sorting:</strong> Changes how the matching usernames
are sorted for completion (only applies to usernames,
not for other stuff like emotes or setting names which
are always alphabetical).
<ul>
<li>Predictive: Gives names of users that were recently
active in chat higher priority, with users who send
a message that was highlighted the highest. This way
people you talk to probably appear under the first
few results.</li>
<li>Alphabetical: Sort names alphabetical.</li>
<li>Userlist: Sort names the same as in the userlist.</li>
</ul></li>
</ul>
<dl class="dl-settings">
<dt>Show popup</dt>
<dd>Shows a small window with information about the current completion
if there is more than one matching result. It shows your position in
the results when cycling through them (and how many there are in
total) as well as a limited list of results.</dd>
<dt>Max Items Shown</dt>
<dd>How many items (results) are shown in the popup at once.</dd>
<dd>You can set this to 0 to not show any items (and thus only your
position in the results when cycling through and how many results
there are in total).</dd>
<dt>Complete to common prefix</dt>
<dd>Pressing <kbd>TAB</kbd> only completes up to the common prefix for
all found matches, giving you the opportunity to refine your search
by adding more characters and then pressing <kbd>TAB</kbd> again, or
just press TAB again to start cycling through the results.</dd>
<dd>With this setting disabled, it immediately completes to the first
found result, allowing you to directly cycle through by pressing
<kbd>TAB</kbd> repeatedly.</dd>
<dt>Sorting</dt>
<dd>Changes how the matching usernames are sorted for completion (only
applies to usernames, not to other stuff like emotes or setting
names, which are always alphabetical).</dd>
<dd>
<dl class="dl-settings-sub">
<dt>Predictive</dt>
<dd>Gives users that were recently active in chat a higher
priority, and users with highlighted messages the highest.
This way people you currently talk to (or that mentioned
you) probably appear under the first few results.</dd>
<dt>Alphabetical</dt>
<dd>Sorts names alphabetical.</dd>
<dt>Userlist</dt>
<dd>Sorts names the same as in the userlist.</dd>
</dl>
</dd>
<dt>Include all name types in result</dt>
<dd>If a user has a Localized name, or you have a
<a href="help.html#customNames">Custom name</a> set, then not only
the name that matched, but also the other types of names are added
to the result.</dd>
<dd><em>Example:</em> If a user is called <code>test</code> and has the
Localized Name <code>名前</code>, then entering
<code>tes</code> and <kbd>TAB</kbd> will show in the results both
<code>test (名前)</code> and
<code>名前 (test)</code>, so you can select either name by cycling
through the results via <kbd>TAB</kbd> as usual.</dd>
<dd>
<dl class="dl-settings-sub">
<dt>Only when no more than two matches</dt>
<dd>Only include all name types when no more than two names
match, so that you don't have to cycle through all the
different name types when you have a larger list.</dd>
<dd><em>Tip:</em> Once you found the right name, you can move the cursor
to leave completion, and then press <kbd>TAB</kbd> again to
complete the name again to get the other name types again.</dd>
</dl>
</dd>
</dl>
<h3><a name="Completion-custom">Custom Completion Items</a></h3>
<p>Custom Completion allows you to add terms and their completion,
allowing you to not only complete names in chat (<kbd>TAB</kbd>) or emotes
(<kbd>Shift-TAB</kbd>) but also custom stuff you added to the list by prepending the term with a
point and using <kbd>Shift-TAB</kbd>.</p>
<p>Example: Add <code>chatty</code> as <em>Key</em> and
<code>http://chatty.github.io</code> as <em>Value</em>
and then in the inputbox type <code>.chatty</code> (notice the dot in front) and press
<p>Custom Completion allows you to add user-specified keywords, that if
prepended with a dot (<code>.</code>) can be completed to their defined
value using <kbd>Shift-TAB</kbd>.</p>
<p><em>Example:</em> Add <code>chatty</code> as <em>Key</em> and
<code>http://chatty.github.io</code> as <em>Value</em> and then in the
inputbox type <code>.chatty</code> (notice the dot in front) and press
<kbd>Shift-TAB</kbd> to complete it to the URL.</p>
<p>Custom Completion items can only have one completion, so you
can't have <code>.chatty</code> complete to several things
as it could be the case with a nickname.</p>
<p>Custom Completion items can only have one completion, so you can't have
<code>.chatty</code> complete to several different values.</p>
<p>Besides the Settings Dialog, you can also use the
<code>/customCompletion</code> command to modify custom
completion items:</p>
<p>Besides the Settings Dialog, you can also use the <code>/customCompletion</code>
command to modify custom completion items:</p>
<ul>
<li><code>/customCompletion add &lt;item&gt; &lt;value&gt;</code> - Add an item</li>
<li><code>/customCompletion set &lt;item&gt; &lt;value&gt;</code> - Change an item that already exists</li>
<li><code>/customCompletion set &lt;item&gt; &lt;value&gt;</code> - Change an item if it already exists (or otherwise add it)</li>
<li><code>/customCompletion remove &lt;item&gt;</code> - Remove an item</li>
</ul>

7
help/help-troubleshooting.html
View File

@ -219,9 +219,10 @@
<code>Chatty.jar</code> is located
<ul>
<li>Windows: In the File Explorer, while holding <kbd>Shift</kbd>
Right-Click into the folder where the
<code>Chatty.jar</code> is located. Click on <code>Open
command window here</code> in the context menu.</li>
Right-Click on an empty space (without a file selected) of
the folder where the <code>Chatty.jar</code> is located.
Click on <code>Open command window here</code> in the
context menu.</li>
</ul>
</li>
<li>In the commandline window, enter <code>java -jar Chatty.jar</code>

130
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.8.3)</a></h1>
<h1><a name="top">Chatty (Version: 0.8.4)</a></h1>
<table>
<tr>
<td valign="top">
@ -19,7 +19,7 @@
<strong>Chat basics</strong>
<ul class="menu">
<li><a href="#symbols">Symbols used in chat</a></li>
<li><a href="#symbols">User Status Symbols</a></li>
<li><a href="#userlist">Userlist</a></li>
<li><a href="#favorites">Favorites / History</a></li>
<li><a href="help-whisper.html">Whisper Feature</a></li>
@ -121,7 +121,8 @@
<a name="shortcuts">Shortcuts</a>
<a href="#top" class="top">[back to menu]</a>
</h2>
<p>You can customize some shortcuts/hotkeys in the settings.</p>
<p><em>You can customize most of these shortcuts in the settings, and also
add shortcuts for some functions not listed here.</em></p>
<p>Default shortcuts which can't be changed:</p>
<ul>
<li><kbd>F1</kbd> - Open help</li>
@ -154,6 +155,9 @@
work properly (you don't enter the surrounding <code>&lt; &gt;</code>,
they are just there to show it's a parameter). Equivalently <code>[parameter]</code>
represents an optional parameter.</p>
<p><em>Tip:</em> You can also use TAB Completion for many commands.</p>
<p>Chat commands:</p>
<ul>
<li><code>/me &lt;message&gt;</code> - Send an action message (* nickname says something) to the channel</li>
@ -380,21 +384,66 @@
</ul>
<h2>
<a name="symbols">Symbols used in chat</a>
<a name="symbols">User Status Symbols</a>
<a href="#top" class="top">[back to menu]</a>
</h2>
<p>There are a few special symbols that are used for users in chat. These
are displayed in the userlist and - if usericons are disabled - also in chat.</p>
<ul style="list-style-type: none;">
<li>~ The Streamer</li>
<li>@ Moderators</li>
<li>* Global Moderators</li>
<li>! Admins</li>
<li>&amp; Staff</li>
<li>+ Turbo users</li>
<li>% Subscribers</li>
<li>^ Bots as recognized by local setting, FFZ API and BTTV API</li>
</ul>
are displayed in the userlist and - if usericons are disabled - also in chat:</p>
<table class="compact" style="border-collapse: collapse;">
<tr>
<td class="symbol">~</td>
<td>The Broadcaster</td>
</tr>
<tr>
<td class="symbol">@</td>
<td>Moderator</td>
</tr>
<tr>
<td class="symbol">+</td>
<td>Turbo/Prime</td>
</tr>
<tr>
<td class="symbol">%</td>
<td>Subscriber</td>
</tr>
<tr>
<td class="symbol">$</td>
<td>Donated Bits</td>
</tr>
<tr>
<td class="symbol">^</td>
<td>Bot (as recognized by <a href="help-setting_commands.html#bots">local setting</a>, FFZ API and BTTV API)</td>
</tr>
<tr>
<td class="symbol">*</td>
<td>Global Moderator</td>
</tr>
<tr>
<td class="symbol">!</td>
<td>Admin</td>
</tr>
<tr>
<td class="symbol">&amp;</td>
<td>Staff</td>
</tr>
</table>
<p>When you copy&amp;paste a message from chat that contains Badges, you may
also encounter the following symbols:</p>
<table class="compact" style="border-collapse: collapse;">
<tr>
<td class="symbol">'</td>
<td>Addon Usericon</td>
</tr>
<tr>
<td class="symbol">?</td>
<td>Unknown Badge (for example special Twitch Badges that may only
be available for some time or in some channels)</td>
</tr>
</table>
<p><a href="http://frankerfacez.com">FrankerFaceZ</a> provides a custom
mod icon for some channels. You can disable this in the settings if you
want to keep the default one for all channels.</p>
@ -451,14 +500,21 @@
</h2>
<p>When you type in the inputbox, you can TAB-complete different types of
things:</p>
<ul>
<li>Nicknames of who is currently in the userlist (using <kbd>TAB</kbd>)</li>
<li>Chatty setting names when you use a setting command (using <kbd>TAB</kbd>)</li>
<li>Some comands after <code>/</code> (using <kbd>TAB</kbd>, e.g. <code>/sub</code> then <kbd>TAB</kbd> to complete to <code>/subscribers</code>)</li>
<li>Emoticon names (using <kbd>Shift-TAB</kbd>, e.g. <code>Datsh</code> then <kbd>Shift-TAB</kbd> to complete to <code>DatSheffy</code>)</li>
<li><a href="help-settings.html#Completion-custom">Custom completion</a>
that is prepended with a dot and for which items can be added in the
settings (using <kbd>Shift-TAB</kbd>)</li>
<li>Using <kbd>TAB</kbd>
<ul>
<li>Names of who is currently in the userlist</li>
<li>Chatty setting names (after a setting command)</li>
<li>Some commands (after <code>/</code>)</li>
</ul>
</li>
<li>Using <kbd>Shift-TAB</kbd>
<ul>
<li>Emoticons</li>
<li><a href="help-settings.html#Completion-custom">Custom completion</a></li>
</ul>
</li>
</ul>
<h3>How it works</h3>
@ -469,7 +525,7 @@
<ol>
<li>Enter the beginning of an item (name, setting, emote).</li>
<li>Press <kbd>TAB</kbd> for a nickname/setting/command or <kbd>Shift-TAB</kbd>
<li>Press <kbd>TAB</kbd> or <kbd>Shift-TAB</kbd> (see above)
to enter the completion mode, which will:
<ul>
<li>Complete to the full item (e.g. full name) if there is only
@ -874,21 +930,29 @@ MiniK http://static-cdn.jtvnw.net/emoticons/v1/25/1.0 set:793 id:3287</pre
</ul>
<h2>
<a name="customNames">Custom Usernames</a>
<a name="customNames">Custom Names</a>
<a href="#top" class="top">[back to menu]</a>
</h2>
<p>You can give people in chat custom names that will appear in chat and
in the userlist instead of the regular Twitch username and in the User Info
Dialog in addition to the regular Twitch username. In other places (like
the User Context Menu or auto-completion) the regular Twitch username is
used.</p>
the User Context Menu) the regular Twitch username is used.</p>
<p>TAB Completion also allows you to complete Custom Names and by default
also includes the original name in the results.</p>
<p>The following commands are used to set custom names:</p>
<ul>
<li><code>/setname &lt;name&gt; &lt;custom name&gt;</code> - to set a custom name</li>
<li><code>/resetname &lt;name&gt;</code> - to remove a custom name</li>
<li><code>/setname &lt;username&gt; &lt;custom name&gt;</code> - to set a custom name</li>
<li><code>/resetname &lt;username&gt;</code> - to remove a custom name</li>
</ul>
<p>In addition to these commands, you can also view and change Custom Names
via the Settings GUI under <code>Names</code>. You can also right-click
on a user in chat to open the User Context Menu and choose
<code>Miscellaneous - Set name</code> to open the Settings with the name
preset.</p>
<h2>
<a name="pausechat">Pause Chat / One-click moderation</a>
<a href="#top" class="top">[back to menu]</a>
@ -1355,6 +1419,16 @@ MiniK http://static-cdn.jtvnw.net/emoticons/v1/25/1.0 set:793 id:3287</pre
<li>Edit Icon (Pencil Image), Ok Icon (Green Arrow), Invalid Icon (Cross) from <a href="http://www.icon-king.com/projects/nuvola/">NUVOLA ICON THEME</a> for KDE 3.x by David Vignoni
under <a href="http://www.gnu.org/licenses/lgpl.html">LGPL</a>.</li>
<li>Robot Icon by <a href="http://p.yusukekamiyamane.com">Yusuke Kamiyamane</a> under <a href="http://creativecommons.org/licenses/by/3.0/">CC-BY 3.0</a>.</li>
<li>Emoji:
<ul>
<li>Emoji info (description, category) based on <a href="https://github.com/Ranks/emojione/blob/master/emoji.json">emoji.json by EmojiOne</a>
under the <a href="https://opensource.org/licenses/MIT">MIT License</a></li>
<li><a href="http://emojione.com/">EmojiOne</a> images licensed under
<a href="https://creativecommons.org/licenses/by/4.0/">Creative Commons Attribution 4.0 International</a></li>
<li><a href="https://github.com/twitter/twemoji">Twitter Emoji (Twemoji)</a> images licensed under
<a href="https://creativecommons.org/licenses/by/4.0/">CC-BY 4.0</a></li>
</ul>
</li>
</ul>
<p>This application (except for the parts mentioned in the previous paragraph)

21
help/style.css
View File

@ -151,3 +151,24 @@ table.files {
.del {
text-decoration: line-through;
}
.example-list li {
margin-top: 4px;
}
table.compact {
border-collapse: collapse;
margin-top: 10px;
margin-left: 20px;
}
table.compact td {
padding: 3px;
margin: 0;
border: 0;
}
td.symbol {
font-size: 1.1em;
text-align: center;
}

10
index.html
View File

@ -15,7 +15,7 @@ function loaded() {
{ ceiling: null, text: "$years years ago" }
]
}
document.getElementById("ago").innerHTML = "Version 0.8.3 released "+humanized_time_span("2016/06/28", Date(), custom_date_formats)+"";
document.getElementById("ago").innerHTML = "Version 0.8.4 released "+humanized_time_span("2016/10/23", Date(), custom_date_formats)+"";
getDownloads("v0.8.3");
}
@ -174,7 +174,7 @@ function getDownloads(tag) {
<li>Get notified when channels you follow go live and view a list of live streams</li>
<li>Follow and unfollow channels directly out of Chatty</li>
<li>View and insert your subemotes, channel-specific emotes, all global emotes and Twitch emotes you favorited</li>
<li>Easily open streams in your browser, or run <a href="http://livestreamer.tanuki.se/en/latest/">Livestreamer</a> out of Chatty</li>
<li>Easily open streams in your browser, or run <a href="https://github.com/chrippa/livestreamer">Livestreamer</a> out of Chatty</li>
<li>Join several channels, popout individual channels to view them side-by-side</li>
</ul>
</li>
@ -216,12 +216,12 @@ function getDownloads(tag) {
<h2 id="download">Download & Getting started</h2>
<ul>
<li><a href="https://github.com/chatty/chatty/releases/download/v0.8.3/Chatty_0.8.3.zip"><strong>Download Version 0.8.3</strong></a>
<li><a href="https://github.com/chatty/chatty/releases/download/v0.8.4/Chatty_0.8.4.zip"><strong>Download Version 0.8.4</strong></a>
(all OS)</li>
<li>With global hotkey support (Windows only):<ul>
<li><a href="https://github.com/chatty/chatty/releases/download/v0.8.3/Chatty_0.8.3_hotkey_32bit.zip">Download Version 0.8.3 (for 32bit-Java)</a>
<li><a href="https://github.com/chatty/chatty/releases/download/v0.8.4/Chatty_0.8.4_hotkey_32bit.zip">Download Version 0.8.4 (for 32bit-Java)</a>
</li>
<li><a href="https://github.com/chatty/chatty/releases/download/v0.8.3/Chatty_0.8.3_hotkey_64bit.zip">Download Version 0.8.3 (for 64bit-Java)</a>
<li><a href="https://github.com/chatty/chatty/releases/download/v0.8.4/Chatty_0.8.4_hotkey_64bit.zip">Download Version 0.8.4 (for 64bit-Java)</a>
</li>
</ul></li>
</ul>

2
version.txt
View File

@ -1 +1 @@
0.8.3 Timeout lengths/reasons, new sub messages, and more..
0.8.4 New Badges, Mod Action Log, Bugfixes, and much more..