Chatty/chatty.github.io
1
0
Fork 0
mirror of https://github.com/chatty/chatty.github.io.git synced 2024-09-16 21:32:26 +02:00
Code Issues Projects Releases Wiki Activity

0.8.1 help

Browse Source
This commit is contained in:
tduva 2015-08-10 21:25:24 +02:00
parent de788683ed
commit 297ccb6769
36 changed files with 6800 additions and 301 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

BIN
help/0.8.1/0_4_overview_top.png Normal file
View File

Binary file not shown.
Side by Side

After

Width:  |  Height:  |  Size: 29 KiB

BIN
help/0.8.1/followers.jpg Normal file
View File

Binary file not shown.
Side by Side

After

Width:  |  Height:  |  Size: 25 KiB

156
help/0.8.1/help-addressbook.html Normal file
View File

@ -0,0 +1,156 @@
<!DOCTYPE html>
<html>
<title>Chatty - Addressbook</title>
<link rel="stylesheet" type="text/css" href="style.css" />
<body>
<div id="backlink"><a href="help.html">To main help page</a></div>
<h1><a name="top">Addressbook</a></h1>
<p>
<a href="#editing">Editing Locally</a> (<a href="#commands">Commands</a>) |
<a href="#advanced">Advanced Usage</a> (<a href="#modcommands">Mod Commands</a>, <a href="#file">Change via file</a>)
</p>
<p>The addressbook allows you to add usernames and assign categories to
them, which can then be used in other places such as the <a href="help-settings.html#Usercolors">Usercolor settings</a>
or the <a href="help-settings.html#Highlight">Highlight settings</a>.
Categories cannot contain spaces and are all made lowercase when added/loaded from file.</p>
<h2><a name="editing">Editing Locally</a></h2>
<p>The addressbook can be edited in several ways:</p>
<ul>
<li>The addressbook dialog (<code>&lt;Main Menu&gt; - Channels - Addressbook</code>)
where all entries are listed and you can add/edit/remove entries.</li>
<li>From the user context menu (when you click on a user, then <code>Addressbook</code>)
where the entry for this user can be directly added/edited/removed. There
you can just select/unselect the categories this user should be in
(although only the categories that are already used in the addressbook
are listed, so if you want to add a completely
new category, you have to add it once by manually editing an entry).</li>
<li>The commands that are listed below.</li>
</ul>
<h3><a name="commands">Commands</a></h3>
<p>In addition to the addressbook dialog and user context menu, there are also some commands to
edit the addressbook. All commands are prefixed with <code>/ab</code>
(e.g. <code>/ab add &lt;name&gt;</code>) or alternatively <code>/users</code> (e.g. <code>/users add &lt;name&gt;</code>):</p>
<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>
<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>
<li><code>remove &lt;name&gt; &lt;categories&gt;</code> - Removes the given categories from this name, but leaves
the name</li>
<li><code>change &lt;name&gt; &lt;categoriesModification&gt;</code> - Prepend categories with <code>+</code>,
<code>-</code> or <code>!</code> to add, remove or toggle the categories respectively. You can specify more than
one set of categories, for example: <code>change test +a,b -c !d</code> adds a and b, removes c and toggles d</li>
<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>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
of <code>currentName</code> are replaced with <code>newName</code> in all entries. This can also
be used to merge categories, if <code>newName</code> already exists.</li>
<li><code>removeCategory &lt;name&gt;</code> - Removes the category with the given name from all entries</li>
</ul>
<h3>Command Examples</h3>
<dl>
<dt><code>/ab add josh vip</code></dt>
<dd>Adds the category called <code>vip</code> to the user called <code>josh</code></dd>
<dd>(Also adds the user to the addressbook in the first place, if not already there)</dd>
<dd>(<code>josh</code>'s categories would now be: <code>vip</code>)</dd>
<dt><code>/ab set josh rainbow</code></dt>
<dd>Sets the categories of the user <code>josh</code> to <code>rainbow</code>, replacing
any previously associated categories</dd>
<dd>(<code>josh</code>'s categories would now be: <code>rainbow</code>)</dd>
<dd>(Also makes <code>josh</code> kind of colorful in chat, try it out with your own name Kappa)</dd>
<dt><code>/ab add josh vip</code></dt>
<dd>Adds the category called <code>vip</code> to the user <code>josh</code></dd>
<dd>(<code>josh</code>'s categories would now be: <code>rainbow,vip</code>)</dd>
<dt><code>/ab remove josh vip</code></dt>
<dd>Removes the category called <code>vip</code> from the user <code>josh</code>,
keeping the other categories untouched</dd>
<dd>(<code>josh</code>'s categories would now again be: <code>rainbow</code>)</dd>
</dl>
<h2><a name="advanced">Advanced Usage</a></h2>
<p>The following features are a bit more advanced and should only be used if
you somewhat know what you're doing.</p>
<h3><a name="modcommands">Moderator Commands</a></h3>
<p>You can use this to let the moderators of your channel edit your addressbook.
Depending on what commands you allow them to use, this can be a powerful tool,
so make sure you keep an eye on what your moderators do.</p>
<p>The following settings affect the this feature (you have to change them
via setting commands):</p>
<dl>
<dt><code>abCommandsChannel</code></dt>
<dd>Set this to the channel you want this enabled in. You can reset the
setting to empty using the <code>/clearSetting</code> command to
disable the mod commands again.</dd>
<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
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>
commands, the setting value would be <code>add,set</code> (no spaces).</dd>
<dd><code>/set abCommands add,set</code></dd>
<dd><em>Default value for this is <code>add,set,remove</code>.</em></dd>
</dl>
<p>If you set the settings accordingly, then the mods will be able to use
e.g. <code>!add name category</code> to add <code>name</code> to your
Addressbook with the category <code>category</code>. Chatty will output
a message about the change, similiar to when you enter the command yourself.
It does not send a message to chat, so if you want your moderators to see an
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="file">Change Addressbook via file</a></h3>
<p><em>This is a rather experimental feature, so it might not work reliably.</em></p>
<p>You can write Addressbook commands (one per line) to the <code>addressbookImport.txt</code>
file in the settings directory (enter <code>/dir</code> to find out what
your settings directory is). You can use any commands specified in the Commands section above, without
the <code>/ab</code> or <code>/users</code> prefix (since it's already
implied that they are Addressbook commands). For example:</p>
<pre>add darthclide level1
change nightbot !vip
set testi ignore</pre>
<p>To perform an import, enter the <code>/abImport</code> command and Chatty
will read the file and execute each command as if you would have entered
it in the input box. Information about the
command results is output in the debug window (<code>Extra - Debug window</code>)
and the debug log file.</p>
<p>You can also set the <code>abAutoImport</code> setting (<code>/set abAutoImport on</code>)
and the file will be read automatically within a few seconds when it is
detected to have been changed. You have to restart Chatty after changing
the <code>abAutoImport</code> value for it to take effect.
To make sure no data is lost, you should not
write to the file too often, or else it may already be overwritten once
changes are detected and the file contents are read and the commands performed.</p>
<p>It will also not be read automatically when you on start of Chatty,
so you should only apply changes while Chatty is running or
use the <code>/abImport</code> command to manually read the file once after
start. If you only change the file while Chatty is running, manually reading
the file should not be necessary.</p>
<p>Example: <a href="http://pastebin.com/LDFpEUaC">mIRC script</a> to edit the Addressbook.</p>
</body>
</html>

98
help/0.8.1/help-admin.html Normal file
View File

@ -0,0 +1,98 @@
<!DOCTYPE html>
<html>
<title>Chatty - Admin Dialog</title>
<link rel="stylesheet" type="text/css" href="style.css" />
<body>
<div id="backlink"><a href="help.html">To main help page</a></div>
<h1><a name="top">Admin Dialog</a></h1>
<p>
<a href="#status">Change game/title</a> |
<a href="#commercials">Run commercials</a>
</p>
<p><em>Open the Admin Dialog via <code>View - Channel Admin</code> or by
right-clicking on the channel to open the context menu and choose
<code>Channel Admin</code>.</em></p>
<p>In the Admin Dialog you can change the title/game of your channel and
run commercials, if you have allowed the necessary access when getting your
login data. You need <code>Editor access</code> for changing game/title and
<code>Commercial access</code> for running commercials. See <a href="help.html#access">allow more access</a>.</p>
<p>The Admin Dialog is always opened for the currently selected channel,
unless there is no channel open (which is the case just after you started Chatty),
in which case it will always be opened for your own channel, which is derived
from your configured account name.</p>
<h2><a name="status">Change game/title</a></h2>
<p>The Status-Tab lets you view and change the title and game of your channel.
The information is loaded when you open the dialog and when you press the
<code>reload</code>-Button. If others may have changed the info in the meantime,
you may want to reload before trying to change it.</p>
<h3>Select a game</h3>
<p>When you select a game, another dialog will open where you should enter
part of the name of the game in the search field and hit <kbd>Enter</kbd>
or click the <code>Search</code>-Button to find the correct name, which
you can then select. You can also just use the name you entered yourself,
but you should usually use the search to make sure your stream appears in
the correct category on Twitch.</p>
<h3>Use presets</h3>
<p>There are also status presets, which allow you to add a combination of
title and game, so you can select it later. By pressing <code>Fav</code>
on the Status-Tab, you can add the current status to the favorites.
The status is also automatically added to the history every time you
press the <code>Update</code> button.</p>
<p>Press the <code>Presets</code> button to open a table with the favorites
and status history. You can filter the table by only showing entries for
the game currently have selected or only showing favorites.</p>
<p>History entries (the ones that are not favorites) are automatically
removed after some time, you can change when they are removed and
whether they should be added in the first place in the settings.</p>
<p>The <code>Last Activity</code> columns shows when this status was last
set using the <code>Update</code> button (or when it was added to the
favorites for the first time). The <code>Usage</code> column shows how
often it was set using the <code>Update</code> button.</p>
<h2><a name="commercials">Run commercials</a></h2>
<p>If you are partnered with Twitch, you can run commercials on your channel
here (even if you are not partnered it may run a commercial). Click on the
appropriate button to try to run a commercial of the given length.</p>
<p>The <code>Last run</code> time shows when a commercial was last run
through Chatty (this session).</p>
<h3>Schedule commercials</h3>
<p>There are two different ways of scheduling a commercial, either running
a single commerical on a delay or repeating running a commercial on a delay.
Select either or both options and then press a <code>Run commercial</code>
button to schedule the commercial. Press the same button again to cancel the
scheduled commercial. Click a button of another length to change the length
of the commercial while keeping it on schedule. Scheduled commercials are
not completely exact, they may be run a few sceonds too late.</p>
<p>If you have <code>Use delay</code> selected, then the commercial will be
scheduled to run after the specified time. If you have <code>Repeat</code> selected,
then - after each commercial run through Chatty - another commercial will automatically be scheduled to run again with the same delay.
You don't need to have <code>Use delay</code> selected for <code>Repeat</code>
to work, they just both use the same time as delay.</p>
<p>The time for the delay will be interpreted as seconds by default, but you
can also specify minutes. Examples: <code>30</code> (30 seconds), <code>5m</code>
(5 minutes), <code>120s</code> (2 minutes).</p>
<h3>Run commercials via global hotkey</h3>
<p>If you have downloaded the appropriate version of Chatty (the one with
"hotkey" in the .zip filename, Windows only), you can define a global hotkey
to run 30s commercials on the channel you currently have open. The hotkey
can be defined on the <code>Commercials</code> tab in the Admin Dialog
(don't forget to press <code>Set</code> to actually set it).</p>
<p>If you have the Admin Dialog open on the <code>Commercials</code> tab,
then executing the hotkey will simulate a click on the 30s button, with all
the implications like being able to use a delay, running the commercial on
the channel that the Admin Dialog was opened on (instead of the currently
active channel) and so on.</p>
</body>
</html>

135
help/0.8.1/help-getting-started.html Normal file
View File

@ -0,0 +1,135 @@
<!DOCTYPE html>
<html>
<title>Chatty Help - Getting Started</title>
<link rel="stylesheet" type="text/css" href="style.css" />
<body>
<div id="backlink"><a href="help.html">Back to main help page</a></div>
<h1><a name="top">Getting Started</a></h1>
<p>This is a short guide to help you with installing Chatty and getting familiar with some of it's features.</p>
<h2>Download & Installation</h2>
<p>You can download Chatty from it's <a href="http://chatty.github.io/#download">Website</a>.
The download simply consists of a <code>.zip</code>-file which you should
extract wherever you want to have Chatty. The extracted files include a
<code>Chatty.jar</code> which you should usually be able to double-click to
start the program (if Java is installed properly). (See <a href="help-troubleshooting.html#start">the help</a>
if Chatty won't start.)</p>
<h3>Update Chatty</h3>
<p>If you already have an older version of Chatty and want to update, then
just replace all the files with the new ones in the <code>.zip</code>.
Basicially just unzip the <code>.zip</code> into the same folder and overwrite
all files if asked (unless you have some custom icons or sounds that have the same name).
You can also unzip it into a new folder (just make sure you don't use the old version anymore).</p>
<p>Your settings are saved seperately in the <a href="help-guide_folders.html">settings directory</a>
and are not lost when you upgrade to a new version. The new version should normally
automatically use the same settings without you needing to change anything.
If you are interested in what your settings directory is,
enter <code>/openDir</code> in Chatty. There is also a <code>backup</code>
folder in there with <a href="help-guide_folders.html#backup">backups</a> of the settings.</p>
<p>Please check out the <a href="help-releases.html">Release Information</a> for any changes in a new version that
may require your attention.</p>
<p><em>Note:</em> If you downgrade to an older version of Chatty, some settings (that the older
version didn't have yet) may be lost. So make sure you don't run old versions of Chatty
without knowing what you are doing, if you have changed settings unique to newer versions.</p>
<h2>Creating a login</h2>
<p>If you are starting Chatty for the first time, you will have to request
login data from Twitch so Chatty can connect to chat for you and do other
stuff like show live streams you follow.</p>
<p>In the <code>Connect</code>-dialog, click on <code>Create login..</code>
and then <code>Request login data</code> and simply follow the instructions.
Once you successfully created the login, close the dialog until you get back
to the <code>Connect</code>-dialog. (There is a <a href="help-guide2.html">Guide</a> on what to do
when getting login data fails.)</p>
<h2>Join channels (and leave channels)</h2>
<p>In the <code>Connect</code>-dialog enter the name of the channel you want
to join in the <code>Channel:</code> input box. The name of the channel
is the same as the name of the stream. You can enter more than one channel
name to join by seperating them with a comma. To connect simply press <kbd>Enter</kbd>
or click on <code>Connect</code>. After connecting, it will automatically join
the channels you specified.</p>
<p>Even after connecting you can join additional channels via <code>Channels - Join Channel</code>
or entering the command <code>/join &lt;channelname&gt;</code> in the inputbox
(e.g. <code>/join joshimuz</code>).</p>
<p>You can leave channels by right-clicking anywhere in the channel and
selecting <code>Close Channel</code> from the context menu or right-clicking
on the channel's tab (only available if there is more than one channel) and
selecting <code>Close</code> from the context menu.</p>
<h2>Chatting and Moderating</h2>
<p>Chatting is pretty straightfoward as you would expect from any chat program,
however the inputbox has a few useful features. Enter the beginning of a name
in chat and press <kbd>TAB</kbd> to <a href="help.html#nickCompletion">auto-complete</a> the name.
Press <kbd>Up-Arrow</kbd> key to go back to <a href="help.html#inputHistory">previous stuff you entered</a>.</p>
<p>To moderate a chat, you can of course use the regular moderations commands
like <code>/ban</code>, <code>/timeout</code> and so on, but a much more
convenient method is to click on the name of a user you want to ban/timeout,
which opens the <code>User</code>-dialog, containing several moderation
buttons as well as the recent messages of that user, so you can quickly check
if you are actually timing out the correct user.</p>
<p>Also check out the options to <a href="help.html#pausechat">pause chat</a>
and timing out users via <a href="help.html#userselection">shortcuts only</a>.</p>
<p><img src="userdialog.jpg" alt="User Dialog with moderation buttons" /></p>
<h2>Information about the current stream</h2>
<p>Chatty regulary requests information about the current stream, which is
displayed in the titlebar and the <code>Channel Info</code>-dialog.</p>
<p><img src="0_4_overview_top.png" alt="Chatty Title and Tabs" /></p>
<p>You can open the <code><a href="help.html#channelinfo">Channel Info</a></code> via the <code>View</code>-menu
or the channel context menu (right-click anywhere on the channel). The
<code>Channel Info</code> contains the current title/game but also a history
of the Viewercount and previous title/games (if you hover over points).</p>
<p><img src="viewerhistory_small.gif" alt="Chatty Channel Info Dialog" /></p>
<h2>Get notified about streams you follow that go live (and join them)</h2>
<p>Open the <code>Live Channels</code>-window via <code>Channels - Live Channels</code>
to open up a list of streams you follow that are currently live or streams
whose channel you have currently joined that are currently live.</p>
<p>(You need to have the <a href="help.html#login">required access</a> with your login data to see streams
you follow.)</p>
<p>You can enable/disable showing streams you follow in the <code>Settings - Notifications</code>.
There you can also configure what kind of Tray Notification you want to have
pop up for stream status changes or highlighted messages.</p>
<p>To join channels directly out of the <code>Live Channels</code>-dialog
right-click on a stream to open the context menu and then select <code>Join channel</code>
to join the channel for that stream and if you want also open the stream in
your browser or <a href="help-livestreamer.html">Livestreamer</a>.</p>
<h2>More stuff you might want to try out..</h2>
<ul>
<li><strong>Right-clicking</strong>, or whatever opens a context menu
in your OS. There are a lot of context menus in Chatty, e.g. for usernames
(as shown above), links, emoticons, anywhere else in the channel, tabs,
entries in favorites, the live streams dialog, the Channel Info dialog..</li>
<li><strong>Configure Chatty</strong> to your needs. Open the <code>Settings</code>
from the <code>Main</code>-menu to get all kinds of settings to adjust
Chatty to your preference. Please make use of the <code>Help</code> link
in the bottom left corner of the <code>Settings</code>-dialog to get
help on the current page of settings you have selected.</li>
<li><strong>Ask</strong> if you don't understand something. I tried to
make the help as comprehensive and easy to understand as possible, but
a lot of stuff is probably pretty confusing if you aren't as familiar with
the program as I am. So please ask about stuff and maybe also (if you can)
propose changes to the help that would make it easier to understand. There
are various ways to <a href="help.html#contact">contact</a> me.</li>
</ul>
</body>
</html>

55
help/0.8.1/help-guide1.html Normal file
View File

@ -0,0 +1,55 @@
<!DOCTYPE html>
<html>
<title>Chatty Help</title>
<link rel="stylesheet" type="text/css" href="style.css" />
<body>
<div id="backlink"><a href="help.html">Back to main help page</a></div>
<h1><a name="top">Guide: Run more than one instance of Chatty</a></h1>
<p>If you want to run Chatty more than once at the same time, you may need
to know how it saves it's settings. By default the settings are saved
in your user-directory in the subfolder <code>.chatty</code> (where it is
exactly is system-dependant, enter <code>/dir</code> in Chatty to show it's location). When you run the program, it loads the settings
and when you exit the program, it saves them, overwriting the file with
no regard to possible changes (to the file) that may have occured in the meantime.</p>
<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>
<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
location you specified as working directory.</p>
<p>This means you can easily run more than one instance on the same computer
with completely different settings, just by using that commandline parameter
and specifying different working directories (e.g. in Windows in the shortcut
settings).</p>
<p>See also: <a href="help-guide_create_shortcut.html">Create Shortcut</a>.</p>
<h2>Sharing login data</h2>
<p>When you want to run several instances with different settings, but want
to use the same account, you run into problems. Everytime you request login
data (token), the old login is invalidated, so you have to share the login data
you already have between different instances.</p>
<p>You can do this by simply copying the <code>login</code> settings file
which contains the login data. Make sure you closed the Chatty instance
you requested the login data with at least once, so it's actually saved
to the file.</p>
<p>You could also try to play around with <a href="https://en.wikipedia.org/wiki/Symbolic_link">symbolic links</a>
to point to a shared <code>login</code> file.</p>
<h2>Using Chatty on different computers</h2>
<p>If you want to run Chatty on different computers with the same account,
you run into the same problem as mentioned under <em>Sharing login data</em>:
You can't have more than one access token with the same account for the same
app at the same time.</p>
<p>To use Chatty on more than one computer with the same account, you'll
have to transfer the login data, either by copying the <code>login</code>
file or by entering the access token manually
(<code>/get token</code> displays the token,
<code>/changetoken &lt;token&gt;</code> changes it).</p>
</body>
</html>

111
help/0.8.1/help-guide2.html Normal file
View File

@ -0,0 +1,111 @@
<!DOCTYPE html>
<html>
<title>Chatty Help</title>
<link rel="stylesheet" type="text/css" href="style.css" />
<body>
<div id="backlink"><a href="help.html">Back to main help page</a></div>
<h1><a name="top">Guide: What to do when getting login fails</a></h1>
<p>Use this guide when the normal procedure of getting login data fails.</p>
<h2>Can't listen to port</h2>
<p>If you open the <code>Get login data</code> dialog and it says it can't
listen to the port, first check the following:</p>
<ul>
<li>Make sure no other instance of Chatty is running that may already
have taken the port.</li>
<li>Check if no other program may already be listening to that port.</li>
<li>If the problem persists, reboot your PC and then try again.</li>
</ul>
<p>If you can't fix this problem and there are no other error messages that
may indicate what is going wrong, then you can manually open the necessary
page (<em>opening any of these links will invalidate any previous login
you requested for Chatty, so only do it if you really want to get a new one</em>):</p>
<table class="loginlinks">
<tr>
<th></th>
<th>Chat</th>
<th>User read</th>
<th>Editor</th>
<th>Commercials</th>
<th>Subscribers</th>
</tr>
<tr>
<td><a href="https://api.twitch.tv/kraken/oauth2/authorize?response_type=token&client_id=spyiu9jqdnfjtwv6l1xjk5zgt8qb91l&redirect_uri=http://127.0.0.1:61324/token/&scope=chat_login">Request new login</a></td>
<td>x</td>
<td></td>
<td></td>
<td></td>
<td></td>
</tr>
<tr>
<td><a href="https://api.twitch.tv/kraken/oauth2/authorize?response_type=token&client_id=spyiu9jqdnfjtwv6l1xjk5zgt8qb91l&redirect_uri=http://127.0.0.1:61324/token/&scope=chat_login+user_read">Request new login</a></td>
<td>x</td>
<td>x</td>
<td></td>
<td></td>
<td></td>
</tr>
<tr>
<td><a href="https://api.twitch.tv/kraken/oauth2/authorize?response_type=token&client_id=spyiu9jqdnfjtwv6l1xjk5zgt8qb91l&redirect_uri=http://127.0.0.1:61324/token/&scope=chat_login+channel_editor+user_read">Request new login</a></td>
<td>x</td>
<td>x</td>
<td>x</td>
<td></td>
<td></td>
</tr>
<tr>
<td><a href="https://api.twitch.tv/kraken/oauth2/authorize?response_type=token&client_id=spyiu9jqdnfjtwv6l1xjk5zgt8qb91l&redirect_uri=http://127.0.0.1:61324/token/&scope=chat_login+channel_editor+channel_commercial+user_read">Request new login</a></td>
<td>x</td>
<td>x</td>
<td>x</td>
<td>x</td>
<td></td>
</tr>
<tr>
<td><a href="https://api.twitch.tv/kraken/oauth2/authorize?response_type=token&client_id=spyiu9jqdnfjtwv6l1xjk5zgt8qb91l&redirect_uri=http://127.0.0.1:61324/token/&scope=chat_login+channel_editor+channel_commercial+user_read+channel_subscriptions">Request new login</a></td>
<td>x</td>
<td>x</td>
<td>x</td>
<td>x</td>
<td>x</td>
</tr>
</table>
<p>Since the webserver in Chatty won't run if you got any of the aforementioned
errors, your browser will tell you it can't load the page when you get to
<code>http://127.0.0.1:61324</code>. Read on in the next section, especially
<a href="#addtokenmanually">Manually add the login into Chatty</a>.</p>
<h2>The browser says it can't open the page after you authorized Chatty</h2>
<p>If you successfully opened the link, authorized Chatty on the Twitch.tv
page and got redirected, but the browser can't open the page, first check this:</p>
<ul>
<li>If you followed the regular process until now, check if the <code>
Get login data</code> dialog is still open and it says <code>Ready.</code>.
It needs to be open for this to work and will close automatically when it received
the necessary data.</li>
</ul>
<p>If you can't get the page to load, you can manually add the login data into Chatty.</p>
<h3><a name="addtokenmanually">Manually add the login into Chatty</a></h3>
<p>The information you need should be in the address bar of your browser (where you got the error that it couldn't connect to the page).
It should look something like this:</p>
<code>http://127.0.0.1:61324/token/#access_token=<strong>[longish mix of letters and numbers]</strong>&amp;scope=chat_login+channel_editor+channel_commercial+user_read</code>
<p>The <code>access_token</code> (longish mix of letters and numbers)
is sort of a revokable password that lets Chatty
use some of the Twitch services on behalf of your account. Copy that from
the address bar, go to Chatty (close all dialogs if necessary) and paste
it into the following command (that you type into the input bar):</p>
<code>/changetoken &lt;the access token&gt;</code>
<p>For example if the url looked like this:</p>
<code>http://127.0.0.1:61324/token/#access_token=<strong>abcdefghi12345abcdefg</strong>&amp;scope=chat_login+channel_editor+channel_commercial+user_read</code>
<p>Then you enter this in Chatty:</p>
<code>/changetoken abcdefghi12345abcdefg</code>
<p>After entering the command, Chatty will finish the process by checking
the token and getting the username associated with it. If everything is ok,
it should say that you are now ready to connect.</p>
<p>If you want, you can check in <code>Main - Login..</code>
whether the token you entered has the correct access associated with it.</p>
</body>
</html>

42
help/0.8.1/help-guide_create_shortcut.html Normal file
View File

@ -0,0 +1,42 @@
<!DOCTYPE html>
<html>
<title>Chatty Help - Create Shortcut and add Icon</title>
<link rel="stylesheet" type="text/css" href="style.css" />
<body>
<div id="backlink"><a href="help.html">Back to main help page</a></div>
<h1><a name="top">Create Shortcut and add Icon</a></h1>
<p>This applies to Windows 7, not sure about other OS.</p>
<p>You can create a shortcut for Chatty, which has some potential advantages (depending on what you need):</p>
<ul>
<li>You can give Chatty <a href="help.html#launch">launch options</a>, like <code>-cd</code> to use a different <a href="help-guide_folders.html">settings directory</a>.</li>
<li>You can attach Chatty to the taskbar.</li>
<li>You can give the shortcut the Chatty icon, to replace the Java icon without changing it for all Java programs.</li>
</ul>
<h2>Create shortcut</h2>
<p>Create a shortcut to Java to start Chatty:</p>
<h3>First way</h3>
<ul>
<li>Right-click in the folder you want to create the shortcut in, choose <code>New - Shortcut</code> from the context menu. Enter <code>javaw -jar "D:\Chatty\Chatty.jar"</code> as location of the item.</li>
<li>Go to the next page and enter a name for the shortcut and finish creating the shorcut.</li>
<li>Right-click on the newly created shortcut and choose <code>Properties</code> from the context menu. Make sure that under <code>Shortcut</code> the <code>Start in</code> points to the folder that the <code>Chatty.jar</code> is in (otherwise some stuff might not work).</li>
</ul>
<h3>Second way</h3>
<ul>
<li>Right-click on the <code>Chatty.jar</code> and drag it to an open area in the folder, then let go to open the context menu, choose the option to create a shortcut.</li>
<li>Right-click on the newly created shortcut and choose <code>Properties</code> from the context menu. In the <code>Target</code> field, it should have the path to the <code>Chatty.jar</code>. Before that add: <code>javaw -jar </code>, so that in total it reads for example: <code>javaw -jar "D:\Chatty\Chatty.jar"</code></li>
</ul>
<h2>Editing shortcut</h2>
<p>Add launch options or icon:</p>
<ul>
<li>Right-click on the newly created shortcut and choose <code>Properties</code> from the context menu, then go to the <code>Shortcut</code> tab.</li>
<li>Add any <a href="help.html#launch">launch options</a> you want to use with Chatty after the path to Chatty. For example: <code>javaw -jar "D:\Chatty\Chatty.jar" -cd</code></li>
<li>Click <code>Change Icon..</code> and then <code>Browse..</code> to select an item to use for the Shortcut from your harddrive. (<a href="http://chatty.github.io/Chatty.ico">Download Chatty icon as <code>.ico</code> file</a>, right-click and <code>Save target as..</code>)</li>
</ul>
<h2>Use shortcut</h2>
<p>You can then start Chatty by using this shortcut or you can drag it to the taskbar to attach it to it.</p>
</body>
</html>

225
help/0.8.1/help-guide_folders.html Normal file
View File

@ -0,0 +1,225 @@
<!DOCTYPE html>
<html>
<title>Chatty Help</title>
<link rel="stylesheet" type="text/css" href="style.css" />
<style type="text/css">
.fileComment {
color: gray;
}
.fileCommentFolder {
}
.filesT {
font-family: Monospace;
margin: 10px 0 14px 0;
}
.filesT td {
margin: 0;
padding: 0;
padding-right: 5px;
padding-top: 2px;
}
</style>
<body>
<div id="backlink"><a href="help.html">Back to main help page</a></div>
<h1><a name="top">Guide: Chatty directories and files</a></h1>
<p>
<a href="#files">Files/Directory structure</a> |
<a href="#backup">Backup</a>
</p>
<p>Learn what directories and files Chatty creates/uses.</p>
<h2><a name="files">Files/Directory structure</a></h2>
<h3>Settings Directory</h3>
<p>The settings directory by default is in your user home directory in a
subfolder called <code>.chatty</code>. If you use the <code>-cd</code>
commandline parameter, then the settings directory is the current Working
Directory.</p>
<p>You can use commandline parameters by <a href="help-guide_create_shortcut.html">creating a shortcut</a> and setting the
target to something like <code>javaw.exe -jar "D:\Chatty\Chatty.jar" -cd</code>.</p>
<p>Use the command <code>/dir</code> to display and <code>/openDir</code> to
open the Settings Directory.</p>
<table class="filesT">
<tr>
<td>&lt;settings directory&gt;</td>
<td></td>
</tr>
<tr>
<td>|-- backup</td>
<td class="fileCommentFolder">[Folder]</td>
</tr>
<tr>
<td>|&nbsp; &nbsp;|-- backup_x_&lt;filename&gt;</td>
<td class="fileComment">Setting backups</td>
</tr>
<tr>
<td>|&nbsp; &nbsp;|-- backup_meta</td>
<td class="fileComment">Backups meta (last backup, numbering)</td>
</tr>
<tr>
<td>|-- cache</td>
<td class="fileCommentFolder">[Folder]</td>
</tr>
<tr>
<td>|&nbsp; &nbsp;|-- &lt;various cache files&gt;</td>
<td class="fileComment">Cached emotes/image files</td>
</tr>
<tr>
<td>|-- exported</td>
<td class="fileCommentFolder">[Folder] Files intended to be read
by the user</td>
</tr>
<tr>
<td>|&nbsp; &nbsp;|-- stream_highlights.txt</td>
<td class="fileComment">Recorded stream highlights</td>
</tr>
<tr>
<td>|-- logs</td>
<td class="fileCommentFolder">[Folder]</td>
</tr>
<tr>
<td>|&nbsp; &nbsp;|-- &lt;channel&gt;.log</td>
<td class="fileComment">Chat log files</td>
</tr>
<tr>
<td>|-- addressbook</td>
<td class="fileComment">[Settings] Addressbook entries</td>
</tr>
<tr>
<td>|-- login</td>
<td class="fileComment">[Settings] Your login data (keep this secure)</td>
</tr>
<tr>
<td>|-- favoritesAndHistory</td>
<td class="fileComment">[Settings] Channel History/Favorites</td>
</tr>
<tr>
<td>|-- settings</td>
<td class="fileComment">[Settings] Main Settings File</td>
</tr>
<tr>
<td>|-- statusPresets</td>
<td class="fileComment">[Settings] Stream Title/Game presets (Admin Dialog)</td>
</tr>
<tr>
<td>|-- debug_session.log.x</td>
<td class="fileComment">Last session debug log (overwritten every run)</td>
</tr>
<tr>
<td>|-- debugx.log.x</td>
<td class="fileComment">Rotating debug log</td>
</tr>
<tr>
<td>|-- debug_ircx.log.x</td>
<td class="fileComment">Rotating raw IRC log (only if enabled)</td>
</tr>
</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>Use the command <code>/wdir</code> to display and <code>/openWdir</code>
to open the Working Directory.</p>
<table class="filesT">
<tr>
<td>&lt;working directory&gt;</td>
<td></td>
</tr>
<tr>
<td>|-- sounds</td>
<td class="fileCommentFolder">[Folder] Sound files</td>
</tr>
<tr>
<td>|&nbsp; &nbsp;|-- &lt;sound&gt;.wav</td>
<td class="fileComment">.wav files</td>
</tr>
<tr>
<td>|-- img</td>
<td class="fileCommentFolder">[Folder] Image files for custom usericons</td>
</tr>
<tr>
<td>|&nbsp;&nbsp;&nbsp;|--&nbsp;&lt;various&nbsp;images&gt;</td>
<td class="fileComment">.png files</td>
</tr>
<tr>
<td>|-- JIntellitype.dll</td>
<td class="fileComment">DLL for global hotkey support</td>
</tr>
</table>
<h3>JAR Location</h3>
<p>This is where the Chatty.jar is located and is used for loading libraries
that Chatty uses.</p>
<h2><a name="backup">Backup</a></h2>
<p>Chatty performs an automatic backup (enabled by default) everytime it is
started (if at least the number of days as defined in the settings have passed,
by default one). It copies the setting files (except login) to the backup folder
in the settings directory, increasing the numbering of the files with every
backup. It only makes as many backups as defined in the settings and then
starts over with the first number, rotating the files.</p>
<p>This is supposed to make recovery of settings easier in case they are not
read or written correctly and thus lost (which shouldn't usually
happen). In that case you can manually copy/rename the lost files from
a backup (just looks for the most recent one based on the change date
that looks fine).</p>
<p><em>If some settings are important to you this can help, but you
shouldn't rely on it. Always make your own backups, best on a
different device!</em></p>
<h3>Restore backup</h3>
<p>If you lost your setting files (or some of them) but still have
a backup, you can manually copy the backup to restore it.</p>
<ol>
<li>Prepare & Locate Backup Folder
<ul>
<li>Make sure Chatty is not running. Settings are saved when
Chatty is closed, so if you change setting files manually
while it is running your manual changes would just be
overwritten once you close Chatty.</li>
<li>Enter <code>/openBackupDir</code> to open the Backup folder
(or enter <code>/dir</code> and navigate to the Backup folder
manually).</li>
<li>There should be several files in the format <code>backup_x_&lt;name&gt;</code>,
these represent the separate batches of backups.</li>
</ul>
</li>
<li>Find latest backup and rename
<ul>
<li>Sort the files by modification date in your file browser and
choose the latest batch that seems like it might work (e.g.
files that are not 0KB, although the addressbook might be if
you never used it).</li>
<li>Rename the files you want to restore from <code>backup_x_&lt;name&gt;</code>
to <code>&lt;name&gt;</code> (for example <code>backup_2_settings</code>
to <code>settings</code>). You can ignore the <code>backup_meta</code> file.</li>
</ul>
</li>
<li>Move renamed files
<ul>
<li>Copy or move the renamed files to the parent folder (the one
you get from <code>/dir</code> or <code>/openDir</code> commands),
overwriting any existing setting files.</li>
</ul>
</li>
<li>After you are done, start Chatty again and the settings
should be restored.</li>
</ol>
</body>
</html>

154
help/0.8.1/help-issues.html Normal file
View File

@ -0,0 +1,154 @@
<!DOCTYPE html>
<html>
<title>Chatty Help - Troubleshooting</title>
<link rel="stylesheet" type="text/css" href="style.css" />
<body>
<p>Some documentation of prior or current issues for reference.</p>
<h2>Java Crash: Graphics Driver</h2>
<p>Chatty just randomly closes, apparently the JRE completely crashes.</p>
<h3>Crash report excerpt</h3>
<pre>
#
# A fatal error has been detected by the Java Runtime Environment:
#
# EXCEPTION_ACCESS_VIOLATION (0xc0000005) at pc=0x000007f9c08f22bf, pid=272, tid=14464
#
# JRE version: Java(TM) SE Runtime Environment (7.0_45-b18) (build 1.7.0_45-b18)
# Java VM: Java HotSpot(TM) 64-Bit Server VM (24.45-b08 mixed mode windows-amd64 compressed oops)
# Problematic frame:
# C [atig6txx.dll+0x122bf]
[..]
Stack: [0x000000000f5d0000,0x000000000f6d0000], sp=0x000000000f6c9bc0, free space=998k
Native frames: (J=compiled Java code, j=interpreted, Vv=VM code, C=native code)
C [atig6txx.dll+0x122bf]
C 0x0000000000000000
Java frames: (J=compiled Java code, j=interpreted, Vv=VM code)
j sun.awt.Win32GraphicsDevice.getMaxConfigsImpl(I)I+0
j sun.awt.Win32GraphicsDevice.getMaxConfigs(I)I+10
j sun.awt.Win32GraphicsDevice.getConfigurations()[Ljava/awt/GraphicsConfiguration;+69
j javax.swing.ToolTipManager.getDrawingGC(Ljava/awt/Point;)Ljava/awt/GraphicsConfiguration;+36
[..]
</pre>
<h3>Solution/Workaround</h3>
<p>Seems to have to do with the graphics driver. Reinstalling/updating the graphics driver may
help or using the following commandline parameter, which should disable the calls to the library
that cause the error:</p>
<p><code>-Dsun.awt.nopixfmt=true</code></p>
<p>For example:</p>
<p><code>javaw -Dsun.awt.nopixfmt=true -jar "H:\chatty\Chatty.jar" -cd</code></p>
<h3>Links</h3>
<ul>
<li><a href="http://obsproject.com/forum/threads/chatty.14149/#post-81264">http://obsproject.com/forum/threads/chatty.14149/#post-81264</a> (Chatty thread)</li>
<li><a href="http://www.oxygenxml.com/forum/topic10290.html">http://www.oxygenxml.com/forum/topic10290.html</a> (Crashes of another program and workaround)</li>
<li><a href="http://bugs.java.com/bugdatabase/view_bug.do?bug_id=6477756">http://bugs.java.com/bugdatabase/view_bug.do?bug_id=6477756</a> (Related Bug)</li>
</ul>
<h2>Random Errors: Using Calibri Font</h2>
<p>After some time, Chatty suddenly shows an error if using the Calibri font.</p>
<h3>Excerpts</h3>
<pre>
java.lang.ArrayIndexOutOfBoundsException: 168
at sun.font.ExtendedTextSourceLabel.getCharX(ExtendedTextSourceLabel.java:353)
at java.awt.font.TextLine$3.computeFunction(TextLine.java:515)
at java.awt.font.TextLine.applyFunctionAtIndex(TextLine.java:651)
at java.awt.font.TextLine.getCharXPosition(TextLine.java:668)
at java.awt.font.TextLine.getCharLinePosition(TextLine.java:678)
at java.awt.font.TextLayout.buildCache(TextLayout.java:683)
at java.awt.font.TextLayout.ensureCache(TextLayout.java:655)
at java.awt.font.TextLayout.getAdvance(TextLayout.java:885)
at sun.font.FontDesignMetrics.charsWidth(FontDesignMetrics.java:510)
at javax.swing.text.Utilities.getTabbedTextOffset(Utilities.java:422)
at javax.swing.text.GlyphPainter1.getBoundedPosition(GlyphPainter1.java:213)
at javax.swing.text.GlyphView.getBreakWeight(GlyphView.java:722)
at javax.swing.text.ParagraphView.calculateMinorAxisRequirements(ParagraphView.java:732)
at javax.swing.text.BoxView.checkRequests(BoxView.java:935)
at javax.swing.text.BoxView.getMinimumSpan(BoxView.java:568)
at javax.swing.text.BoxView.calculateMinorAxisRequirements(BoxView.java:903)
at javax.swing.text.BoxView.checkRequests(BoxView.java:935)
at javax.swing.text.BoxView.setSpanOnAxis(BoxView.java:343)
at javax.swing.text.BoxView.layout(BoxView.java:708)
at javax.swing.text.BoxView.setSize(BoxView.java:397)
at javax.swing.plaf.basic.BasicTextUI$RootView.setSize(BasicTextUI.java:1714)
at javax.swing.plaf.basic.BasicTextUI.modelToView(BasicTextUI.java:1046)
at javax.swing.plaf.basic.BasicTextUI.modelToView(BasicTextUI.java:1022)
at javax.swing.text.JTextComponent.modelToView(JTextComponent.java:1428)
at chatty.gui.components.ChannelTextPane$ScrollManager.scrollDown(ChannelTextPane.java:1107)
at chatty.gui.components.ChannelTextPane$ScrollManager.access$200(ChannelTextPane.java:994)
at chatty.gui.components.ChannelTextPane.printInternal(ChannelTextPane.java:932)
at chatty.gui.components.ChannelTextPane.print(ChannelTextPane.java:906)
at chatty.gui.components.ChannelTextPane.printSpecials(ChannelTextPane.java:772)
at chatty.gui.components.ChannelTextPane.printMessage(ChannelTextPane.java:189)
at chatty.gui.components.Channel.printMessage(Channel.java:228)
at chatty.gui.MainGui$15.run(MainGui.java:1498)
java.lang.ArrayIndexOutOfBoundsException: 0
at sun.font.ExtendedTextSourceLabel.createCharinfo(Unknown Source)
at sun.font.ExtendedTextSourceLabel.getCharinfo(Unknown Source)
at sun.font.ExtendedTextSourceLabel.getCharX(Unknown Source)
at java.awt.font.TextLine$3.computeFunction(Unknown Source)
at java.awt.font.TextLine.applyFunctionAtIndex(Unknown Source)
at java.awt.font.TextLine.getCharXPosition(Unknown Source)
at java.awt.font.TextLine.getCharLinePosition(Unknown Source)
at java.awt.font.TextLayout.buildCache(Unknown Source)
at java.awt.font.TextLayout.ensureCache(Unknown Source)
at java.awt.font.TextLayout.getAdvance(Unknown Source)
at sun.font.FontDesignMetrics.charsWidth(Unknown Source)
at javax.swing.text.Utilities.getTabbedTextWidth(Unknown Source)
</pre>
<h3>Solution/Workaround</h3>
<p>Hopefully this will be fixed in future Java updates, but for now just don't
use a Calibri font.</p>
<h3>Links</h3>
<ul>
<li><a href="http://stackoverflow.com/questions/16331075/error-generating-jasperreport-in-development-mode">http://stackoverflow.com/questions/16331075/error-generating-jasperreport-in-development-mode</a></li>
<li><a href="https://community.oracle.com/message/11119052#11119052">https://community.oracle.com/message/11119052#11119052</a></li>
</ul>
<h2>Twitch Emotes appearing wrong on Retina Displays</h2>
<p>Twitch Emoticons appear wrong when Chatty is displayed on a Retina display.
Instead of the Emoticon images, the 404 image the Twitch CDN redirects to is
shown.
<p>Apparently in newer Java versions <code>Toolkit.getImage()</code> tries to find a higher
resolution image by adding @2 to the file name, which the Twitch CDN actually
responds to by redirecting to an error image, which is then displayed.</p>
<h3>Solution/Workaround</h3>
<p>Use <code>Toolkit.createImage()</code> and create an <code>ImageIcon</code> with the created image.</p>
<h3>Links</h3>
<ul>
<li><a href="https://bugs.openjdk.java.net/browse/JDK-8011059">https://bugs.openjdk.java.net/browse/JDK-8011059</a> (OpenJDK Issue Page about this behaviour)</li>
</ul>
</body>
</html>

97
help/0.8.1/help-livestreamer.html Normal file
View File

@ -0,0 +1,97 @@
<!DOCTYPE html>
<html>
<title>Chatty - Livestreamer</title>
<link rel="stylesheet" type="text/css" href="style.css" />
<body>
<div id="backlink"><a href="help.html">To main help page</a></div>
<h1><a name="top">Livestreamer</a></h1>
<p>
<a href="#usage">Usage</a> |
<a href="#settings">Settings</a> |
<a href="#troubleshooting">Troubleshooting</a>
</p>
<p><a href="http://livestreamer.readthedocs.org/en/latest/">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>
<h2><a name="usage">Usage</a></h2>
<p>You can open the Livestreamer dialog that Chatty provides via
<code>Extra - Livestreamer</code>, where you can directly run Livestreamer
and change some settings.</p>
<p>Each time you open a stream via the dialog or a context menu, a tab is
added to the dialog where the output of the Livestreamer process is
redirected to. If you open a stream with the same stream name and quality you already
have open in a tab whose process isn't currently running, then that tab will
be reused.</p>
<p>The tab of a stream is automatically closed when you close the Video
Player opened by Livestreamer, if the dialog isn't currently open. Otherwise
you have to close it yourself by using the <code>Close</code>-button on the
top right, which turns into an <code>End process</code>-button as long as
the process is still running. The <code>Retry</code>-button can be used to
re-run the last command of that tab (for example when it couldn't find the
stream, but you want to retry now because you know it's come online).</p>
<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.
<br /><br />
Examples:
<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>
</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>
</ul>
<h2><a name="troubleshooting">Troubleshooting</a></h2>
<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>
<p>To solve this, first make sure that
you actually have Livestreamer installed. You need to install it on you own, it does
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>
</body>
</html>

47
help/0.8.1/help-memory_usage.html Normal file
View File

@ -0,0 +1,47 @@
<!DOCTYPE html>
<html>
<title>Chatty Help</title>
<link rel="stylesheet" type="text/css" href="style.css" />
<body>
<div id="backlink"><a href="help.html">Back to main help page</a></div>
<h1><a name="top">Memory Usage</a></h1>
<p>
<a href="#restrict">Restrict Memory Usage</a> |
<a href="#error">OutOfMemoryError</a>
</p>
<p>The programs memory is managed by Java, which means Java allocates a
certain amount of memory which is then filled up with data of the program
and once Java decides so, it cleans up data that is not used anymore
(Garbage Collection). This leads to the actual memory usage going up and
down constantly, while the allocated memory mostly stays the same. So
even if only 50 MB are filled with data by the program <em>at the time</em>, Java may
still have 200 MB reserved to optimize Gargabe Collection. Thus, the memory usage in e.g. the Task Manager
may not reflect what the program actually <em>requires</em>, just how
much Java uses.</p>
<p>Use the <code>/appinfo</code> command in Chatty to get some information
about the current memory usage.</p>
<p>A typical memory usage pattern, which can change over time as the program
is running while Java optimizes Gargabe Collection:<br />
<img src="jconsole.jpg" alt="Typical memory usage pattern" /></p>
<h2><a name="restrict">Restrict Memory Usage</a></h2>
<p>You can <a href="http://stackoverflow.com/questions/1493913/how-to-set-the-maximum-memory-usage-for-jvm">restrict</a> how much memory Java is allowed to use by specifying
commandline parameters for Java. <a href="help-guide_create_shortcut.html">Create a shortcut</a>
and add the appropriate parameter after the <code>javaw.exe</code> but
before the <code>-jar</code> parameter.</p>
<p>For example to restrict memory to 100 MB: <code>javaw -Xmx100M -jar "D:\Chatty\Chatty.jar"</code></p>
<h2><a name="error">OutOfMemoryError</a></h2>
<p>If you get an OutOfMemoryError then Java ran out of memory. This can
either be because it simply can't allocate enough memory (at least 100 MB is recommended)
or there is a bug that prevents it from cleaning up memory that is not
actually used anymore. These kinds of bugs are pretty difficult to track
down though, especially if they only occur somewhat randomly.</p>
</body>
</html>

1080
help/0.8.1/help-releases.html Normal file
View File

File diff suppressed because it is too large Load Diff

533
help/0.8.1/help-setting_commands.html Normal file
View File

@ -0,0 +1,533 @@
<!DOCTYPE html>
<html>
<title>Chatty Help - Setting Commands</title>
<link rel="stylesheet" type="text/css" href="style.css" />
<body>
<div id="backlink"><a href="help.html">Back to main help page</a></div>
<h1><a name="top">Setting Commands</a></h1>
<p><a href="#commands">Commands</a>
| <a href="#settings">Settings</a></p>
<p>There are a couple of commands that allow you to change settings from
the chat inputbox. (<em>You should probably roughly know what you're doing
before using these.</em>)</p>
<h2>
<a name="commands">Commands</a>
<a href="#top" class="top">[back to menu]</a>
</h2>
<ul>
<li><code>/set &lt;setting&gt; &lt;value&gt;</code> changes a setting</li>
<li><code>/get &lt;setting&gt;</code> shows the current value of a
setting</li>
<li><code>/reset &lt;setting&gt;</code> resets the setting to the
default (hard-coded) value</li>
<li><code>/clearsetting &lt;setting&gt;</code> sets string settings to
an empty string</li>
<li><code>/add &lt;setting&gt; &lt;value&gt;</code> adds item to a list
of strings/numbers</li>
<li><code>/remove &lt;setting&gt; &lt;value&gt;</code> removes item from
a list of strings/numbers</li>
</ul>
<p><em>Tip:</em> You can use <a href="help.html#nickCompletion">TAB Completion</a>
for setting names when using it behind a setting command.</p>
<h2>
<a name="settings">Settings</a>
<a href="#top" class="top">[back to menu]</a>
</h2>
<p>The following are settings that can be changed using the setting commands.
A lot of those - but not all - can also be changed in the Settings Dialog,
which is more convient in some cases. This does not show all settings.</p>
<ul>
<li>For Addressbook related settings, see <a href="help-addressbook.html#advanced">Addressbook Help</a>.</li>
</ul>
<p>Settings with a <span class="settingExclusive">slightly darker background color</span>
are settings that are not available in the Settings Dialog and can only be
changed via commands (and sometimes also commandline options). Settings with
a <span class="settingNoCommandEdit">lighter color</span> can't (or are not recommended to) be changed
via setting commands, but are added to the list because their value can be
viewed with <code>/get</code>.</p>
<p>
<a href="#font">Font</a> |
<a href="#time">Time</a> |
<a href="#server">Server/Connection</a> |
<a href="#chat">Chat</a> |
<a href="#window">Window</a> |
<a href="#streamchat">Stream Chat</a> |
<a href="#streamhighlights">Stream Highlights</a> |
<a href="#debugging">Debugging</a> |
<a href="#bots">Bot Badges</a>
</p>
<table class="settings" style="border-collapse: collapse;">
<tr style="border-bottom: 1px solid #EEE">
<th>Setting</th>
<th>Type</th>
<th>Values</th>
<th>Default</th>
<th>Description</th>
</tr>
<tr class="settingExclusive">
<td class="setting">dontSaveSettings</td>
<td colspan="2">Boolean</td>
<td>false</td>
<td>Don't save settings when Chatty is closed (<code>-ds</code> commandline option).</td>
</tr>
<tr>
<td class="setting">timeoutButtons</td>
<td rowspan="3">String</td>
<td rowspan="3">See <a href="help-settings.html#commands-menu">Command Settings Help</a></td>
<td><em>too long</em></td>
<td>Buttons in the Userinfo dialog (not only timeout buttons)</td>
</tr>
<tr>
<td class="setting">userContextMenu</td>
<td><em>empty</em></td>
<td>Custom entries in the User Context Menu</td>
</tr>
<tr>
<td class="setting">channelContextMenu</td>
<td><em>empty</em></td>
<td>Custom entries in the Channel Context Menu</td>
</tr>
<tr class="settingExclusive">
<td class="setting">twitchnotifyAsInfo</td>
<td colspan="2">Boolean</td>
<td>true</td>
<td>Show messages from user "twitchnotify" as info messages.
Turn off to show as regular message, so you can e.g. highlight
it.</td>
</tr>
<tr class="settingExclusive">
<td class="setting">backupDelay</td>
<td>Integer</td>
<td>Number of days</td>
<td>1</td>
<td>How many days to wait between a <a href="help-guide_folders.html#backup">Backup</a></td>
</tr>
<tr class="settingExclusive">
<td class="setting">backupCount</td>
<td>Integer</td>
<td>Number of backups</td>
<td>5</td>
<td>How many backups to rotate through</td>
</tr>
<tr class="settingNoCommandEdit">
<td class="setting">hotkeys</td>
<td>List</td>
<td colspan="2"><em>Cannot be edited by command</em></td>
<td>The hotkeys that are currently defined</td>
</tr>
<tr>
<td class="setting">globalHotkeysEnabled</td>
<td colspan="2">Boolean</td>
<td>true</td>
<td>Enable global hotkeys that are defined in the settings.
Disable this to temporarily turn off the global hotkeys you
defined.</td>
</tr>
<tr class="settingExclusive">
<td class="setting">imageCache</td>
<td colspan="2">Boolean</td>
<td>true</td>
<td>Whether images (emotes, usericons) are cached in local
files.</td>
</tr>
</table>
<h3><a name="font">Font</a></h3>
<table class="settings">
<tr style="border-bottom: 1px solid #EEE">
<th>Setting</th>
<th>Type</th>
<th>Values</th>
<th>Default</th>
<th>Description</th>
</tr>
<tr>
<td class="setting">font</td>
<td>String</td>
<td>Font name, e.g. <code>Arial</code> or <code>Arial Bold</code></td>
<td>Consolas</td>
<td>The font used for the chat</td>
</tr>
<tr>
<td class="setting">fontSize</td>
<td>Integer</td>
<td>Font size, e.g. <code>14</code></td>
<td>14</td>
<td>The font size used for the chat</td>
</tr>
<tr>
<td class="setting">lineSpacing</td>
<td>Integer</td>
<td>Numbers between <code>-1</code> and <code>10</code> probably
make the most sense.</td>
<td>3</td>
<td>The space between chatlines</td>
</tr>
<tr class="settingExclusive">
<td class="setting">inputFont</td>
<td>String</td>
<td>Font name and size, as understood by <a href="http://docs.oracle.com/javase/7/docs/api/java/awt/Font.html#decode%28java.lang.String%29">Font.decode()</a></td>
<td>Dialog 14</td>
<td>The font for the chat input box (should only be set to
Java logical fonts like <code>Dialog</code> or
<code>Monospaced</code>, otherwise fallback fonts in
chat may not work correctly*)</td>
</tr>
<tr class="settingExclusive">
<td class="setting">dialogFontSize</td>
<td>Integer</td>
<td>Font size or <code>-1</code> to keep default</td>
<td>-1</td>
<td>Setting to customize the font size of dialogs, currently
experimentel and only for User Info Dialog.</td>
</tr>
</table>
<p>* If a character isn't contained in the chat font you have
currently configured, Java will try to find it in the fallback
fonts. While still not all characters will be displayed this way, it
should work a lot better. You can also <a href="help-troubleshooting.html#font">add your own fallback fonts</a>
to improve the situation further. However, setting the input box
font to your chat font somehow breaks the fallback font mechanism,
resulting in less characters being able to be displayed (like in
versions before 0.7.3).</p>
<h3><a name="time">Time</a> <span style="font-size:0.5em;">Dr. Freeman..</span></h3>
<table class="settings">
<tr style="border-bottom: 1px solid #EEE">
<th>Setting</th>
<th>Type</th>
<th>Values</th>
<th>Default</th>
<th>Description</th>
</tr>
<tr>
<td class="setting">timestamp</td>
<td>String</td>
<td>Format as understood by
<a href="http://docs.oracle.com/javase/7/docs/api/java/text/SimpleDateFormat.html">SimpleDateFormat</a>
or <code>off</code></td>
<td class="settingDefault">[HH:mm]</td>
<td>The timestamp used for all lines in chat</td>
</tr>
<tr class="settingExclusive">
<td class="setting">timestampTimezone</td>
<td>String</td>
<td>As understood by <a href="http://docs.oracle.com/javase/7/docs/api/java/util/TimeZone.html#getTimeZone%28java.lang.String%29">Timezone.getTimeZone()</a>
e.g. <code>GMT+2</code> or <code>PST</code></td>
<td class="settingDefault"><code><em>empty</em></code></td>
<td>The timezone used for the <code>timestamp</code></td>
</tr>
<tr>
<td class="setting">logTimestamp</td>
<td>String</td>
<td>Format as understood by
<a href="http://docs.oracle.com/javase/7/docs/api/java/text/SimpleDateFormat.html">SimpleDateFormat</a>
or <code>off</code></td>
<td class="settingDefault">[HH:mm:ss]</td>
<td>The timestamp used for all lines in the chatlog files</td>
</tr>
</table>
<h3><a name="server">Server/Connection Settings</a></h3>
<table class="settings">
<tr style="border-bottom: 1px solid #EEE">
<th>Setting</th>
<th>Type</th>
<th>Values</th>
<th>Default</th>
<th>Description</th>
</tr>
<tr>
<td class="setting">serverDefault</td>
<td>String</td>
<td>The server address, host or IP</td>
<td class="settingDefault">irc.twitch.tv</td>
<td>Default server to connect to, which can be changed in
the Settings Dialog and is saved between sessions</td>
</tr>
<tr>
<td class="setting">portDefault</td>
<td>String</td>
<td>One or more ports, seperated 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>
</tr>
<tr class="settingExclusive">
<td class="setting">server</td>
<td>String</td>
<td>The server address, host or IP</td>
<td class="settingDefault"><em>empty</em></td>
<td>If set, overrides the <code>defaultServer</code>, can be
set by commandline options, not saved in between sessions</td>
</tr>
<tr class="settingExclusive">
<td class="setting">port</td>
<td>String</td>
<td>One or more ports, seperated 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>
</tr>
<tr>
<td class="setting">username</td>
<td>String</td>
<td>Your username</td>
<td class="settingDefault"><em>empty</em></td>
<td>Public part of the <a href="help.html#login">Login data</a>
to login into chat</td>
</tr>
<tr>
<td class="setting">token</td>
<td>String</td>
<td>OAuth token</td>
<td class="settingDefault"><em>empty</em></td>
<td>Secret part of the <a href="help.html#login">Login data</a>
to authorize with Twitch, don't show this to anyone. You
shouldn't change this directly, but use the <code>/changetoken</code>
command instead when manually setting the token.</td>
</tr>
<tr class="settingExclusive">
<td class="setting">spamProtection</td>
<td>String</td>
<td>messages/seconds, e.g. <code>10/20</code></td>
<td class="settingDefault">18/30</td>
<td>How many messages Chatty allows you to send to the server
in the given time, to prevent a ban from chat</td>
</tr>
<tr>
<td class="setting">membershipEnabled</td>
<td colspan="2">Boolean</td>
<td class="settingDefault">true</td>
<td>Refers to the <code>twitch.tv/membership</code> IRCv3 CAP, which
enables sending a userlist and joins/parts, allowing for a
correct userlist in Chatty and showing of joins/parts in chat
(if separately enabled of course)</td>
</tr>
</table>
<h3><a name="chat">Chat</a></h3>
<table class="settings">
<tr style="border-bottom: 1px solid #EEE">
<th>Setting</th>
<th>Type</th>
<th>Values</th>
<th>Default</th>
<th>Description</th>
</tr>
<tr>
<td class="setting">pauseChatOnMouseMove</td>
<td colspan="2">Boolean</td>
<td>false</td>
<td>Enables the <a href="help.html#pausechat">Pause Chat</a>
feature</td>
</tr>
<tr>
<td class="setting">pauseChatOnMouseMoveCtrlRequired</td>
<td colspan="2">Boolean</td>
<td>false</td>
<td>Require <kbd>Ctrl</kbd> to be pressed to start pausing
chat</td>
</tr>
<tr>
<td class="setting">commandOnCtrlClick</td>
<td>String</td>
<td>Command to run (only the command name)</td>
<td><em>empty</em></td>
<td>The command to run when clicking on a user while holding
<kbd>Ctrl</kbd></td>
</tr>
</table>
<h3><a name="window">Window</a></h3>
<table class="settings">
<tr style="border-bottom: 1px solid #EEE">
<th>Setting</th>
<th>Type</th>
<th>Values</th>
<th>Default</th>
<th>Description</th>
</tr>
<tr class="settingNoCommandEdit">
<td class="setting">windows</td>
<td>Map</td>
<td colspan="2"><em>Cannot be edited by command</em></td>
<td>The windows/dialogs positions/sizes as they where loaded
when you started Chatty (NOT necessarily the current ones).</td>
</tr>
<tr>
<td class="setting">tabOrder</td>
<td>String</td>
<td><code>normal</code>, <code>alphabetical</code></td>
<td>normal</td>
<td>How tabs are added (in the order they are added or
alphabetical).</td>
</tr>
<tr>
<td class="setting">tabsMwheelScrolling</td>
<td colspan="2">Boolean</td>
<td>false</td>
<td>Scroll through tabs with mousewheel.</td>
</tr>
<tr>
<td class="setting">tabsMwheelScrollingAnywhere</td>
<td colspan="2">Boolean</td>
<td>false</td>
<td>Allow scrolling through tabs with mousewheel everywhere
on the tabpane where nothing else can be scrolled (mainly
the inputbox).</td>
</tr>
</table>
<h3><a name="streamchat">Stream Chat</a></h3>
<table class="settings">
<tr style="border-bottom: 1px solid #EEE">
<th>Setting</th>
<th>Type</th>
<th>Values</th>
<th>Default</th>
<th>Description</th>
</tr>
<tr class="settingExclusive">
<td class="setting">streamChatChannels</td>
<td>List[String]</td>
<td>Channel name (with leading #) or empty</td>
<td><em>empty</em></td>
<td>Forwards messages from the given channels to
<a href="help.html#streamchat">Stream Chat</a>.</td>
</tr>
<tr class="settingExclusive">
<td class="setting">streamChatMessageTimeout</td>
<td>Integer</td>
<td>Number of seconds, negative to disable</td>
<td>-1</td>
<td>How long messages are displayed before they disappear
from Stream Chat.</td>
</tr>
<tr class="settingExclusive">
<td class="setting">streamChatBottom</td>
<td colspan="2">Boolean</td>
<td>true</td>
<td>Start inserting messages at the bottom. Messages are
always inserted below previous messages, but disabling this setting
will make them <em>start</em> at the top. <em>Requires a
restart of Chatty after changing to take any effect.</em></td>
</tr>
<tr>
<td class="setting">streamChatResizable</td>
<td colspan="2">Boolean</td>
<td>true</td>
<td>Whether the Stream Chat dialog is resizable by dragging
the edges.</td>
</tr>
</table>
<h3><a name="streamhighlights">Stream Highlights</a></h3>
<table class="settings">
<tr style="border-bottom: 1px solid #EEE">
<th>Setting</th>
<th>Type</th>
<th>Values</th>
<th>Default</th>
<th>Description</th>
</tr>
<tr class="settingExclusive">
<td class="setting">streamHighlightChannel</td>
<td>String</td>
<td>Channel name (with leading #) or empty</td>
<td><em>empty</em></td>
<td>Allows moderators in the given channel to run the
!addStreamHighlight command.</td>
</tr>
<tr class="settingExclusive">
<td class="setting">streamHighlightChannelRespond</td>
<td colspan="2">Boolean</td>
<td>false</td>
<td>If this is enabled, Chatty sends a message to chat when
a moderator uses the !addStreamHighlight command. Otherwise
the response to the command is only shown locally.</td>
</tr>
<tr class="settingExclusive">
<td class="setting">streamHighlightCommand</td>
<td>String</td>
<td>The command to use for moderators</td>
<td><em>!addstreamhighlight</em></td>
<td>Change this to define the command that can be used by
mods to add stream highlights in the channel defined with
the <code>streamHighlightChannel</code> setting.</td>
</tr>
</table>
<h3><a name="debugging">Debugging</a></h3>
<table class="settings">
<tr style="border-bottom: 1px solid #EEE">
<th>Setting</th>
<th>Type</th>
<th>Values</th>
<th>Default</th>
<th>Description</th>
</tr>
<tr>
<td class="setting">debugLogIrc</td>
<td colspan="2">Boolean</td>
<td>false</td>
<td>Log raw IRC messages in the Debug Window.</td>
</tr>
<tr class="settingExclusive">
<td class="setting">debugLogIrcFile</td>
<td colspan="2">Boolean</td>
<td>false</td>
<td>Log raw IRC messages to the debug_irc.log file in the
settings directory.</td>
</tr>
</table>
<h3><a name="bots">Bot Badges</a></h3>
<table class="settings">
<tr style="border-bottom: 1px solid #EEE">
<th>Setting</th>
<th>Type</th>
<th>Values</th>
<th>Default</th>
<th>Description</th>
</tr>
<tr>
<td class="setting">botBadgeEnabled</td>
<td colspan="2">Boolean</td>
<td>true</td>
<td>Show bot badge in chat for known bots.</td>
</tr>
<tr class="settingExclusive">
<td class="setting">botNames</td>
<td>List[String]</td>
<td>Name of the bot</td>
<td>some default names</td>
<td>List of locally defined known bots. You have to restart
Chatty for changes to take effect.</td>
</tr>
<tr>
<td class="setting">botNamesBTTV</td>
<td colspan="2">Boolean</td>
<td>true</td>
<td>Use bot names from BTTV API. BTTV emotes have to be enabled for this to work.</td>
</tr>
<tr>
<td class="setting">botNamesFFZ</td>
<td colspan="2">Boolean</td>
<td>true</td>
<td>Use bot names from FFZ API. FFZ emotes have to be enabled for this to work.</td>
</tr>
</table>
</body>
</html>

1202
help/0.8.1/help-settings.html Normal file
View File

File diff suppressed because it is too large Load Diff

153
help/0.8.1/help-short_guides.html Normal file
View File

@ -0,0 +1,153 @@
<!DOCTYPE html>
<html>
<title>Chatty Help - Short Guides</title>
<link rel="stylesheet" type="text/css" href="style.css" />
<body>
<div id="backlink"><a href="help.html">Back to main help page</a></div>
<h1><a name="top">More Guides..</a></h1>
<p>
<a href="#localsubonly">Local Subscriber-Only Mode</a> |
<a href="#streamers">Chatty for Streamers</a> |
<a href="#eventchat">Join Eventchat</a>
</p>
<p>Probably shorter guides about some aspects of Chatty.</p>
<h2><a name="localsubonly">Local Subscriber-Only Mode</a></h2>
<p>You can create your own local subonly mode, which ignores all messages
written by non-subscribers.</p>
<p>Features used: <a href="help-settings.html#Ignore">Ignore System</a>, <a href="help-addressbook.html">Addressbook</a>,
<a href="help-settings.html#Commands">Custom Commands</a></p>
<h3>Create Ignore Entry</h3>
<p>Go to <code>Main - Settings - Ignore</code> and make sure <code>Enable Ignore</code>
is ticked. Then add to the list (press the Plus-Button):</p>
<p><code>!status:smbaf chanCat:subonly</code></p>
<p>The <code>!status:smbaf</code> prefix matches on messages send by users that
<em>don't</em> have any of the status levels defined, in this case users
that are neither a subscriber (<code>s</code>), moderator (<code>m</code>), broadcaster (<code>b</code>),
admin (<code>a</code>) or staff (<code>f</code>). So basicially this only matches on normal users.</p>
<p>The second requirement for a match is the <code>chanCat:subonly</code>
prefix, which refers to the channel category <code>subonly</code>, which
means the channel the message was send in needs to have that Addressbook category.
This is used to be able to easily toggle subonly-mode for a channel, and
of course to prevent it being enabled in all channels you join in the
first place.</p>
<h3>Create Custom Command to modify Addressbook</h3>
<p>To make use of the Ignore Entry defined in the previous section, you need
to add the <code>subonly</code> category to the channel you want to have
it enabled for. To do this, you could open the Addressbook Dialog
(<code>Channels - Addressbook</code>) and add the channel with the
category there (channels need a leading # in this case, so e.g. <code>#joshimuz</code>).</p>
<p>You can however also use <a href="help-addressbook.html#commands">Addressbook Commands</a>:</p>
<p><code>/ab change #joshimuz !subonly</code></p>
<p>This toggles the <code>subonly</code> category for the given channel, so
when the category is there, it removes the category, and when the category is not there,
it adds the category.</p>
<p>To do this a bit more conveniently, you can add it as a custom command. Go
to <code>Main - Settings - Commands</code> and add the following to the
list:</p>
<p><code>/Toggle_Subonly /ab change #$$1 !subonly</code></p>
<p>If you enter <code>/Toggle_Subonly joshimuz</code>, this will automatically
run the Addressbook as mentioned above (<code>$$1</code> means this is
being replaced with the first word after the command).</p>
<p>To make this more convenient (entering the command with the correct channel
could be a bit of a hassle), add the Custom Command to the <code>Channel Context Menu</code>
(on the same page in the settings). Just click on <code>Edit</code> and add
the command name (without any parameters):</p>
<p><code>/Toggle_Subonly</code></p>
<p>Now if you right-click on a channel, the context menu that opens should
have an entry <code>Toggle Subonly</code>, which you can
use to turn your own local subonly mode for the current channel on and off.</p>
<h2><a name="streamers">Chatty for Streamers</a></h2>
<h3>Stay informed</h3>
<ul>
<li>Open the <code>&lt;View - Channel Info&gt;</code> to see your current
stream title/game, a graph of your viewercount and how long your current
stream already is going.</li>
<li>Open the <code>&lt;Extra - Followers/Subscribers&gt;</code> dialog
to view your 100 most recent Followers/Subscribers and some stats based
on that.</li>
</ul>
<h3>Manage your stream</h3>
<ul>
<li>Open the <code>&lt;View - Channel Admin&gt;</code> dialog to change
the title/game of your stream and run commercials:
<ul>
<li>Presets/History for title/game combinations</li>
<li>Favorite games you play often</li>
<li>Run commercials on a delay and/or timer</li>
<li>Run commercials while playing a game via a global hotkey
(Windows only)</li>
</ul>
</li>
</ul>
<h3>Capture chat for on-stream chat</h3>
<ul>
<li>Customize chat colors, for example change to black background to be
able to make the background transparent in your streaming program.</li>
<li>If you capture Chatty with your streaming program, make sure to
enable the setting <code>Settings - Window - Always show chat scrollbar</code>, so you can always capture the same
region, independant of how many messages are in the chat window.</li>
<li>Change the font so it shows up nicely on stream.</li>
<li>If you want to have all text in bold - not just the names - you can
set the font by command like this: <code>/set font Arial Bold</code>.</li>
<li>You can clear the chat window by using the <code>/clearchat</code>
command (e.g. if you changed some settings before starting the stream
you don't want to show).</li>
</ul>
<h2><a name="eventchat">Join Eventchat</a></h2>
<p>When you join a channel of a big event and you don't receive any (or few) messages,
it's possible that the channel is on the Event Chat servers, not the
regular Twitch Chat servers. It's a common problem to run into if you're
not using the website (like any regular IRC client, Chatty and possibly
mobile).</p>
<p>In order to join Event Chat in Chatty, you have to connect to a different
server. See <a href="http://twitchstatus.com/#chat">Twitchstatus.com</a> for an (unofficial) list
of servers (make sure you choose the <code>Event Chat</code> tab and use
a server/port combination that is marked as <code>irc</code> in the
<code>Protocol</code> column).</p>
<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
same time.</p>
<p>There are different ways of connecting to a different server:</p>
<ul>
<li>The <code>/server &lt;host&gt;[:port]</code> command connects to the given server and
port manually (for example <code>/server irc.twitch.tv:443</code>,
replace with an Event Chat server accordingly).</li>
<li>The <code>-server</code> and <code>-port</code> commandline options
allow you to specify a different server when you start Chatty.</li>
<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>
</ul>
<p>If you want to switch between servers sometimes, you can create a
custom command to connect to Event Chat so you don't have to enter
the command with the IP and port manually every time. Go to
<code>Settings - Commands</code>, add a new Custom Command and enter:
<code>/eventchat /server &lt;server&gt;:&lt;port&gt;</code> (replace
with the appropriate IP and port of course). Then you
can just enter <code>/eventchat</code> in the inputbox (while not
being connected) and it will connect to Event Chat and if you want to
connect to regular Twitch Chat just connect regularly via the menu
(and it will use <code>irc.twitch.tv</code> if you didn't change the
server settings).</p>
</body>
</html>

42
help/0.8.1/help-srl.html Normal file
View File

@ -0,0 +1,42 @@
<!DOCTYPE html>
<html>
<title>Chatty - SpeedRunsLive</title>
<link rel="stylesheet" type="text/css" href="style.css" />
<body>
<div id="backlink"><a href="help.html">To main help page</a></div>
<h1><a name="top">SpeedRunsLive (SRL)</a></h1>
<p><a href="http://speedrunslive.com">SpeedRunsLive</a> is a platform
dedicated to speedrunning and racing (live speedruns against other players).
Chatty has an integrated race viewer, which lists all the current races.</p>
<h2>
<a name="0.6.3">Race List / Race Info</a>
<a href="#top" class="top">[back to top]</a>
</h2>
<p>Open the race list via <code>SRL - Race List</code>, which shows the
current races. Right-click on a race to open a contextmenu with several
options, double-click on a race to open the Race Info dialog.</p>
<p>Notice that the race list isn't automatically updated, unless you have
a Race Info dialog open (which is automatically updated in a regular
interval). If you want actual real-time information on races, joining
the SRL IRC is a good option. The integration in Chatty is mainly supposed
to make opening/joining race related stuff easier and to give a quick and
easy overview of who is in a race you are watching (without having to open
a website).</p>
<h2>
<a name="0.6.3">Find races with someone</a>
<a href="#top" class="top">[back to top]</a>
</h2>
<p>Use <code>SRL - Races with..</code> to find races that the stream of
the currently active channel you have joined is part of. This will basicially
take the stream you have clicked on, search through all the current races
and list all the races that have an entrant that has that stream set. If
there is only one matching race, and you currently don't have the Race Info
dialog open, then it is immediately opened. Otherwise the matching races are
listed for you to select.</p>
</body>
</html>

285
help/0.8.1/help-troubleshooting.html Normal file
View File

@ -0,0 +1,285 @@
<!DOCTYPE html>
<html>
<title>Chatty Help - Troubleshooting</title>
<link rel="stylesheet" type="text/css" href="style.css" />
<body>
<div id="backlink"><a href="help.html">Back to main help page</a></div>
<h1><a name="top">Troubleshooting</a></h1>
<ul>
<li>Startup/Folders/Settings
<ul>
<li><a href="#start">Chatty won't start</a></li>
<li><a href="#jintellitype">Could not load JIntellitype.dll</a></li>
<li><a href="#settings_lost">Settings lost</a></li>
<li><a href="#wrong_folders">Wrong image/sounds folder</a></li>
</ul>
</li>
<li>Connection Issues
<ul>
<li><a href="#login">Can't connect because the login failed</a></li>
<li><a href="#connect">Can't connect</a></li>
</ul>
</li>
<li>Other
<ul>
<li><a href="#known">Known Issues</a></li>
<li><a href="#performance">Bad performance / OutOfMemoryError</a></li>
<li><a href="#livestreamer">Livestreamer won't run properly</a></li>
<li><a href="#font">Some characters in chat only show up as boxes / Fallback fonts</a></li>
<li><a href="#log">Debug log</a></li>
</ul>
</li>
</ul>
<h2>
<a name="known">Known Issues</a>
<a href="#top" class="top">[back to menu]</a>
</h2>
<h3>User Interface</h3>
<ul>
<li>Sometimes users aren't correctly sorted in the userlist</li>
<li>Windows: Dragging the upper edge to maximize the window vertically
doesn't resize the contents of the window. This may be a Java Bug
that I cannot fix. Workaround: Try double-clicking the upper edge
instead of dragging it.</li>
</ul>
<h3>Errors / Crashes</h3>
<ul>
<li>Using the Calibri font can cause random errors, due to a bug in
Java.
(<a href="http://stackoverflow.com/questions/16331075/error-generating-jasperreport-in-development-mode">More information</a>)</li>
<li>Java can crash due to a bug with the graphics driver.
(<a href="http://obsproject.com/forum/threads/chatty.14149/#post-81271">Forum Posts</a>)</li>
</ul>
<p><a href="help-issues.html">Documentation of some issues</a></p>
<h2>
<a name="performance">Bad performance / OutOfMemoryError</a>
<a href="#top" class="top">[back to menu]</a>
</h2>
<p>You may want to check if Irc logging is enabled in the Debug Window
(<code>Extra - Debug window - Checkbox: Irc log</code>), which should
be disabled by default, but can lower performance if checked.</p>
<h2>
<a name="jintellitype">Global hotkeys don't work</a>
<a href="#top" class="top">[back to menu]</a>
</h2>
<p>First of all, you only need Global Hotkey support when you want to use
global hotkeys (which you can define in the settings). If you don't, you
can just ignore any related messages or download the version of Chatty
without Hotkey support. Global hotkeys currently only work on Windows.</p>
<p>If you want to use global hotkeys and you get a message related to them
not working, check the following sections. If you don't get a message,
but the global hotkeys you defined just don't work, make sure you
actually have global hotkeys enabled in the settings.</p>
<h3>Wrong version of Chatty</h3>
<p>If you try to add a global hotkey and it tells you that you have the
wrong version of Chatty, you probably don't have the version supporting
global hotkeys. Download the version that contains <code>hotkey</code>
in the <code>.zip</code> filename and try that instead.</p>
<h3>Could not load library (jintellitype-1.3.8.jar)</h3>
<p>Chatty requires the <code>jintellitype-1.3.8.jar</code> to be in the
<code>lib</code> subfolder of where the <code>Chatty.jar</code> is
located.</p>
<h3>Could not load JIntellitype.dll</h3>
<p>If you get this error, you started Chatty with Hotkey support, but it
couldn't load the library (.dll) necessary to register hotkeys. This can
mean that:
<ul>
<li>You have the wrong version for your version
of Java (32bit or 64bit Java need different versions of the <code>.dll</code>)</li>
<li>The <code>JIntellitype.dll</code> isn't stored where the program can
find it</li>
</ul>
<p>
Find out if you have the 64bit or 32bit version of Java (e.g. by
entering <code>java -version</code> on the commandline to check if there
is 64bit in the response), then check if you downloaded the matching
version of Chatty.</p>
<p>Enter <code>/wdir</code> in Chatty to find out what your working directory
is and make sure the <code>JIntellitype.dll</code> is in there. If you
are starting Chatty via a shortcut, remember that the directory
specified in the <code>Run in</code> field determines your working
directory (on Windows at least, but global hotkeys are currently Windows only
anyway).</p>
<div class="moreInfo">Related information: <a href="help-guide_folders.html">Chatty directories and files</a></div>
<h2>
<a name="livestreamer">Livestreamer won't run properly</a>
<a href="#top" class="top">[back to menu]</a>
</h2>
<p>See the <a href="help-livestreamer.html">Chatty Livestreamer Help</a>.</p>
<h2>
<a name="settings_lost">Settings lost</a>
<a href="#top" class="top">[back to menu]</a>
</h2>
<p>If you loose your settings (or part of it like just the Addressbook) then
either they weren't saved/loaded properly for some reason or you changed
your configuration and your settings directory is not the same anymore.</p>
<ul>
<li>Enter <code>/dir</code> in Chatty to find out what your settings
directory is (<code>/openDir</code> to open it) and whether that's
the one you used before (there should be quite a few files and
folders).</li>
<li>If there is a <code>backup</code> folder you can try to restore the
automatic backup. <a href="help-guide_folders.html#backup">More Information...</a></li>
</ul>
<h2>
<a name="wrong_folders">Wrong image/sounds folder</a>
<a href="#top" class="top">[back to menu]</a>
</h2>
<p>The image/sounds folders are based on the current Working Directory,
which is set when you start Chatty. <a href="help-guide_folders.html#wdir">More Information..</a></p>
<h2>
<a name="login">Can't connect because the login failed</a>
<a href="#top" class="top">[back to menu]</a>
</h2>
<p>If you repeatedly get disconnected because of possibly invalid login
data, please go to <code>Main - Login.. - Verify login</code>.
This will send a request to Twitch to check if the access token is valid.
If the login data is valid, then Twitch may just have temporary problems
and you should try again later. The same goes for when the check itself
fails because it can't reach the Twitch API.</p>
<p>If the login data isn't valid, you can just remove the login and request
new login data. Also see the <a href="help.html#login-invalid">section about login</a>
for more information about invalid logins.</p>
<p>Another reason may be that you are connecting to the <a href="#connect">wrong port</a>.</p>
<h2>
<a name="connect">Can't connect</a>
<a href="#top" class="top">[back to menu]</a>
</h2>
<p>It's possible that your internet/firewall doesn't like the port you are
using to connect. By default it tries to connect to <code>6667</code>
first. Twitch may also have changed the ports. You can check <a href="http://twitchstatus.com">Twitchstatus.com</a>
(not an official Twitch site) which chat server/ports are available (make sure to use an <code>irc</code> server).
The host <code>irc.twitch.tv</code> should resolve to the available server IPs, so you normally
shouldn't have to enter an IP directly (for main chat).</p>
<p>If you are using a shortcut to start Chatty, also check any
custom server/port you may have defined there using <a href="help.html#launch">commandline parameters</a>.</p>
<h2>
<a name="font">Some characters in chat only show up as boxes / Fallback fonts</a>
<a href="#top" class="top">[back to menu]</a>
</h2>
<p>If Java encounters a character that is not contained in the chat font
you currently have configured, it will try to find it in the fallback
fonts. While still not all characters will be displayed this way, it
should work a lot better. If you want to be able to display even more
characters, you can add your own fallback fonts into the Java fallback
font directory: <code>&lt;JRE_INSTALL_DIR&gt;/jre/lib/fonts/fallback</code></p>
<p>On Windows, the JRE would usually be located in
<code>C:\Program Files\Java\</code> or
<code>C:\Program Files (x86)\Java\</code>.</p>
<p><em>Note:</em> If you set the <code>inputFont</code>
<a href="help-setting_commands.html#font">setting</a> to something else
besides a Java logical font, then the font fallback mechanism may break.
This was the case before version 0.7.3.</p>
<h2>
<a name="start">Chatty won't start</a>
<a href="#top" class="top">[back to menu]</a>
</h2>
<p>You need to have at least Java 7 JRE (Java Runtime Environment) installed to run Chatty.</p>
<p>If you try to start Chatty by double-clicking the <code>Chatty.jar</code>,
first make sure that <code>.jar</code> files are associated with Java,
and not some other program like WinRAR. The icon of the <code>Chatty.jar</code>
should have a Java icon (coffee cup). If you right-click the <code>Chatty.jar</code>
you can select the program to open it with under <code>Open with</code>.</p>
<p>If you are sure that the <code>Chatty.jar</code> is actually started with
Java, but no program window appears, it may be that an error occured before
the window (GUI) could be created.</p>
<h3>Check Association of .jar with Java (Windows)</h3>
<p>Open a commandline window and enter <code>assoc .jar</code> which should output
<code>.jar=jarfile</code> and enter <code>ftype jarfile</code> which should
output something like <code>"C:\Program Files\Java\jre7\bin\javaw.exe" -jar "%1" %*</code>
(see also <a href="http://stackoverflow.com/questions/10875839/jar-file-keeps-giving-me-could-not-find-the-main-class-program-will-exit">
Could not find the main class. Program will exit.</a>)</p>
<h3>Run from commandline</h3>
<p>Running Chatty from the commandline has the advantage of being able to
get messages from before the GUI is established. Open a commandline where
the <code>Chatty.jar</code> is located (Win7/8: Hold <kbd>Shift</kbd> while Right-Clicking to open
the context menu, click <code>Open command window here</code>) and enter
<code>java -jar Chatty.jar</code>.</p>
<h3>Error: Java is not recognized as an internal or external command (Windows)</h3>
<p>If you experience this when entering <code>java -jar Chatty.jar</code>
in the commandline, then it probably can't find Java because it's not in the
<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
should point to Java.</p>
<h3>Find errors in debug.log</h3>
<p>See next section. Of course you'll have to navigate to the folder
manually.</p>
<h2>
<a name="log">Debug log</a>
<a href="#top" class="top">[back to menu]</a>
</h2>
<p>If you experience any problems or errors, then there may be helpful
information for debugging in the debug log, which is located in the settings
directory <code>&lt;user_dir&gt;/.chatty/</code> (e.g.
<code>C:\Users\&lt;username&gt;\.chatty\</code>, if you
have Chatty running you can enter <code>/openDir</code> to open it or
<code>/dir</code> to output the path).</p>
<p>In that folder, there are two kinds of debug files:</p>
<ul>
<li>The <code>debug.log</code> which is overwritten everytime you start
Chatty. It may also have a number at the end (like <code>debug.log.1</code>)
if Java couldn't open the usual <code>debug.log</code>.</li>
<li>Several files (<code>debug0.log, debug1.log, ..</code>), whereas
one of them is written to at a time, and then switched to the next when
a certain filesize is reached, rotating between a certain number of files.
Those files are not overwritten when Chatty is started, but instead new data is appended.</li>
</ul>
<p>So to find possibly relevant data:</p>
<ol>
<li>If you haven't started Chatty again after the error occured, check
the <code>debug.log</code> first.</li>
<li>Otherwise check if one of the <code>debug0.log, debug1.log, ..</code>
files could contain the necessary information, based on the last
modification dates.
<ul>
<li>Even if the error is already some time back, it <em>may</em> still
be in there, depending on how much data has been added in the meantime.</li>
</ul></li>
</ol>
<h2>
If you found a bug or have a suggestion..
<a href="#top" class="top">[back to menu]</a>
</h2>
<p><a href="help.html#contact">Contact</a> me please.</p>
</body>
</html>

171
help/0.8.1/help-whisper.html Normal file
View File

@ -0,0 +1,171 @@
<!DOCTYPE html>
<html>
<title>Chatty Help - Whisper Feature</title>
<link rel="stylesheet" type="text/css" href="style.css" />
<body>
<div id="backlink"><a href="help.html">Back to main help page</a></div>
<h1><a name="top">Whisper Feature</a></h1>
<p>
<a href="#start">Getting started</a> |
<a href="#usage">Usage</a> |
<a href="#troubleshooting">Troubleshooting</a>
</p>
<p><em>It is recommended that you read and understand this whole section
before enabling this feature.</em></p>
<p>Chatty implements the new <code>/w</code> command that Twitch Chat
provides, allowing you to send private messages in chat to other users.
However, it is disabled by default, since it has a few problems:</p>
<ul>
<li>Twitch is planning to move Whispering to a whole different system
soon, which means in the current state it is not really encouraged
to be used by third-party applications. It is unclear what the new
system will be and whether it will be possible to implement it in
Chatty. Also, due to these circumstances, not too much development
time will be put into the Whisper feature in Chatty at this time.</li>
<li>Whispering currently runs on the Group Chat servers, so Chatty can't
just use <code>irc.twitch.tv</code> to connect as for regular chat.
Since there is no easy official way to get the server data
automatically, you have enter the IP and port yourself if you want
to use this feature.</li>
</ul>
<h2><a name="start">Getting started</a></h2>
<p>You have to change a few settings in order to use this feature
(all under <code>Main - Settings - Advanced</code>):</p>
<h3>Required settings</h3>
<ul>
<li><strong>Whisper Enabled</strong>: Connect to the given Group Chat
server to send and receive whispers. Enable when you configured the
server. Disable this it if you run into problems.</li>
<li><strong>Server/Port</strong>: You can click on
<code>Select server..</code> and select a server from the list (all
listed <em>should</em> work). This is using an unsupported Twitch
API which is not guaranteed to stay the same.</li>
</ul>
<p>Once these settings are correctly configured, Chatty will connect to
Whispers when you connect to regular chat. It will disconnect when you
disconnect from regular chat via the Main-menu. If the Whisper Feature
is properly connected and ready to use, <code>[W]</code> will be shown
in the titlebar and the <code>/connection</code> command will show the
Whisper connection in addition to the regular chat connection.</p>
<p>If you were already connected when you changed these settings, either
disconnect and connect again (via the Main menu) or restart Chatty.</p>
<p>If <code>Select server..</code> is not working, configure the server manually:</p>
<ul>
<li><strong>Server</strong>: The Group Chat server IP to connect to. You can check:
<ul>
<li><a href="http://twitchstatus.com/">Twitchstatus.com</a> (unofficial site) at the bottom of the page,
"Group Chat" tab, "irc" Protocol (not "ws_irc")</li>
<li>Get an IP from the Twitch API using <a href="http://blog.bashtech.net/twitch-group-chat-irc/">this guide</a>
(you will need a token and be member of a Group Chat, you won't need to get a channelname)</li>
</ul></li>
<li><strong>Port</strong>: The port for the Group Chat server you
are using (you should get it along with the IP).</li>
</ul>
<h3>Optional settings</h3>
<ul>
<li><strong>Whitelist</strong>: If enabled, only users that have the
<a href="help-addressbook.html">Addressbook</a> category
<code>whisper</code> will be able to send whispers to you.
Messages from other users are discarded. Alternatively you can
also <strong>blacklist</strong> users by adding them to the
<code>blockwhisper</code> category (which makes most sense with
the Whitelist setting disabled).<br /><br >
In addition, you can also add users to the Ignore List by
right-clicking on them in chat to open the context menu and
choosing <code>Miscellaneous - Ignore (whisper)</code>. Unlike
the Blacklist or Whitelist using the Addressbook, this will not
completely discard the messages, but instead add them to the
Ignored Messages dialog and possibly output some other messages
about it, depending on the Ignore settings.</li>
<li><strong>Display</strong>: Changes where the whispers are
displayed.
<ul>
<li><strong>Active Chat</strong> - Show in the chat window
you are currently having active in Chatty.</li>
<li><strong>One Window</strong> - Show all whispers in one
separate window. In that window you will be able to
respond to whispers by just typing <code>&lt;name&gt;
&lt;message&gt;</code> instead of having to use the
<code>/w</code> command. To be sure you actually provide
the user to send it to you can only whisper to users
that have already whispered to you (so e.g.
<code>Hey how are you? :)</code> wont't be send to the
user named <code>Hey</code>). The tab for collecting all
whispers is named <code>$[whisper]</code>.</li>
<li><strong>Per User</strong> - Open an extra tab for every
user that whispers to you. You can respond to whispers
by just typing the message in the tab for that user. The
tab will be named <code>$&lt;username&gt;</code>.</li>
</ul>
</li>
</ul>
<h2><a name="usage">Usage</a></h2>
<p>When the Whisper Feature is connected (<code>[W]</code> appears in the
titlebar) you can receive and send whispers:</p>
<ul>
<li>When you receive a whisper, it will be displayed depending on the
Display setting and will be indicated by the nickname being marked
like this: <code>-[name]-</code></li>
<li>When you send a whisper via
<code>/w &lt;name&gt; &lt;message&gt;</code>, then this will be
indicated in chat by the nickname being marked like this:
<code>&gt;&gt;[name]</code></li>
<li>In both cases the name is the name of the person you are talking
with, not your own name.</li>
<li>When you click on the name, you will be able to see your
conversation, with your own messages marked with a asterisk in front
(*), which is usually used to mark action messages
(<code>/me</code>).</li>
</ul>
<h2><a name="troubleshooting">Troubleshooting</a></h2>
<p>If you get a lot of errors like <code>Whisper feature: Disconnected</code> this
may be due to different reasons:</p>
<ul>
<li>A temporary problem with Twitch or your internet connection, in which
case just wait a while.</li>
<li>Wrong server/port entered, follow the <a href="#start">Getting Started</a>
guide to check if the data you entered is still correct.</li>
<li>Twitch changed the system and it is not working as implemented in Chatty
anymore (in which case you should disable the feature).</li>
</ul>
<p>How to proceed:</p>
<ul>
<li>Check <a href="http://twitchstatus.com">Twitchstatus.com</a> (mainly Group Chat Tab),
<a href="https://twitter.com/chattyclient">@ChattyClient</a> and
other usual places to find out if the problem lies with Twitch.
Disable the Whisper Feature if necessary.</li>
<li>If the <code>[W]</code> in the titlebar isn't there, but it also
doesn't output errors anymore, it may have given up trying to connect,
in which case you should connect to regular chat through the <code>Main</code>
menu (disconnect first if necessary). Connecting to whispers is
currently somewhat tied to connecting to regular chat. Disconnecting
from regular chat from the <code>Main</code> menu will also disconnect
from whispers.</li>
</ul>
</body>
</html>

1230
help/0.8.1/help.html Normal file
View File

File diff suppressed because it is too large Load Diff

BIN
help/0.8.1/jconsole.jpg Normal file
View File

Binary file not shown.
Side by Side

After

Width:  |  Height:  |  Size: 19 KiB

130
help/0.8.1/style.css Normal file
View File

@ -0,0 +1,130 @@
body {
max-width: 700px;
font-size: 1em;
background-color: #FDFDFD;
font-family: Arial, sans-serif;
padding: 10px;
margin: 0;
}
h1 {
margin: 4px 0 5px 0;
font-size: 1.2em;
background-color: #EEEEEE;
padding: 3px;
border-bottom: 1px solid #AAAAAA;
}
h2 {
margin: 14px 0 0 0;
font-size: 1.1em;
border-bottom: 1px solid #AAAAAA;
padding-bottom: 2px;
}
h3 {
font-size: 1em;
margin: 10px 0 0 0;
padding: 0;
}
li ul {
margin-top:1px;
margin-bottom:3px;
}
li {
font-size: 1em;
margin-top: 2px;
}
.sub {
list-style-type: none;
margin-top: 0;
}
.top {
font-size: 0.75em;
}
code {
background-color: #EEEEEE;
}
cite {
background-color: #EEEEEE;
}
#backlink {
margin: 0 0 10px 0;
}
td {
padding: 10px;
}
table.settings {
border-collapse: collapse;
margin-top: 10px;
}
table.settings td {
padding: 3px;
margin: 0;
border: 1px solid #DDDDDD;
}
table.settings th {
padding: 0;
margin: 0;
border-bottom: 1px solid #000;
}
.setting {
font-family: monospace;
}
.settingExclusive {
background-color: #EEEEEE;
}
.settingNoCommandEdit {
color: #999999;
}
table.versionCompareTable {
border-collapse: collapse;
}
.versionCompareTable td {
padding: 2px;
margin: 0;
}
table.loginlinks {
border-collapse: collapse;
}
.loginlinks td {
padding: 2px;
border: 1px solid #DDDDDD;
text-align: center;
}
.loginlinks th {
padding: 2px;
}
table.files {
border-collapse: collapse;
margin-top: 10px;
}
.files td {
padding: 2px;
border: none;
text-align: left;
vertical-align: top;
}
.moreInfo {
padding: 7px;
font-style: italic;
}
.moreInfo a {
font-weight: bold;
font-style: normal;
}
.paragraphs dd {
padding-bottom: 4px;
/* padding: 0 0 0 16px;
background-image: url(go-next.png);
background-repeat: no-repeat;*/
}
.defList {
margin-left: 20px;
}
.defList dt {
margin-top: 5px;
}

BIN
help/0.8.1/userdialog.jpg Normal file
View File

Binary file not shown.
Side by Side

After

Width:  |  Height:  |  Size: 20 KiB

BIN
help/0.8.1/viewerhistory_small.gif Normal file
View File

Binary file not shown.
Side by Side

After

Width:  |  Height:  |  Size: 12 KiB

2
help/help-addressbook.html
View File

@ -149,6 +149,8 @@ set testi ignore</pre>
use the <code>/abImport</code> command to manually read the file once after
start. If you only change the file while Chatty is running, manually reading
the file should not be necessary.</p>
<p>Example: <a href="http://pastebin.com/LDFpEUaC">mIRC script</a> to edit the Addressbook.</p>
</body>
</html>

3
help/help-getting-started.html
View File

@ -76,6 +76,9 @@
buttons as well as the recent messages of that user, so you can quickly check
if you are actually timing out the correct user.</p>
<p>Also check out the options to <a href="help.html#pausechat">pause chat</a>
and timing out users via <a href="help.html#userselection">shortcuts only</a>.</p>
<p><img src="userdialog.jpg" alt="User Dialog with moderation buttons" /></p>
<h2>Information about the current stream</h2>

272
help/help-guide_folders.html
View File

@ -2,117 +2,167 @@
<html>
<title>Chatty Help</title>
<link rel="stylesheet" type="text/css" href="style.css" />
<style type="text/css">
.fileComment {
color: gray;
}
.fileCommentFolder {
}
.filesT {
font-family: Monospace;
margin: 10px 0 14px 0;
}
.filesT td {
margin: 0;
padding: 0;
padding-right: 5px;
padding-top: 2px;
}
</style>
<body>
<div id="backlink"><a href="help.html">Back to main help page</a></div>
<h1><a name="top">Guide: Chatty directories and files</a></h1>
<p>
<a href="#directories">Directories</a> |
<a href="#files">Files</a> |
<a href="#files">Files/Directory structure</a> |
<a href="#backup">Backup</a>
</p>
<p>Learn what directories and files Chatty creates/uses.</p>
<h2><a name="directories">Directories</a></h2>
<h2><a name="files">Files/Directory structure</a></h2>
<h3>Settings Directory</h3>
<p>The settings directory by default is in your user home directory in a
<p>The settings directory by default is in your user home directory in a
subfolder called <code>.chatty</code>. If you use the <code>-cd</code>
commandline parameter, then the settings directory is the current Working
Directory.</p>
<p>You can use commandline parameters by creating a shortcut and setting the
<p>You can use commandline parameters by <a href="help-guide_create_shortcut.html">creating a shortcut</a> and setting the
target to something like <code>javaw.exe -jar "D:\Chatty\Chatty.jar" -cd</code>.</p>
<h3>Working Directory</h3>
<p>Use the command <code>/dir</code> to display and <code>/openDir</code> to
open the Settings Directory.</p>
<table class="filesT">
<tr>
<td>&lt;settings directory&gt;</td>
<td></td>
</tr>
<tr>
<td>|-- backup</td>
<td class="fileCommentFolder">[Folder]</td>
</tr>
<tr>
<td>|&nbsp; &nbsp;|-- backup_x_&lt;filename&gt;</td>
<td class="fileComment">Setting backups</td>
</tr>
<tr>
<td>|&nbsp; &nbsp;|-- backup_meta</td>
<td class="fileComment">Backups meta (last backup, numbering)</td>
</tr>
<tr>
<td>|-- cache</td>
<td class="fileCommentFolder">[Folder]</td>
</tr>
<tr>
<td>|&nbsp; &nbsp;|-- &lt;various cache files&gt;</td>
<td class="fileComment">Cached emotes/image files</td>
</tr>
<tr>
<td>|-- exported</td>
<td class="fileCommentFolder">[Folder] Files intended to be read
by the user</td>
</tr>
<tr>
<td>|&nbsp; &nbsp;|-- stream_highlights.txt</td>
<td class="fileComment">Recorded stream highlights</td>
</tr>
<tr>
<td>|-- logs</td>
<td class="fileCommentFolder">[Folder]</td>
</tr>
<tr>
<td>|&nbsp; &nbsp;|-- &lt;channel&gt;.log</td>
<td class="fileComment">Chat log files</td>
</tr>
<tr>
<td>|-- addressbook</td>
<td class="fileComment">[Settings] Addressbook entries</td>
</tr>
<tr>
<td>|-- login</td>
<td class="fileComment">[Settings] Your login data (keep this secure)</td>
</tr>
<tr>
<td>|-- favoritesAndHistory</td>
<td class="fileComment">[Settings] Channel History/Favorites</td>
</tr>
<tr>
<td>|-- settings</td>
<td class="fileComment">[Settings] Main Settings File</td>
</tr>
<tr>
<td>|-- statusPresets</td>
<td class="fileComment">[Settings] Stream Title/Game presets (Admin Dialog)</td>
</tr>
<tr>
<td>|-- debug_session.log.x</td>
<td class="fileComment">Last session debug log (overwritten every run)</td>
</tr>
<tr>
<td>|-- debugx.log.x</td>
<td class="fileComment">Rotating debug log</td>
</tr>
<tr>
<td>|-- debug_ircx.log.x</td>
<td class="fileComment">Rotating raw IRC log (only if enabled)</td>
</tr>
</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>.</p>
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>Use the command <code>/wdir</code> to display and <code>/openWdir</code>
to open the Working Directory.</p>
<table class="filesT">
<tr>
<td>&lt;working directory&gt;</td>
<td></td>
</tr>
<tr>
<td>|-- sounds</td>
<td class="fileCommentFolder">[Folder] Sound files</td>
</tr>
<tr>
<td>|&nbsp; &nbsp;|-- &lt;sound&gt;.wav</td>
<td class="fileComment">.wav files</td>
</tr>
<tr>
<td>|-- img</td>
<td class="fileCommentFolder">[Folder] Image files for custom usericons</td>
</tr>
<tr>
<td>|&nbsp;&nbsp;&nbsp;|--&nbsp;&lt;various&nbsp;images&gt;</td>
<td class="fileComment">.png files</td>
</tr>
<tr>
<td>|-- JIntellitype.dll</td>
<td class="fileComment">DLL for global hotkey support</td>
</tr>
</table>
<h3>JAR Location</h3>
<p>This is where the Chatty.jar is located and is used for loading libraries
that Chatty uses.</p>
<h3>Displaying Directories in Chatty</h3>
<p>You can use the <code>/dir</code> command in Chatty to output the settings
directory and the <code>/wdir</code> command for the working directory
(<code>/openDir</code> and <code>/openWdir</code> to open them in the standard filebrowser).
You can also check the settings dialog for the directory where the logs
are saved in and the directory where the sounds are loaded from.</p>
<h2><a name="files">Files</a></h2>
<h3>Write and read</h3>
<p>There are several files that Chatty creates/changes when you run/close it.</p>
<table class="files">
<tr>
<th>Type</th>
<th>Location</th>
<th>Files</th>
<th></th>
</tr>
<tr>
<td>Settings</td>
<td>&lt;settings&gt;</td>
<td>login, favoritesAndHistory, settings</td>
<td><a href="help.html#settingFiles">Setting Files</a></td>
</tr>
<tr>
<td>Debug Log</td>
<td>&lt;settings&gt;</td>
<td>debug.log, debug.log.x</td>
<td>Contains debug information from the last run</td>
</tr>
<tr>
<td>Chatlogs</td>
<td>&lt;settings&gt;/logs</td>
<td>&lt;channel&gt;.log</td>
<td>Chatlogs for every channel (if enabled)</td>
</tr>
<tr>
<td>Emoticons</td>
<td>&lt;settings&gt;</td>
<td>emoticons, emotesets, bttvemotes</td>
<td>Cached list of emoticons, emotesets, BTTV emotes (Cached for about one day)</td>
</tr>
<tr>
<td>Addressbook</td>
<td>&lt;settings&gt;</td>
<td>addressbook</td>
<td>List of names and associated categories</td>
</tr>
<tr>
<td>Backups</td>
<td>&lt;settings&gt;/logs</td>
<td>backup_&lt;number&gt;_&lt;orig_filename&gt;</td>
</tr>
</table>
<h3>Read-only</h3>
<p>Files that Chatty only reads but doesn't modify.</p>
<table class="files">
<tr>
<th>Type</th>
<th>Location</th>
<th>Files</th>
<th></th>
</tr>
<tr>
<td>Sounds</td>
<td>&lt;working&gt;/sounds</td>
<td>.wav files</td>
<td>Chatty loads the sounds from here</td>
</tr>
<tr>
<td>Images</td>
<td>&lt;working&gt;/img</td>
<td>.png files</td>
<td>Default location where images for custom usericons are loaded
from</td>
</tr>
<tr>
<td>JIntellitype</td>
<td>&lt;working&gt;</td>
<td>JIntellitype.dll</td>
<td>If you have a version of Chatty with Hotkey support</td>
</tr>
</table>
<h2><a name="backup">Backup</a></h2>
<p>Chatty performs an automatic backup (enabled by default) everytime it is
started (if at least the number of days as defined in the settings have passed,
@ -130,6 +180,46 @@
<p><em>If some settings are important to you this can help, but you
shouldn't rely on it. Always make your own backups, best on a
different device!</em></p>
<h3>Restore backup</h3>
<p>If you lost your setting files (or some of them) but still have
a backup, you can manually copy the backup to restore it.</p>
<ol>
<li>Prepare & Locate Backup Folder
<ul>
<li>Make sure Chatty is not running. Settings are saved when
Chatty is closed, so if you change setting files manually
while it is running your manual changes would just be
overwritten once you close Chatty.</li>
<li>Enter <code>/openBackupDir</code> to open the Backup folder
(or enter <code>/dir</code> and navigate to the Backup folder
manually).</li>
<li>There should be several files in the format <code>backup_x_&lt;name&gt;</code>,
these represent the separate batches of backups.</li>
</ul>
</li>
<li>Find latest backup and rename
<ul>
<li>Sort the files by modification date in your file browser and
choose the latest batch that seems like it might work (e.g.
files that are not 0KB, although the addressbook might be if
you never used it).</li>
<li>Rename the files you want to restore from <code>backup_x_&lt;name&gt;</code>
to <code>&lt;name&gt;</code> (for example <code>backup_2_settings</code>
to <code>settings</code>). You can ignore the <code>backup_meta</code> file.</li>
</ul>
</li>
<li>Move renamed files
<ul>
<li>Copy or move the renamed files to the parent folder (the one
you get from <code>/dir</code> or <code>/openDir</code> commands),
overwriting any existing setting files.</li>
</ul>
</li>
<li>After you are done, start Chatty again and the settings
should be restored.</li>
</ol>
</body>
</html>

47
help/help-memory_usage.html Normal file
View File

@ -0,0 +1,47 @@
<!DOCTYPE html>
<html>
<title>Chatty Help</title>
<link rel="stylesheet" type="text/css" href="style.css" />
<body>
<div id="backlink"><a href="help.html">Back to main help page</a></div>
<h1><a name="top">Memory Usage</a></h1>
<p>
<a href="#restrict">Restrict Memory Usage</a> |
<a href="#error">OutOfMemoryError</a>
</p>
<p>The programs memory is managed by Java, which means Java allocates a
certain amount of memory which is then filled up with data of the program
and once Java decides so, it cleans up data that is not used anymore
(Garbage Collection). This leads to the actual memory usage going up and
down constantly, while the allocated memory mostly stays the same. So
even if only 50 MB are filled with data by the program <em>at the time</em>, Java may
still have 200 MB reserved to optimize Gargabe Collection. Thus, the memory usage in e.g. the Task Manager
may not reflect what the program actually <em>requires</em>, just how
much Java uses.</p>
<p>Use the <code>/appinfo</code> command in Chatty to get some information
about the current memory usage.</p>
<p>A typical memory usage pattern, which can change over time as the program
is running while Java optimizes Gargabe Collection:<br />
<img src="jconsole.jpg" alt="Typical memory usage pattern" /></p>
<h2><a name="restrict">Restrict Memory Usage</a></h2>
<p>You can <a href="http://stackoverflow.com/questions/1493913/how-to-set-the-maximum-memory-usage-for-jvm">restrict</a> how much memory Java is allowed to use by specifying
commandline parameters for Java. <a href="help-guide_create_shortcut.html">Create a shortcut</a>
and add the appropriate parameter after the <code>javaw.exe</code> but
before the <code>-jar</code> parameter.</p>
<p>For example to restrict memory to 100 MB: <code>javaw -Xmx100M -jar "D:\Chatty\Chatty.jar"</code></p>
<h2><a name="error">OutOfMemoryError</a></h2>
<p>If you get an OutOfMemoryError then Java ran out of memory. This can
either be because it simply can't allocate enough memory (at least 100 MB is recommended)
or there is a bug that prevents it from cleaning up memory that is not
actually used anymore. These kinds of bugs are pretty difficult to track
down though, especially if they only occur somewhat randomly.</p>
</body>
</html>

112
help/help-releases.html
View File

@ -39,44 +39,112 @@
full list of changes.</p>
<h2>
<a name="0.8.1">Version 0.8.1</a> <a name="latest">(This one!)</a> (2015-06-??)
<a name="0.8.1">Version 0.8.1</a> <a name="latest">(This one!)</a> (2015-08-10)
<a href="#top" class="top">[back to top]</a>
</h2>
<h3>Important Information</h3>
<h3>Highlights / Important Information</h3>
<ul>
<li>If you want to use the <code>/w</code> (whisper) command and receive whispers in Chatty, read the
<a href="help.html#whisper">Help</a>.</li>
<a href="help-whisper.html">Whisper Help</a> (some configuration required).</li>
<li>Added feature to <a href="help.html#pausechat">pause scrolling</a> when moving the mouse over chat
(you have to enable it in the settings under <code>Chat</code>).</li>
<li>Added Tabs drag and drop reordering, more menu options for closing and more.</li>
<li>Readded FFZ Feature Friday support and improved it.</li>
<li>Show more stream and channel state information (like slowmode, submode, etc.).</li>
</ul>
<h3>Full Changelog</h3>
<pre>
New features:
- Added experimental Whisper support (this will probably not developed much
until Twitch moves Whispers to the new system)
#### New features
- Added experimental Whisper support (this will probably not be developed much
until Twitch moves Whispers to the new system, read help on how to enable)
- Improved TAB Completion: Added predictive sorting for names which gives users
who recently talked/highlighted you a higher priority, added setting to
toggle completion to common prefix (disabled by default)
- Added $first option for Custom Usericon restriction to show them in front of
the regular Usericons
- Added dedicated ignore user lists (separate for chat and whispers)
Changes:
- Show long slowmode times as "> day" in the titlebar
- Added "Open in online help" button in Help window
- Allow global FFZ/BTTV to be added to the favorites as well
- Added $globalmod and $anymod status identifiers for Usericons/Usercolors
- Show indication of action message (/me) in User Info Dialog chat history and
log files (star in front of the message)
- Updated help
#### Chat Window
- Added Pause Chat when moving mouse over chat feature (enable in the settings)
- Changed Ctrl to be used to pause chat, use AltGr for selecting when clicking
on a username in chat
- Don't scroll down when scrolled up even when scroll down timeout has passed
while holding Ctrl
- Added one-click moderation when holding Ctrl (configure in the Chat settings)
#### Tabs
- Added manual resorting of tabs by drag and drop
- Added more menu entries to close tabs to Tab Context Menu
- Rejoin channels in the order the tabs were, when rejoining channels from last
session on start (depends on the Tab Order setting of course)
- Switch to tab when right-clicking on it (which wasn't the case everywhere)
- Optional mouse wheel scrolling through tabs (enable in the settings)
#### Emoticons
- Added FFZ Feature Friday again and improved support for it in Emotes Dialog
- Improved Emote Context Menu (open twitchemotes.com for Twitch emotes id,
added channel submenu for more emotes where it makes sense)
- Added setting to toggle animated emotes (BTTV GIF emotes)
- Allow global FFZ/BTTV emotes to be added to the favorites as well
- Don't show 150% size in Emotes Dialog Detail View when emote is too wide
- Sort Channel Subscriber Emotes alphabetically
#### Chat/Stream Info Display
- Improved display for long slowmode times in the titlebar
- Implemented new ROOMSTATE command, allowing for accurate display of
submode/slowmode/r9k in titlebar
- Added stream uptime to the titlebar, added settings to customize what is shown
in the titlebar a bit more (`View - Options - Titlebar`)
- Added stream uptime to Live Streams Dialog
#### Settings / Configuration
- Added timestamp option to "Log to file" settings (previously only changeable
with setting commands)
- Highlight/Ignore: Allow non-standard channels in chan:/!chan: prefixes
- Added Copy Stream Name to Channel Context Menu (Miscellaneous submenu)
- Highlight/Ignore: Allow non-standard channels in `chan:`/`!chan:` prefixes
- Added setting for minimum userlist width
- Switched default ports to `6667,443` due to port 80 not being available
anymore for standard IRC
- Increased default chat buffer size
- Updated Settings Dialog
- Added `$globalmod` and `$anymod` status identifiers for Usericons/Usercolors
- Added `$first` option for Custom Usericon restriction to show them in front of
the regular Usericons
- Added setting for filtering of combining characters to change between off,
lenient and strict replacing (filter can circumvent performance issues)
Bugfixes:
#### Commands / Menus
- Added Copy Stream Name to Channel Context Menu (Miscellaneous submenu)
- Added hotkey action to close all/all shown notifications
- Added /openBackupDir command
- Added entries to the `Extra` menu to record/open Stream Highlights
- Added "Open speedrun.com" Channel Context Menu entry in Miscellaneous submenu
(which tries to open the leaderboards page for the current game)
#### Other Changes
- Added "Open in online help" button in Help window
- Show indication of action message (/me) in User Info Dialog chat history and
log files (star in front of the message)
- Apply bans/timeouts to Stream Chat
- Changed website URL to GitHub
- Improved debug output a bit, renamed current session debug log file
- Keep showing "Update Available" notification after restart
- Removed condition to use maximum reconnection delay when host could not be
resolved
- Updated help
#### Bugfixes
- Fixed error in slowmode message parsing
- Changed Ignore option config:info to only apply to info messages, not regular
chat messages
- Changed Ignore option `config:info` to only apply to info messages, not
regular chat messages
- Fixed tab not showing new message if message was highlighted with
config:!notify option
`config:!notify` option
- Fixed message parsing from inadvertently ignoring some (rare) messages
- Fixed raw message parsing
- Fixed replacing of all linebreak characters when sending message
- Fixed wrong channel being cleared when "Clear chat when cleared by a
moderator" setting is enabled
- Fixed hotkey bug when opening/closing hotkey settings with global hotkeys
disabled
- Fixed off-by-one error for reconnection attempts
- Fixed sounds on Linux (hopefully)
</pre>
<h2>

113
help/help-setting_commands.html
View File

@ -16,20 +16,22 @@
<a href="#top" class="top">[back to menu]</a>
</h2>
<ul>
<li><code>/set &lt;setting&gt; &lt;value&gt;</code>
changes a setting</li>
<li><code>/get &lt;setting&gt;</code> shows the current value
of a setting</li>
<li><code>/reset &lt;setting&gt;</code> resets the setting to
the default (hard-coded) value</li>
<li><code>/clearsetting &lt;setting&gt;</code> sets
string settings to an empty string</li>
<li><code>/add &lt;setting&gt; &lt;value&gt;</code> adds a string to a
list of strings</li>
<li><code>/remove &lt;setting&gt; &lt;value&gt;</code> removes a string from a
list of strings</li>
<li><code>/set &lt;setting&gt; &lt;value&gt;</code> changes a setting</li>
<li><code>/get &lt;setting&gt;</code> shows the current value of a
setting</li>
<li><code>/reset &lt;setting&gt;</code> resets the setting to the
default (hard-coded) value</li>
<li><code>/clearsetting &lt;setting&gt;</code> sets string settings to
an empty string</li>
<li><code>/add &lt;setting&gt; &lt;value&gt;</code> adds item to a list
of strings/numbers</li>
<li><code>/remove &lt;setting&gt; &lt;value&gt;</code> removes item from
a list of strings/numbers</li>
</ul>
<p><em>Tip:</em> You can use <a href="help.html#nickCompletion">TAB Completion</a>
for setting names when using it behind a setting command.</p>
<h2>
<a name="settings">Settings</a>
<a href="#top" class="top">[back to menu]</a>
@ -44,12 +46,17 @@
<p>Settings with a <span class="settingExclusive">slightly darker background color</span>
are settings that are not available in the Settings Dialog and can only be
changed via commands (and sometimes also commandline options).</p>
changed via commands (and sometimes also commandline options). Settings with
a <span class="settingNoCommandEdit">lighter color</span> can't (or are not recommended to) be changed
via setting commands, but are added to the list because their value can be
viewed with <code>/get</code>.</p>
<p>
<a href="#font">Font</a> |
<a href="#time">Time</a> |
<a href="#server">Server/Connection</a> |
<a href="#chat">Chat</a> |
<a href="#window">Window</a> |
<a href="#streamchat">Stream Chat</a> |
<a href="#streamhighlights">Stream Highlights</a> |
<a href="#debugging">Debugging</a> |
@ -114,13 +121,6 @@
<td colspan="2"><em>Cannot be edited by command</em></td>
<td>The hotkeys that are currently defined</td>
</tr>
<tr class="settingNoCommandEdit">
<td class="setting">windows</td>
<td>Map</td>
<td colspan="2"><em>Cannot be edited by command</em></td>
<td>The windows/dialogs positions/sizes as they where loaded
when you started Chatty (NOT necessarily the current ones).</td>
</tr>
<tr>
<td class="setting">globalHotkeysEnabled</td>
<td colspan="2">Boolean</td>
@ -315,6 +315,79 @@
</tr>
</table>
<h3><a name="chat">Chat</a></h3>
<table class="settings">
<tr style="border-bottom: 1px solid #EEE">
<th>Setting</th>
<th>Type</th>
<th>Values</th>
<th>Default</th>
<th>Description</th>
</tr>
<tr>
<td class="setting">pauseChatOnMouseMove</td>
<td colspan="2">Boolean</td>
<td>false</td>
<td>Enables the <a href="help.html#pausechat">Pause Chat</a>
feature</td>
</tr>
<tr>
<td class="setting">pauseChatOnMouseMoveCtrlRequired</td>
<td colspan="2">Boolean</td>
<td>false</td>
<td>Require <kbd>Ctrl</kbd> to be pressed to start pausing
chat</td>
</tr>
<tr>
<td class="setting">commandOnCtrlClick</td>
<td>String</td>
<td>Command to run (only the command name)</td>
<td><em>empty</em></td>
<td>The command to run when clicking on a user while holding
<kbd>Ctrl</kbd></td>
</tr>
</table>
<h3><a name="window">Window</a></h3>
<table class="settings">
<tr style="border-bottom: 1px solid #EEE">
<th>Setting</th>
<th>Type</th>
<th>Values</th>
<th>Default</th>
<th>Description</th>
</tr>
<tr class="settingNoCommandEdit">
<td class="setting">windows</td>
<td>Map</td>
<td colspan="2"><em>Cannot be edited by command</em></td>
<td>The windows/dialogs positions/sizes as they where loaded
when you started Chatty (NOT necessarily the current ones).</td>
</tr>
<tr>
<td class="setting">tabOrder</td>
<td>String</td>
<td><code>normal</code>, <code>alphabetical</code></td>
<td>normal</td>
<td>How tabs are added (in the order they are added or
alphabetical).</td>
</tr>
<tr>
<td class="setting">tabsMwheelScrolling</td>
<td colspan="2">Boolean</td>
<td>false</td>
<td>Scroll through tabs with mousewheel.</td>
</tr>
<tr>
<td class="setting">tabsMwheelScrollingAnywhere</td>
<td colspan="2">Boolean</td>
<td>false</td>
<td>Allow scrolling through tabs with mousewheel everywhere
on the tabpane where nothing else can be scrolled (mainly
the inputbox).</td>
</tr>
</table>
<h3><a name="streamchat">Stream Chat</a></h3>
<table class="settings">
<tr style="border-bottom: 1px solid #EEE">

119
help/help-settings.html
View File

@ -7,6 +7,7 @@
<h1><a name="top">Settings</a></h1>
<p><a href="#Main">Main</a>
| <a href="#Messages">Messages</a>
| <a href="#Chat">Chat</a>
| <a href="#Emoticons">Emoticons</a>
| <a href="#Usericons">Usericons</a>
| <a href="#Usercolors">Usercolors</a>
@ -94,9 +95,9 @@
moderator badge). These messages can be sometimes
be kind of broken (on Twitch's side) and can show some or all mods in the channel
as being modded/unmodded.</li>
<li><strong>Show joins/parts (TC1 only)</strong>: Show joins/parts, which
only works on TC1 (<a href="#Advanced-TC">more information</a>). Joins/parts
are always kind of delayed, so don't take them too seriously.</li>
<li><strong>Show joins/parts</strong>: Show joins/parts, which
are always kind of delayed, so don't take them too seriously (only works
when <code>Advanced - Correct Userlist</code> is enabled).</li>
<li><strong>Show stream status in chat</strong> outputs the stream status
(title and game) in the chat window on join and when it changes
(when the stream goes offline or online or changes the title or game).</li>
@ -140,6 +141,55 @@
The names in the userlist will not be correctly capitalized until Chatty has
received a message from that user during this session.</em></p>
<h2>
<a name="Chat">Chat</a>
<a href="#top" class="top">[back to menu]</a>
</h2>
<h3>Chat Settings</h3>
<ul>
<li><strong>Scroll down after <code>&lt;x&gt;</code> seconds of inactivity</strong>: If you scrolled
up in chat but haven't moved scrollposition in the given number of seconds, it will scroll down
if new messages come in. This prevents new messages from being hidden
indefinitely if you accidently stayed scrolled up.</li>
<li><strong>Chat buffer size</strong>: How many lines of text are kept
for each channel in chat to scroll back to.</li>
</ul>
<h3>Pause Chat</h3>
<p>The Pause Chat feature stops Chatty from scrolling down when you move the
mouse over chat. This can be useful if you want to click specific stuff
in a fast moving chat, for example if you are moderating or just want to
click on an emote to see what it is.</p>
<p><em>Please note:</em> This will not work properly until the chat window is filled with
text, because only then will Chatty actively scroll down. Also, this
only stops Chatty from actively scrolling down, so if e.g. a big message
is being timed out and thus shortened, stuff may still move around accordingly
(which in that case couldn't really be prevented anyway).</p>
<p>Chat is paused as long as you move the mouse over chat or if you hold
<kbd>Ctrl</kbd> (and initiated pausing by moving the mouse). A little
popup in the top-right will indicate that the chat is paused.</p>
<p>Holding <kbd>Ctrl</kbd> basicially acts as if you moved the mouse
continuously.</p>
<ul>
<li><strong>Pause chat when moving the mouse over it:</strong> Enables
this feature.</li>
<li><strong>Require Ctrl being pressed to start pausing chat:</strong>
If this is enabled, you need to have <kbd>Ctrl</kbd> pressed to
start pausing chat when moving the mouse over it. Once it's paused,
you can let go of <kbd>Ctrl</kbd> and it will stay paused as long as
you move the mouse (or hold <kbd>Ctrl</kbd> again to keep it paused
even when not moving the mouse, as usual).</li>
<li><strong>Run command when clicking on user (holding Ctrl):</strong>
When you select a command here, then clicking on a user in chat
while holding <kbd>Ctrl</kbd> will run the command on that user. You
can <a href="help-setting_commands.html#chat">manually edit</a> this
setting to use another command.</li>
</ul>
<h2>
<a name="Emoticons">Emoticons</a>
<a href="#top" class="top">[back to menu]</a>
@ -155,6 +205,7 @@
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>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>
@ -479,11 +530,17 @@
<a name="Ignore">Ignore</a>
<a href="#top" class="top">[back to menu]</a>
</h2>
<p>Ignores chat messages, either because they match the specified text or -
using prefix - other properties like which user wrote the message. Ignored
messages get added to a special dialog that can be opened via <code>View - Ignored</code>.</p>
<p>Allows you to ignore chat messages that match the specified text or -
using prefixes - that match other properties like ignoring messages of a
specific user. Ignored messages get added to a special dialog that can
be opened via <code>View - Ignored</code>.
</p>
<p>The matching of messages works the same as the <a href="#Highlight">Highlights</a>
system, please see that help for information on that. For quick reference here just a few examples:</p>
system, please see that help for information on that. For quick
reference here just a few examples:
</p>
<dl>
<dt><code>user:name</code></dt>
<dd>Ignores the user with the name <code>name</code> in all channels</dd>
@ -532,6 +589,15 @@
when the ignored messages dialog isn't currently open.</li>
</ul>
<p>The <code>Ignored Users</code> list allows you to ignore
users in chat or prevent them from whispering you, which is possible via
the main ignore list as well, but was added as a separate function to be
more convenient. Aside from the settings, you can also ignore/unignore
users via the User Context Menu.</p>
<p>Ignored users are independant of the main ignore list, so they also apply
if ignore is disabled.</p>
<h2>
<a name="Sounds">Sounds</a>
<a href="#top" class="top">[back to menu]</a>
@ -720,8 +786,12 @@
context menu.</li>
<li><strong>Tab Order</strong>: Whether to show tabs in the order they
were opened or alphabetically.</li>
<li><strong>Scroll through tabs with mousewheel</strong>: Hover mouse
over tabs and scroll to change tabs.</li>
<li><strong>Default Userlist Width</strong>: The default width of the
userlist in pixels.</li>
<li><strong>Min. Width</strong>: The minimum width of the userlist in
pixels.</li>
</ul>
@ -905,12 +975,6 @@
</h2>
<h3>Other</h3>
<ul>
<li><strong>Scroll down after [..] seconds of inactivity</strong>: If you scrolled
up in chat but haven't moved scrollposition in the given number of seconds, it will scroll down
if new messages come in. This prevents accidently scrolling up from hiding
new messages.</li>
<li><strong>Chat buffer size</strong>: How many lines of text are kept
for each channel in chat to scroll back to.</li>
<li><strong>Inform me about new versions</strong>: Checks for new
versions every few days and outputs a message about it.</li>
</ul>
@ -963,33 +1027,32 @@
</h2>
<p>These settings should only be changed if you know what you're doing. You
can however reset any setting to the default by either deleting the settings
file or using <a href="help.html#settings">setting commands</a>.</p>
file or using <a href="help-setting_commands.html#server">setting commands</a>.</p>
<h3>Connecting</h3>
<h3>Connection</h3>
<ul>
<li><strong>Server</strong>: The default server to connect to</li>
<li><strong>Port</strong>: The default port(s) to connect to (can be
a list of ports, e.g. <code>6667,80</code>)</li>
a list of ports, e.g. <code>6667,443</code>)</li>
<li><a name="Advanced-Userlist"><strong>Correct Userlist</strong></a>:
If this setting is enabled, the IRCv3 capability that enables joins/parts is send
on connect. This doesn't mean you have to <em>show</em> joins/parts in
chat, it just means joins/parts are received in the background to maintain the userlist.</li>
</ul>
<p>The values of these settings are used when connecting, unless the commandline
<p>The server/port values are used when connecting, unless the commandline
parameters <code>-server</code> and/or <code>-port</code> are used,
then the value that is given there is used instead (without it being shown
here). You should know if you set a server or port with a commandline
parameter, but you can also check that by using <code>/get server</code>
and <code>/get port</code>.</p>
<h3><a name="Advanced-TC">Twitch Client Version</a></h3>
<p>The Twitch Client Version setting has been removed since Twitch Chat was
switched over to IRCv3 tags and commands. It optionally also contains joins/parts/userlist.</p>
<h3><a name="Advanced-Userlist">Correct Userlist</a></h3>
<p>If this setting is enabled, the IRCv3 capability that enables joins/parts is send
on connect. This doesn't mean you have to <em>show</em> joins/parts in
chat, it just means joins/parts are received in the background to maintain the userlist.</p>
<h3>Whisper Feature</h3>
<div class="moreInfo">Help: <a href="help.html#whisper">Whisper Feature</a></div>
<div class="moreInfo">Help: <a href="help-whisper.html">Whisper Feature</a></div>
<h3><a name="Advanced-TC">Twitch Client Version</a></h3>
<p>The Twitch Client Version setting has been removed since Twitch Chat was
switched over to IRCv3 tags and commands (receiving of joins/parts is now
controlled by the <a href="#Advanced-Userlist">Correct Userlist</a> setting).</p>
<h2>
<a name="Hotkeys">Hotkeys</a>

44
help/help-short_guides.html
View File

@ -106,28 +106,28 @@
<h2><a name="eventchat">Join Eventchat</a></h2>
<p>Sometimes there are channels that run on a special set of event chat
servers, so they are seperated from the channels you see when you join
<code>irc.twitch.tv</code>. This only applies to webchat (at the moment
at least), so often the chat you get connecting to <code>irc.twitch.tv</code>
is called "mobile chat", because the mobile apps apparently also don't
support event chat.</p>
<p>When you join a channel of a big event and you don't receive any (or few) messages,
it's possible that the channel is on the Event Chat servers, not the
regular Twitch Chat servers. It's a common problem to run into if you're
not using the website (like any regular IRC client, Chatty and possibly
mobile).</p>
<p>See this <a href="http://help.twitch.tv/customer/portal/questions/8152306-can-t-see-chat-of-some-channels-on-irc-">
Twitch Support Center entry</a> or <a href="http://twitchstatus.com/#chat">Twitchstatus.com</a> for an (unofficial) list
of servers.</p>
<p>In order to join Event Chat in Chatty, you have to connect to a different
server. See <a href="http://twitchstatus.com/#chat">Twitchstatus.com</a> for an (unofficial) list
of servers (make sure you choose the <code>Event Chat</code> tab and use
a server/port combination that is marked as <code>irc</code> in the
<code>Protocol</code> column).</p>
<p>What you have to do in Chatty to be able to get the
event chat instead of the "normal chat" that is only used by IRC and
mobile users, is connect to a different server. 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 same time.</p>
<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
same time.</p>
<p>There are different ways of connecting to a different server:</p>
<ul>
<li>The <code>/server &lt;host&gt;[:port]</code> command connects to the given server and
port manually.</li>
port manually (for example <code>/server irc.twitch.tv:443</code>,
replace with an Event Chat server accordingly).</li>
<li>The <code>-server</code> and <code>-port</code> commandline options
allow you to specify a different server when you start Chatty.</li>
<li>The <code>Server</code> and <code>Port</code> settings in the
@ -135,6 +135,18 @@
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>
</ul>
<p>If you want to switch between servers sometimes, you can create a
custom command to connect to Event Chat so you don't have to enter
the command with the IP and port manually every time. Go to
<code>Settings - Commands</code>, add a new Custom Command and enter:
<code>/eventchat /server &lt;server&gt;:&lt;port&gt;</code> (replace
with the appropriate IP and port of course). Then you
can just enter <code>/eventchat</code> in the inputbox (while not
being connected) and it will connect to Event Chat and if you want to
connect to regular Twitch Chat just connect regularly via the menu
(and it will use <code>irc.twitch.tv</code> if you didn't change the
server settings).</p>
</body>
</html>

82
help/help-troubleshooting.html
View File

@ -7,15 +7,29 @@
<h1><a name="top">Troubleshooting</a></h1>
<ul>
<li><a href="#known">Known Issues</a></li>
<li><a href="#performance">Bad performance / OutOfMemoryError</a></li>
<li><a href="#jintellitype">Could not load JIntellitype.dll</a></li>
<li><a href="#livestreamer">Livestreamer won't run properly</a></li>
<li><a href="#timeout">People are shown as timed out in several channels at once</a></li>
<li><a href="#login">Can't connect because the login failed</a></li>
<li><a href="#font">Some characters in chat only show up as boxes / Fallback fonts</a></li>
<li><a href="#start">Chatty won't start</a></li>
<li><a href="#log">Debug log</a></li>
<li>Startup/Folders/Settings
<ul>
<li><a href="#start">Chatty won't start</a></li>
<li><a href="#jintellitype">Could not load JIntellitype.dll</a></li>
<li><a href="#settings_lost">Settings lost</a></li>
<li><a href="#wrong_folders">Wrong image/sounds folder</a></li>
</ul>
</li>
<li>Connection Issues
<ul>
<li><a href="#login">Can't connect because the login failed</a></li>
<li><a href="#connect">Can't connect</a></li>
</ul>
</li>
<li>Other
<ul>
<li><a href="#known">Known Issues</a></li>
<li><a href="#performance">Bad performance / OutOfMemoryError</a></li>
<li><a href="#livestreamer">Livestreamer won't run properly</a></li>
<li><a href="#font">Some characters in chat only show up as boxes / Fallback fonts</a></li>
<li><a href="#log">Debug log</a></li>
</ul>
</li>
</ul>
<h2>
@ -45,14 +59,7 @@
<a name="performance">Bad performance / OutOfMemoryError</a>
<a href="#top" class="top">[back to menu]</a>
</h2>
<p>If you experience a laggy interface, this can have several reasons. For
one some chat channels are very busy and depending on your computer, this
may not be easy to handle. Managing the userlist can cost a lot of
performance in large channels because of having to react to hundreds of
users joining or leaving at once. It can help to temporarily
<a href="help.html#ignoreJoinsParts">ignore joins/parts</a> in this case.</p>
<p>You may also want to check if Irc logging is enabled in the Debug Window
<p>You may want to check if Irc logging is enabled in the Debug Window
(<code>Extra - Debug window - Checkbox: Irc log</code>), which should
be disabled by default, but can lower performance if checked.</p>
@ -114,21 +121,35 @@
<p>See the <a href="help-livestreamer.html">Chatty Livestreamer Help</a>.</p>
<h2>
<a name="timeout">People are shown as timed out in several channels at once</a>
<a name="settings_lost">Settings lost</a>
<a href="#top" class="top">[back to menu]</a>
</h2>
<p>If a user is timed out in one channel, Chatty may show the timeouts in
other channels as well. This is because there is no channel associated with
timeouts or bans in Twitch Chat, so the program has to guess in which
channel the timeout occured. See also: <a href="help.html#channels">Joining more than one channel</a>.</p>
<p>If you loose your settings (or part of it like just the Addressbook) then
either they weren't saved/loaded properly for some reason or you changed
your configuration and your settings directory is not the same anymore.</p>
<ul>
<li>Enter <code>/dir</code> in Chatty to find out what your settings
directory is (<code>/openDir</code> to open it) and whether that's
the one you used before (there should be quite a few files and
folders).</li>
<li>If there is a <code>backup</code> folder you can try to restore the
automatic backup. <a href="help-guide_folders.html#backup">More Information...</a></li>
</ul>
<h2>
<a name="wrong_folders">Wrong image/sounds folder</a>
<a href="#top" class="top">[back to menu]</a>
</h2>
<p>The image/sounds folders are based on the current Working Directory,
which is set when you start Chatty. <a href="help-guide_folders.html#wdir">More Information..</a></p>
<h2>
<a name="login">Can't connect because the login failed</a>
<a href="#top" class="top">[back to menu]</a>
</h2>
<p>If you repeatedly get disconnected because of possibly invalid login
data, please open the Connect Dialog and choose <code>Configure login.. - Verify login</code>.
data, please go to <code>Main - Login.. - Verify login</code>.
This will send a request to Twitch to check if the access token is valid.
If the login data is valid, then Twitch may just have temporary problems
and you should try again later. The same goes for when the check itself
@ -136,6 +157,21 @@
<p>If the login data isn't valid, you can just remove the login and request
new login data. Also see the <a href="help.html#login-invalid">section about login</a>
for more information about invalid logins.</p>
<p>Another reason may be that you are connecting to the <a href="#connect">wrong port</a>.</p>
<h2>
<a name="connect">Can't connect</a>
<a href="#top" class="top">[back to menu]</a>
</h2>
<p>It's possible that your internet/firewall doesn't like the port you are
using to connect. By default it tries to connect to <code>6667</code>
first. Twitch may also have changed the ports. You can check <a href="http://twitchstatus.com">Twitchstatus.com</a>
(not an official Twitch site) which chat server/ports are available (make sure to use an <code>irc</code> server).
The host <code>irc.twitch.tv</code> should resolve to the available server IPs, so you normally
shouldn't have to enter an IP directly (for main chat).</p>
<p>If you are using a shortcut to start Chatty, also check any
custom server/port you may have defined there using <a href="help.html#launch">commandline parameters</a>.</p>
<h2>
<a name="font">Some characters in chat only show up as boxes / Fallback fonts</a>

171
help/help-whisper.html Normal file
View File

@ -0,0 +1,171 @@
<!DOCTYPE html>
<html>
<title>Chatty Help - Whisper Feature</title>
<link rel="stylesheet" type="text/css" href="style.css" />
<body>
<div id="backlink"><a href="help.html">Back to main help page</a></div>
<h1><a name="top">Whisper Feature</a></h1>
<p>
<a href="#start">Getting started</a> |
<a href="#usage">Usage</a> |
<a href="#troubleshooting">Troubleshooting</a>
</p>
<p><em>It is recommended that you read and understand this whole section
before enabling this feature.</em></p>
<p>Chatty implements the new <code>/w</code> command that Twitch Chat
provides, allowing you to send private messages in chat to other users.
However, it is disabled by default, since it has a few problems:</p>
<ul>
<li>Twitch is planning to move Whispering to a whole different system
soon, which means in the current state it is not really encouraged
to be used by third-party applications. It is unclear what the new
system will be and whether it will be possible to implement it in
Chatty. Also, due to these circumstances, not too much development
time will be put into the Whisper feature in Chatty at this time.</li>
<li>Whispering currently runs on the Group Chat servers, so Chatty can't
just use <code>irc.twitch.tv</code> to connect as for regular chat.
Since there is no easy official way to get the server data
automatically, you have enter the IP and port yourself if you want
to use this feature.</li>
</ul>
<h2><a name="start">Getting started</a></h2>
<p>You have to change a few settings in order to use this feature
(all under <code>Main - Settings - Advanced</code>):</p>
<h3>Required settings</h3>
<ul>
<li><strong>Whisper Enabled</strong>: Connect to the given Group Chat
server to send and receive whispers. Enable when you configured the
server. Disable this it if you run into problems.</li>
<li><strong>Server/Port</strong>: You can click on
<code>Select server..</code> and select a server from the list (all
listed <em>should</em> work). This is using an unsupported Twitch
API which is not guaranteed to stay the same.</li>
</ul>
<p>Once these settings are correctly configured, Chatty will connect to
Whispers when you connect to regular chat. It will disconnect when you
disconnect from regular chat via the Main-menu. If the Whisper Feature
is properly connected and ready to use, <code>[W]</code> will be shown
in the titlebar and the <code>/connection</code> command will show the
Whisper connection in addition to the regular chat connection.</p>
<p>If you were already connected when you changed these settings, either
disconnect and connect again (via the Main menu) or restart Chatty.</p>
<p>If <code>Select server..</code> is not working, configure the server manually:</p>
<ul>
<li><strong>Server</strong>: The Group Chat server IP to connect to. You can check:
<ul>
<li><a href="http://twitchstatus.com/">Twitchstatus.com</a> (unofficial site) at the bottom of the page,
"Group Chat" tab, "irc" Protocol (not "ws_irc")</li>
<li>Get an IP from the Twitch API using <a href="http://blog.bashtech.net/twitch-group-chat-irc/">this guide</a>
(you will need a token and be member of a Group Chat, you won't need to get a channelname)</li>
</ul></li>
<li><strong>Port</strong>: The port for the Group Chat server you
are using (you should get it along with the IP).</li>
</ul>
<h3>Optional settings</h3>
<ul>
<li><strong>Whitelist</strong>: If enabled, only users that have the
<a href="help-addressbook.html">Addressbook</a> category
<code>whisper</code> will be able to send whispers to you.
Messages from other users are discarded. Alternatively you can
also <strong>blacklist</strong> users by adding them to the
<code>blockwhisper</code> category (which makes most sense with
the Whitelist setting disabled).<br /><br >
In addition, you can also add users to the Ignore List by
right-clicking on them in chat to open the context menu and
choosing <code>Miscellaneous - Ignore (whisper)</code>. Unlike
the Blacklist or Whitelist using the Addressbook, this will not
completely discard the messages, but instead add them to the
Ignored Messages dialog and possibly output some other messages
about it, depending on the Ignore settings.</li>
<li><strong>Display</strong>: Changes where the whispers are
displayed.
<ul>
<li><strong>Active Chat</strong> - Show in the chat window
you are currently having active in Chatty.</li>
<li><strong>One Window</strong> - Show all whispers in one
separate window. In that window you will be able to
respond to whispers by just typing <code>&lt;name&gt;
&lt;message&gt;</code> instead of having to use the
<code>/w</code> command. To be sure you actually provide
the user to send it to you can only whisper to users
that have already whispered to you (so e.g.
<code>Hey how are you? :)</code> wont't be send to the
user named <code>Hey</code>). The tab for collecting all
whispers is named <code>$[whisper]</code>.</li>
<li><strong>Per User</strong> - Open an extra tab for every
user that whispers to you. You can respond to whispers
by just typing the message in the tab for that user. The
tab will be named <code>$&lt;username&gt;</code>.</li>
</ul>
</li>
</ul>
<h2><a name="usage">Usage</a></h2>
<p>When the Whisper Feature is connected (<code>[W]</code> appears in the
titlebar) you can receive and send whispers:</p>
<ul>
<li>When you receive a whisper, it will be displayed depending on the
Display setting and will be indicated by the nickname being marked
like this: <code>-[name]-</code></li>
<li>When you send a whisper via
<code>/w &lt;name&gt; &lt;message&gt;</code>, then this will be
indicated in chat by the nickname being marked like this:
<code>&gt;&gt;[name]</code></li>
<li>In both cases the name is the name of the person you are talking
with, not your own name.</li>
<li>When you click on the name, you will be able to see your
conversation, with your own messages marked with a asterisk in front
(*), which is usually used to mark action messages
(<code>/me</code>).</li>
</ul>
<h2><a name="troubleshooting">Troubleshooting</a></h2>
<p>If you get a lot of errors like <code>Whisper feature: Disconnected</code> this
may be due to different reasons:</p>
<ul>
<li>A temporary problem with Twitch or your internet connection, in which
case just wait a while.</li>
<li>Wrong server/port entered, follow the <a href="#start">Getting Started</a>
guide to check if the data you entered is still correct.</li>
<li>Twitch changed the system and it is not working as implemented in Chatty
anymore (in which case you should disable the feature).</li>
</ul>
<p>How to proceed:</p>
<ul>
<li>Check <a href="http://twitchstatus.com">Twitchstatus.com</a> (mainly Group Chat Tab),
<a href="https://twitter.com/chattyclient">@ChattyClient</a> and
other usual places to find out if the problem lies with Twitch.
Disable the Whisper Feature if necessary.</li>
<li>If the <code>[W]</code> in the titlebar isn't there, but it also
doesn't output errors anymore, it may have given up trying to connect,
in which case you should connect to regular chat through the <code>Main</code>
menu (disconnect first if necessary). Connecting to whispers is
currently somewhat tied to connecting to regular chat. Disconnecting
from regular chat from the <code>Main</code> menu will also disconnect
from whispers.</li>
</ul>
</body>
</html>

190
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.1b3)</a></h1>
<h1><a name="top">Chatty (Version: 0.8.1)</a></h1>
<table>
<tr>
<td valign="top">
@ -16,24 +16,30 @@
<li><a href="#commands">Commands</a></li>
<li><a href="#login">Login data</a></li>
</ul>
<strong>Chat features</strong>
<strong>Chat basics</strong>
<ul class="menu">
<li><a href="#symbols">Symbols used in chat</a></li>
<li><a href="#favorites">Favorites / History</a></li>
<li><a href="help-whisper.html">Whisper Feature</a></li>
</ul>
<strong>Chat moderation / utility</strong>
<ul class="menu">
<li><a href="#nickCompletion">TAB Completion</a></li>
<li><a href="#inputHistory">Input History</a></li>
<li><a href="#channels">Joining more than one channel</a></li>
<li><a href="#favorites">Favorites / History</a></li>
<li><a href="#userselection">User Selection Mode</a></li>
<li><a href="#emoticons">Emoticons/Emote Dialog</a></li>
<li><a href="#pausechat">Pause Chat / One-click moderation</a></li>
</ul>
<strong>Chat customization</strong>
<ul class="menu">
<li><a href="#highlight">Highlight</a></li>
<li><a href="#ignore">Ignore</a></li>
<li><a href="#userColors">User Colors</a></li>
<li><a href="#emoticons">Emoticons/Emote Dialog</a></li>
<li><a href="#customemotes">Custom Emotes</a></li>
<li><a href="help-addressbook.html">Addressbook</a></li>
<li><a href="#userselection">User Selection Mode</a></li>
<li><a href="#streamchat">Stream Chat</a></li>
<li><a href="#customNames">Custom Usernames</a></li>
<li><a href="#whisper">Whisper Feature</a></li>
</ul>
<strong>Stream features</strong>
@ -45,18 +51,21 @@
<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="#streamchat">Stream Chat</a></li>
</ul>
</td>
<td valign="top">
<strong>Settings</strong>
<strong>Settings / Files</strong>
<ul class="menu">
<li><a href="help-settings.html">Settings Help</a></li>
<li><a href="help-setting_commands.html">Setting commands</a></li>
<li><a href="#settingFiles">Setting files</a></li>
<li><a href="#launch">Launch options</a></li>
<li><a href="help-addressbook.html">Addressbook</a></li>
<li><a href="help-guide_folders.html">Chatty Directories and Files</a></li>
</ul>
<strong>Miscallaneous</strong>
<strong>Miscellaneous</strong>
<ul class="menu">
<li><a href="help-releases.html">Release Information</a></li>
<li><a href="help-troubleshooting.html">Troubleshooting</a></li>
@ -64,6 +73,7 @@
<li><a href="#thanks">Miscellaneous/Thanks</a></li>
<li><a href="#about">About/License</a></li>
<li><a href="#ignoreJoinsParts">Ignore joins/parts</a></li>
<li><a href="help-memory_usage.html">About Memory Usage</a></li>
</ul>
<strong>Guides</strong>
@ -71,7 +81,7 @@
<li><a href="help-getting-started.html">Getting Started Guide</a></li>
<li><a href="help-guide1.html">Run more than one instance of Chatty</a></li>
<li><a href="help-guide2.html">What to do when getting login fails</a></li>
<li><a href="help-guide_folders.html">Chatty Directories and Files</a></li>
<li><a href="help-guide_create_shortcut.html">Create shortcut (launch options/icon)</a></li>
<li><a href="help-short_guides.html">More Guides..</a></li>
</ul>
@ -94,6 +104,16 @@
than the number of people in the chat is requested from the Twitch API about
every two minutes.</p>
<p>In addition, the titlebar will also show additional information, if enabled:</p>
<ul>
<li>The name of the channel that is being hosted</li>
<li><code>Sub</code> for Subscriber-Only Mode</li>
<li><code>Slow: &lt;time&gt;</code> for Slowmode</li>
<li><code>R9k</code> for R9Kbeta Mode</li>
<li>A language code if Broadcaster Language Mode is enabled</li>
</ul>
<p>You can toggle showing some information under <code>View - Options - Titlebar</code>.</p>
<h2>
<a name="shortcuts">Shortcuts</a>
<a href="#top" class="top">[back to menu]</a>
@ -146,6 +166,9 @@
<li><code>/reconnect</code> - Disconnects and reconnects</li>
<li><code>/fixMods</code> - Temporarily fixes the list of mods (like
<code>/mods</code> but without showing the list of mods in chat)</li>
<li><code>/ignore &lt;user&gt;</code>, <code>/unignore &lt;user&gt;</code> - To ignore/unignore user (chat and whisper)</li>
<li><code>/ignoreChat</code>, <code>/unignoreChat</code>, <code>/ignoreWhisper</code>, <code>/unignoreWhisper</code>
- To ignore/unignore user only from chat/whispering you</li>
</ul>
<p>Info commands:</p>
<ul>
@ -347,7 +370,7 @@
<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>TAB</kbd> to complete to <code>DatSheffy</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>
@ -356,6 +379,8 @@
<h3>How it works</h3>
<p>There are a couple of <a href="help-settings.html#Completion">settings</a>
that change the behaviour of the TAB Completion.</p>
<p>How the TAB Completion process works:</p>
<ol>
<li>Enter the beginning of an item (name, setting, emote).</li>
@ -510,6 +535,11 @@
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>
(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
can ignore or unignore that user from the <code>Miscellaneous</code>
submenu. You can view and edit the list of ignored users in the settings.</p>
<div class="moreInfo">More information: <a href="help-settings.html#Ignore">Ignore Settings</a></div>
<h2>
@ -675,7 +705,7 @@ MiniK http://static-cdn.jtvnw.net/emoticons/v1/25/1.0 set:793 id:3287</pre
jump to the first message of the next user above it.</p>
<p>In addition to the currently selected message, it will also highlight all
other messages by the same user. You can also hold <kbd>Ctrl</kbd> and
other messages by the same user. You can also hold <kbd>AltGr</kbd> and
click on a username in chat to highlight all that users messages (and enter
User Selection Mode).</p>
@ -752,98 +782,46 @@ MiniK http://static-cdn.jtvnw.net/emoticons/v1/25/1.0 set:793 id:3287</pre
</ul>
<h2>
<a name="whisper">Whisper Feature</a>
<a name="pausechat">Pause Chat / One-click moderation</a>
<a href="#top" class="top">[back to menu]</a>
</h2>
<p><em>It is recommended that you read and understand this whole section
before enabling this feature.</em></p>
<p>Chatty implements the new <code>/w</code> command that Twitch Chat provides, allowing
you to send private messages in chat to other users. However, it is disabled
by default, since it has a few problems:</p>
<ul>
<li>Twitch is currently testing Whispering on the Group Chat servers but
is planning to move it to a whole different system soon, which means
in the current state it is not really encouraged to be used by
third-party applications. It is unclear what the new system will be
and whether it will be possible to implement it in Chatty. Also, due
to these circumstances, not too much development time will be put
into the Whisper feature in Chatty at this time.</li>
<li>Whispering currently runs on the Group Chat servers, so Chatty can't
just use <code>irc.twitch.tv</code> to connect as for regular chat.
Since there is no easy official way to get the server data
automatically, you have enter the IP and port yourself if you want
to use this feature.</li>
</ul>
<h3>Getting started</h3>
<p>You have to change a few settings in order to use this feature
(all under <code>Main - Settings - Advanced</code>):</p>
<ul>
<li><strong>Whisper Enabled</strong>: Connect to the given Group Chat server to send and receive
whispers.</li>
<li><strong>Server</strong>: The Group Chat server IP to connect to. You can check:
<ul>
<li><a href="http://twitchstatus.com/">Twitchstatus.com</a> (unofficial site) at the bottom of the page,
"Group Chat" tab</li>
<li>Get an IP from the Twitch API using <a href="http://blog.bashtech.net/twitch-group-chat-irc/">this guide</a>
(you will need a token and be member of a Group Chat, you won't need to get a channelname)</li>
</ul></li>
<li><strong>Port</strong>: The port for the Group Chat server you
are using (you should get it along with the IP).</li>
</ul>
<em>All these three settings require a restart of Chatty to take full effect,
although it may have some effect without a restart.</em>
<p>If enabled in the settings under <code>Main - Settings - Chat</code> you
can stop the chat from scrolling down while you move the mouse over chat.
This can prevent misclicks when the chat is moving. The chat will resume
scrolling down as soon as you stop moving the mouse or move it out of
the chat area. When the chat is already paused, you can also hold
<kbd>Ctrl</kbd> to keep the chat paused even without moving the mouse.</p>
<p>Optionally, you can set it to require <kbd>Ctrl</kbd> being pressed in
conjunction with moving the mouse to initiate pausing. You can let go of
<kbd>Ctrl</kbd> as soon as pausing is started and it will stay paused as
long as you move the mouse inside the chat area.</p>
<p>Once properly enabled and connected, <code>[W]</code> will be shown in the titlebar and
the <code>/connection</code> command will show the Whisper connection.
The connection is attempted once you connect to regular chat.
</p>
<p>A little popup in the top-right will indicate that the chat is paused.</p>
<p>Optional settings:</p>
<ul>
<li><strong>Whitelist</strong>: If enabled, only users that have the
<a href="help-addressbook.html">Addressbook</a> category <code>whisper</code> will be able to send
whispers to you. Messages from other users are completely ignored.
Alternatively you can also <strong>blacklist</strong> users by adding them to the
<code>blockwhisper</code> category (which makes most sense with the Whitelist setting
disabled).</li>
<li><strong>Display</strong>: Changes where the whispers are displayed.
<ul>
<li><strong>Active Chat</strong> - Show in the chat window you are currently having
active in Chatty.</li>
<li><strong>One Window</strong> - Show all whispers in one separate window.
In that window you will be able to respond to whispers by
just typing <code>&lt;name&gt; &lt;message&gt;</code> instead
of having to use the <code>/w</code> command. To be sure you
actually provide the user to send it to you can only whisper
to users that have already whispered to you (so e.g.
<code>Hey how are you? :)</code> wont't be send to the user
named <code>Hey</code>). The tab for collecting all whispers
is named <code>$[whisper]</code>.</li>
<li><strong>Per User</strong> - Open an extra tab for every
user that whispers to you. You can respond to whispers by
just typing the message in the tab for that user. The tab
will be named <code>$&lt;username&gt;</code>.</li>
</ul>
</li>
</ul>
<p><em>Please note:</em> This only works when the chat area is already filled, so the scrollbar is
actually used. In addition, there may be instances where something you
want to click will move anyway, for example if a message is deleted due
to a timeout/ban, causing other messages to move.</p>
<h3>Scroll up to stop scrolling</h3>
<p>Another way of preventing scrolling down is scrolling up. Once you are
manually scrolled up, chat will stop scrolling down automatically.
However messages may still be removed from the buffer causing the chat
to move despite it not actively scrolling down. It will stop removing
messages to get moving to a minimum as long as you keep holding
<kbd>Ctrl</kbd>.</p>
<h3>Usage</h3>
<ul>
<li>When you receive a whisper, it will be displayed depending on the Display setting and
will be indicated by the nickname being marked like this: <code>-[name]-</code></li>
<li>When you send a whisper via <code>/w &lt;name&gt; &lt;message&gt;</code>,
then this will be indicated in chat by the nickname being marked like this: <code>&gt;&gt;[name]</code></li>
<li>In both cases the name is the name of the person you are talking with, not your own name.</li>
<li>When you click on the name, you will be able to see your conversation,
with your own messages marked with a asterisk in front (*), which is usually
used to mark action messages (<code>/me</code>).</li>
</ul>
<p>A certain time after not moving the scroll position, it will scroll down
automatically (unless <kbd>Ctrl</kbd> is still being pressed).</p>
<p>If you get a lot of errors like <code>Whisper feature: Disconnected</code> there
may be a temporary problem, you may have entered the server/port wrong or
the feature is not working as it is implemented in Chatty anymore (in which
case you should disable the feature).</p>
<h3>One-click moderation</h3>
<p>Holding <kbd>Ctrl</kbd> and clicking on a user in chat can execute a ban
or timeout on that user. Enable this feature and define what it does in
the settings (<code>Main - Settings - Chat</code>).</p>
<p>It is recommended to enable the pause chat feature if you are using this,
or else misclicks could be very common.</p>
<h2>
<a name="channelinfo">Channel Info / History</a>
@ -1067,6 +1045,11 @@ MiniK http://static-cdn.jtvnw.net/emoticons/v1/25/1.0 set:793 id:3287</pre
yourself while streaming out of a game (given that global hotkeys work in
the game).</p>
<p>The highlights are written to the file <code>stream_highlights.txt</code>
in the <code>exported</code> subfolder of the settings directory (which
you can open with the <code>/openDir</code> and show with the
<code>/dir</code> command).</p>
<h3>Allow your moderators to add highlights</h3>
<p>You can also let your moderators add stream highlights
(<code>!addStreamHighlight [comment]</code>), but you first have to
@ -1094,7 +1077,12 @@ MiniK http://static-cdn.jtvnw.net/emoticons/v1/25/1.0 set:793 id:3287</pre
<a href="#top" class="top">[back to menu]</a>
</h2>
<p>There are a few options you can launch Chatty with, that will override
settings loaded from the settings file:</p>
settings loaded from the settings file. You need to run Chatty from the
commandline or <a href="help-guide_create_shortcut.html">Create a shortcut</a>
to use these.</p>
<p>These need to be defined after the <code>Chatty.jar</code>, for example:
<code>javaw -jar Chatty.jar -channel lotsofs</code></p>
<dl class="defList">
<dt><code>-server &lt;host/ip&gt;</code></dt>

BIN
help/jconsole.jpg Normal file
View File

Binary file not shown.
Side by Side

After

Width:  |  Height:  |  Size: 19 KiB