Update v0.8.5 help

This commit is contained in:
tduva 2017-04-12 05:28:40 +02:00
parent 3e44c436b9
commit 3db71141a3
8 changed files with 408 additions and 270 deletions

View File

@ -14,14 +14,13 @@
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,
<p>In the Admin Dialog you can edit your title/game and run commercials, if
you have allowed Chatty access (you need <code>Editor Access</code>/
<code>Commercial access</code> respectively, see <a href="help.html#access">allow more access</a>).</p>
<p>The Admin Dialog is always opened for the currently active 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>
in which case it will open for your own channel (you login with).</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.
@ -30,26 +29,29 @@
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>
<p>Use <code>Select game</code> to open a dialog where you can search for
a game and also add games to the favorites.</p>
<h3>Select a community</h3>
<p>Communities in Twitch are an additional category you can select for your
stream. If you want to use a Community, you need to select an already
existing one. As with games, you can add favorite Communities. Make sure
to adhere to the rules when selecting a Community.</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
<p>Status Presets allow you to store the current title, game and community
for later use. A status is automatically added every time you press the
<code>Update</code> button (can be disabled in the History settings),
but will be removed after some time of not being used. You can also add
the current status to the favorites by pressing the <code>Fav</code>
button, which means it is never automatically removed from the Status
Presets.</p>
<p>Press the <code>Presets</code> button to open the Presets, where you can
select a status (double-click to immediately use it) and filter by
current game or favorites.</p>
<p>The <code>Last Activity</code> column 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>

View File

@ -33,26 +33,26 @@
</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/&force_verify=true&scope=chat_login+channel_editor+channel_commercial+user_read+channel_subscriptions+user_follows_edit">Request new login</a></td>
<td>x</td>
<td>x</td>
<td>x</td>
<td>x</td>
<td>x</td>
<td>x</td>
<td></td>
<td></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/&force_verify=true&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>
<td></td>
<td></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/&force_verify=true&scope=chat_login+user_read">Request new login</a></td>
<td>x</td>
<td>x</td>
<td></td>
<td></td>
<td></td>
<td></td>
<td></td>
@ -60,7 +60,7 @@
</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/&force_verify=true&scope=chat_login">Request new login</a></td>
<td>x</td>
<td></td>
<td></td>
<td></td>
<td></td>
@ -70,7 +70,7 @@
</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
<code>http://127.0.0.1:61324</code>. <strong>Read on in the next section</strong>, 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>

View File

@ -13,6 +13,15 @@
<p><a href="https://github.com/chrippa/livestreamer">Livestreamer</a>
is a commandline program that can be used to watch streams in a player like
VLC Player. It has to be downloaded and installed seperately from Chatty.</p>
<p><em>Note:</em> Since Livestreamer doesn't appear to be developed anymore, there is an
updated fork called Streamlink, which works the same way. If you want to
use Streamlink with Chatty, simply change the <code>Base command</code>
to <code>streamlink</code> (or, as with Livestreamer, put the whole path to the program
if that is required in your case). Currently Streamlink appears to be using the
same commandline interface, so everything should work as usual (after
changing the <code>Base command</code>). If they do change the
interface, changes in Chatty may be required.</p>
<h2><a name="usage">Usage</a></h2>
<p>You can open the Livestreamer dialog that Chatty provides via

View File

@ -15,6 +15,7 @@
<h1><a name="top">Release Information</a></h1>
<p>
<a href="#0.8.5">0.8.5</a> |
<a href="#0.8.4.1">0.8.4.1</a> |
<a href="#0.8.4">0.8.4</a> |
<a href="#0.8.3">0.8.3</a> |
@ -43,7 +44,74 @@
full list of changes.</p>
<h2>
<a name="0.8.4.1">Version 0.8.4.1</a> <a name="latest">(This one!)</a> (2016-10-29)
<a name="0.8.5">Version 0.8.5</a> <a name="latest">(This one!)</a> (2017-04-12)
<a href="#top" class="top">[back to top]</a>
</h2>
<p>Custom Commands got a major overhaul in this version, which means that
some of the Custom Commands you are using may have to be fixed (although
it should be mostly backwards-compatible). Both Custom Commands and
adding them to the Context Menus/User Dialog has become more flexible
(for example you can add custom submenus, define commands directly in
the menu and move/remove the Mod/Unmod button in the User Dialog). Check
out the <a href="help-custom_commands.html">updated help</a> if you want
to learn more about it.</p>
<p>Also featured in this version is support for Communities in the Admin
Dialog. As with games Communities can be favorited and are integrated
into the Presets.</p>
<pre>
### New features
- Admin Dialog: Added support for setting a Community
- Added AutoMod dialog (Extra - AutoMod) to approve/deny messages
- User Dialog: Added ban reasons
- Added support for Cheer emoticons
- Added Follower-Only mode support
- Added "/untimeout" command
- Added Window Standalone Bundle (no installed Java required)
### Other changes
- Moved to v5 of the Twitch API
- Only show 2x size of GIF emotes if scaling is 160% or higher
- Allow "!highlight" command to be executed locally as well
- Improved URL parsing a bit
### Settings
- Added automatic Chat Log splits (daily, weekly, monthly) and channel
directories settings
- Added setting to disable Chat Log file locking
- Changed line spacing setting defaults
- Changed Ignore Mode default to "Hide"
- Further attempts to improve reliability of saving settings
- Added "maxReconnectionAttempts" setting (commands only)
- Added setting for placement of the Tabs
- Added setting for per-Tab Chat Buffer
- Added "/set" command special value "!" to toggle boolean settings
- Extended Emote Ignore feature to Cheer Emoticons
- Moved "Simple Title" setting to Titlebar options submenu
- Reorganized Settings Dialog a bit
### Custom Commands
- New parser which may require changes to some existing Custom Commands
- Added some simple functions for more flexibility (like $if to check if a
parameter exists)
- Changed format of Custom Menus to support defining commands directly in the
menu setting as well as custom submenus
- Changed format of User Dialog Buttons to support adding several rows of
buttons, as well as moving/removing the Mod/Unmod button
- Added "Test" button to some settings to check format of commands and show a
limited preview of Custom Menus
- Added replacements for stream info (title, game, viewers, ..)
### Bugfixes
- Fixed "/refresh bttvemotes" command when not on a channel
- Further improved GIF rendering
- Fixed rare error in Webserver
- Fixed some Settings Dialog bugs
</pre>
<h2>
<a name="0.8.4.1">Version 0.8.4.1</a> (2016-10-29)
<a href="#top" class="top">[back to top]</a>
</h2>
<p>With the new experimental Message Spacing setting (<code>Settings - Main</code>)

View File

@ -15,23 +15,32 @@
<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>
<dl class="defList">
<dt><code>/set &lt;setting&gt; &lt;value&gt;</code></dt>
<dd>Changes the value of a setting.</dd>
<dd>For Boolean settings you can use <code>true</code>, <code>1</code>
or <code>on</code> to enable the setting, <code>!</code> to
toggle it and any other value to disable it.</dd>
<dt><code>/get &lt;setting&gt;</code></dt>
<dd>Shows the current value of a setting.</dd>
<dt><code>/reset &lt;setting&gt;</code></dt>
<dd>Resets the setting to the default (hard-coded) value.</dd>
<dt><code>/clearsetting &lt;setting&gt;</code></dt>
<dd>Sets String (text) settings to an empty String.</dd>
<dt><code>/add &lt;setting&gt; &lt;value&gt;</code></dt>
<dd>Adds an item to a list setting.</dd>
<dt><code>/remove &lt;setting&gt; &lt;value&gt;</code></dt>
<dd>Removes an item from a list setting.</dd>
</dl>
<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>
@ -61,7 +70,8 @@
<a href="#streamhighlights">Stream Highlights</a> |
<a href="#debugging">Debugging</a> |
<a href="#bots">Bot Badges</a> |
<a href="#cm">Copy Messages</a>
<a href="#cm">Copy Messages</a> |
<a href="#openurl">Open URL Command</a>
</p>
<table class="settings" style="border-collapse: collapse;">
<tr style="border-bottom: 1px solid #EEE">
@ -279,6 +289,16 @@
<td>If set, overrides the <code>defaultPort</code>, can be
set by commandline options, not saved in between sessions</td>
</tr>
<tr class="settingExclusive">
<td class="setting">maxReconnectionAttempts</td>
<td>Integer</td>
<td>How many times Chatty will attempt to reconnect when
connecting fails</td>
<td class="settingDefault">40</td>
<td>You can set a negative value (for example -1) to have no
limit on the number of reconnection attempts. <em>Requires a
restart of Chatty after changing to take any effect.</em></td>
</tr>
<tr>
<td class="setting">username</td>
<td>String</td>
@ -571,6 +591,39 @@
<td>Only copy highlighted messages.</td>
</tr>
</table>
<h3><a name="openurl">Open URL Command</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="settingExclusive">urlCommandEnabled</td>
<td colspan="2">Boolean</td>
<td>false</td>
<td>Enable using the command set with <code>urlCommand</code>.</td>
</tr>
<tr>
<td class="settingExclusive">urlCommand</td>
<td>String</td>
<td>OS command to open URL (for example xdg-open on Linux)</td>
<td><em>empty</em></td>
<td>Used to customize with which command/program to open an
URL.</td>
</tr>
</table>
<p>This can be useful if Java doesn't use your default browser, or
you want to use a different program. The URL to open
automatically gets appended to the command set here and the
whole thing gets executed in the OS. For example if you set this
to <code>xdg-open</code> and <code>/openUrl https://twitch.tv</code>
then <code>xdg-open https://twitch.tv</code> will get executed.</p>
</body>
</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="#Moderation">Moderation</a>
| <a href="#Chat">Chat</a>
| <a href="#Emoticons">Emoticons</a>
| <a href="#Usericons">Usericons</a>
@ -17,6 +18,7 @@
| <a href="#Notifications">Notifications</a>
| <a href="#Log to file">Log to file</a>
| <a href="#Window">Window</a>
| <a href="#Tabs">Tabs</a>
| <a href="#Commands">Commands</a>
| <a href="#Other">Other</a>
| <a href="#Advanced">Advanced</a>
@ -226,6 +228,24 @@
<h3><a name="capitalization">Name Capitalization</a></h3>
<p>This has been moved to it's own <a href="#Names">settings page</a>.</p>
<h2>
<a name="Moderation">Moderation</a>
<a href="#top" class="top">[back to menu]</a>
</h2>
<dl class="dl-settings">
<dt>Show moderator actions in chat</dt>
<dd>Show commands that moderators execute directly in chat. You can also
view the same messages under <code>Extra - Moderation Log</code>.
Only works if you are a moderator yourself.</dd>
<dt>Show messages rejected by AutoMod</dt>
<dd>Show messages that have to be approved directly in chat. To approve
messages you have to open <code>Extra - AutoMod</code>, where you
can also view those messages even if this setting is disabled.</dd>
</dl>
<h2>
<a name="Chat">Chat</a>
<a href="#top" class="top">[back to menu]</a>
@ -935,6 +955,30 @@
<li><strong>off</strong> - Log no channels whatsoever</li>
</ul>
<h3>Other Settings</h3>
<dl class="dl-settings">
<dt>Folder</dt>
<dd>Select where to save the log files.</dd>
<dt>Split Logs</dt>
<dd>Start a new log file every Day, Week or Month.</dd>
<dt>Channel Subdirectories</dt>
<dd>Create a subfolder for each channel.</dd>
<dt>Lock files while writing</dt>
<dd>By default Chatty requests exclusive access while writing to the
file, so that no other program can interfere. This can however cause
issues if you try to open the log while in the channel, for example
if you want to look something up for moderation, so disabling this
setting can make sense. This means that you have to ensure yourself
that only one instance of Chatty and no other programs write to or
the lock the files.</dd>
<dt>Timestamp</dt>
<dd>Select the timestamp to be used in the logs.</dd>
</dl>
<h3>Messages Types</h3>
<p>Normal chat messages are always logged, however you can log additional
information:</p>
@ -1040,10 +1084,6 @@
not actually exit the program, but instead minimize it to tray. You can
actually close the program via <code>Main - Exit</code> or the tray icon
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
@ -1069,164 +1109,32 @@
automatically.</li>
</ul>
<h2>
<a name="Tabs">Tabs</a>
<a href="#top" class="top">[back to menu]</a>
</h2>
<dl class="dl-settings">
<dt>Tab Order</dt>
<dd>Whether to show tabs in the order they were opened or alphabetically.</dd>
<dt>Tab Placement</dt>
<dd>Where to put the tabs bar.</dd>
<dt>Tab Layout</dt>
<dd>If the amount of tabs doesn't fit, choose whether tabs should wrap
into multiple rows (or columns) or keep in one row, while having to
scroll through them.</dd>
<dt>Scroll through tabs with mousewheel</dt>
<dd>Hover mouse over tabs and scroll to change tabs.</dd>
</dl>
<h2>
<a name="Commands">Commands</a>
<a href="#top" class="top">[back to menu]</a>
</h2>
<h3>Custom Commands</h3>
<p>Custom commands allow you to specify aliases for anything you could also
enter directly into the inputbox (like chat messages or regular commands),
with the exception of other custom commands, which is a limitation
implemented to prevent infinite loops. Custom commands you add should be in
the following format:</p>
<p><code>/&lt;commandName&gt; &lt;what the command should do&gt;</code></p>
<p>Everything until the first space is the name of the comand, and everything
after the first space is the text of the command. For example:</p>
<p><code>/hello Hello World!</code></p>
<p>If you added that to the custom commands and enter <code>/hello</code>
in the inputbox, then it would send <code>Hello World!</code>, just as
if you would have written it yourself and pressed Enter.</p>
<h3>Custom Command Parameters</h3>
<p>You can also specify parameters in the command text, which will be replaced
when you execute the custom command. For example:</p>
<p><code>/permit !permit $$1</code></p>
<p>When you enter <code>/permit name</code>, then it will replace <code>$$1</code>
with the first word after the command, which in this case would be
<code>name</code>, making the actually send text <code>!permit name</code>.</p>
<p>This is the syntax for specifying parameters (word in this context means
anything seperated by a space):</p>
<dl>
<dt><code>$1, $2, $3</code></dt>
<dd>First word, second word, third word etc.</dd>
<dt><code>$1-</code></dt>
<dd>First word, and all the words after it</dd>
<dd>Equivalently <code>$2-, $3-</code> etc.</dd>
<dt><code>$$1</code></dt>
<dd>First word, but required, meaning the command result will only be
send if all the required commands are actually there</dd>
<dd>Equivalently <code>$$2, $$3-</code> is also possible</dd>
<dt><code>\$1-</code></dt>
<dd>Escape any special character (like <code>$</code>) by prepending a backslash
<code>\</code>, which means this won't be interpreted as a parameter
and not be replaced</dd>
<dd>If you actually want to use <code>\</code>, you can escape the
backslash itself, for example <code>\\$1-</code> will be replaced
(leaving one backslash in front of the replaced parameter)</dd>
</dl>
<h3><a name="commands-parameters-predefined">Predefined Parameters</a></h3>
<p>In a context other than entering the command in the inputbox, there are
some predefined parameters. For example if you add a command as a context
menu entry (see next section), then clicking that entry will execute the
command while automatically adding an appropriate parameter.</p>
<p>So you can for example add just <code>/Permit</code> to the menu, but
the custom command <code>/permit !permit $$1</code> will actually be
executed as <code>!permit &lt;name of the user&gt;</code>.</p>
<table class="settings">
<tr>
<th>Context</th>
<th>Parameters</th>
</tr>
<tr>
<td><em>All</em></td>
<td><code>$chan</code> - the currently active channel (without leading #)</td>
</tr>
<tr>
<td>User Context Menu</td>
<td><code>$1</code> - name of the user</td>
</tr>
<tr>
<td>User Dialog</td>
<td><code>$1</code> - name of the user</td>
</tr>
<tr>
<td>Channel Context menu</td>
<td><code>$1</code> - name of the currently active channel (without leading #)</td>
</tr>
<tr>
<td>Hotkey</td>
<td><code>$1</code> - the currently <a href="help.html#userselection">selected user</a> (if present)</td>
</tr>
</table>
<p>In addition, there is an implicit channel context, which means channel-aware
commands like <code>/ban</code> are executed in the appropriate channel.</p>
<h3><a name="commands-menu">Customize User/Channel Context Menu and User Dialog</a></h3>
<p>You can add custom commands and regular commands to the <code>User Context Menu</code> (when you right-click
on a user in chat), the <code>Channel Context Menu</code> (when you right-click anywhere on the chat
that is not otherwise linked) and customize <code>User Dialog Buttons</code> (Custom Commands
and Timeout Buttons).</p>
<p>Commands can be added in the following format:</p>
<p><code>/&lt;commandName1&gt;, /&lt;commandName2&gt;</code></p>
<p>For example:</p>
<p><code>/Slap, /Permit</code></p>
<p>Which means the command with the name <code>slap</code> will be added
first, then <code>permit</code> after that. You can use spaces,
linebreaks and/or commas as seperators between commands.</p>
<p>This is the syntax for specifying commands in the Context Menus/User Dialog:</p>
<dl>
<dt><code>/Slap /Permit</code> or <code>Slap, Permit</code> or <code>Slap Permit</code></dt>
<dd>Commands can be specified with or without forward slash <code>/</code>, then the name
(without parameters) and space, linebreak or comma to seperate to the next command.</dd>
<dd><em>Custom Commands in the User Dialog require the <code>/</code> in front.</em></dd>
<dt><code>//Slap</code></dt>
<dd>Prepending two forward slashes <code>//</code> will put the command
in the special submenu <code>More..</code> (for Context Menus) or
in a second line of buttons (for the User Dialog).</dd>
<dt><code>| Slap</code> or <code>|//Slap</code></dt>
<dd>Adding <code>|</code> (vertical bar) will add a seperator before the
menu item for the next command.
The <code>|</code> doesn't have to be directly in front of the command,
it simply applies to the following command.</dd>
<dd><em>Does not work for custom buttons in the User Dialog.</em></dd>
<dt><code>/Set_color</code> is displayed as <code>Set color</code></dt>
<dd>Underscores in command names are replaced with a space for display
in a Context Menu or on a button.</dd>
</dl>
<p>In addition, you can define for the <strong>User Dialog Buttons</strong>:</p>
<dl>
<dt><code>5, 2m, 10m, 24h</code></dt>
<dd>In addition to Custom Commands you can also specify Timeout Buttons
in the User Dialog. Times are added just like Custom Commands
(seperated by comma/space/linebreak). However they
can only be added to the first row of buttons. They are interpreted as
seconds by default, unless you add a suffix: <code>s</code> - seconds,
<code>m</code> - minutes, <code>h</code> - hours, <code>d</code> - days.</dd>
<dt><code>120s, 120</code> is displayed as <code>120s</code> and <code>2m</code></dt>
<dd>Both definitions create a button with a 120 seconds timeout, however
if you use a suffix, then the definition is used as button label
directly, otherwise the label is automatically created based on the
time.</dd>
<dt><code>/Ban[B], /Unban[U], 2s[P]</code></dt>
<dd>You can add keyboard shortcuts to buttons, that can be used while the
dialog is open and focused. Add a single button in brackets (uppercase).
Everything that is understood by
<a href="https://docs.oracle.com/javase/7/docs/api/javax/swing/KeyStroke.html#getKeyStroke%28java.lang.String%29">getKeyStroke()</a>
can be used. No spaces are allowed, however a plus (<code>+</code>) can
be used instead (which will be replaced with a space automatically).</dd>
<dt><code>/Slap[NUMPAD1|Np1], /Permit[NUMPAD2|]</code></dt>
<dd>Adding a vertical bar (<code>|</code>) after the shortcut will use
the text after it up to the closing bracket as label for the shortcut on the button (no
spaces are allowed). If you don't specify any text, then no label is
used for that shortcut.</dd>
<dt><code>nokeylabels</code></dt>
<dd>If that text appears anywhere in the definition, then no labels will
be displayed on the buttons for the shortcuts, unless they are
explicitly defined.</dd>
</dl>
<div class="moreInfo">This help is on a separate page: <a href="help-custom_commands.html">Custom Commands &amp; Context Menus</a></div>
<h2>
<a name="Other">Other</a>

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.4.1)</a></h1>
<h1><a name="top">Chatty (Version: 0.8.5)</a></h1>
<table>
<tr>
<td valign="top">
@ -32,6 +32,7 @@
<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>
<li><a href="#automod">AutoMod</a></li>
</ul>
<strong>Chat customization</strong>
@ -117,6 +118,10 @@
</ul>
<p>You can toggle showing some information under <code>View - Options - Titlebar</code>.</p>
<p>Note that the stream status (title/game, offline) can take a few minutes
to update, since it has to be requested from the Twitch API (which is
also heavily cached).</p>
<h2>
<a name="shortcuts">Shortcuts</a>
<a href="#top" class="top">[back to menu]</a>
@ -156,62 +161,52 @@
they are just there to show it's a parameter). Equivalently <code>[parameter]</code>
represents an optional parameter.</p>
<p>You can also create your own <a href="help-custom_commands.html">Custom Commands &amp; Customized Context Menus</a>.</p>
<p><em>Tip:</em> You can also use TAB Completion for many commands.</p>
<p>Chat commands:</p>
<h3><a name="commands-chat">Chat commands:</a></h3>
<ul>
<li><code>/me &lt;message&gt;</code> - Send an action message (* nickname says something) to the channel</li>
<li><code>/to &lt;nick&gt; [time] [reason]</code> - Timeout the user with the given nickname for "time" seconds (time is optional)</li>
<li><code>/timeout</code>, <code>/ban</code>, <code>/unban</code>,
<li><code>/me &lt;message&gt;</code> - Send an action message (* nickname says something) to the channel</li>
<li><code>/to &lt;nick&gt; [time] [reason]</code> - Timeout the user with the given nickname for "time" seconds (time is optional)</li>
<li><code>/timeout</code>, <code>/ban</code>, <code>/unban</code>,
<code>/slow</code>, <code>/slowoff</code>,
<code>/subscribers</code>, <code>/subscribersoff</code>,
<code>/clear</code>, <code>/mods</code>, <code>/host</code>,
<code>/unhost</code>, <code>/color</code>
just like in normal Twitch Chat</li>
<li><code>/join &lt;channel&gt;</code> - Joins the given channel</li>
<li><code>/part</code> or <code>/close</code> - Leaves the current channel</li>
<li><code>/reconnect</code> - Disconnects and reconnects</li>
<li><code>/fixMods</code> - Temporarily fixes the list of mods (like
<li><code>/join &lt;channel&gt;</code> - Joins the given channel</li>
<li><code>/part</code> or <code>/close</code> - Leaves the current channel</li>
<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>
<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>
<li><code>/connection</code> - Show info about the current connection</li>
<li><code>/uptime</code> - Shows how long Chatty has been running</li>
<li><code>/appinfo</code> - Shows Chatty uptime and current memory stats</li>
<li><code>/dir</code> - Show the directory the settings (and other stuff) are saved in</li>
<li><code>/wdir</code> - Show the current working directory</li>
<li><code>/openDir</code> - Opens the settings directory in your file browser</li>
<li><code>/openWdir</code> - Opens the current working directory in your file browser</li>
<li><code>/testNotification [channel]</code> - Display a test notification (optionally with channel,
which means right-clicking on the notification will join that channel)</li>
<li><code>/myemotes</code> - Show your subscriber emote codes (only works if you
have joined any channel before, this is only a quick info, better emote
integration maybe to be implemented later)</li>
<li><code>/ffz</code>, <code>/ffzGlobal</code> - Shows the FFZ channel emote codes for the current channel/global FFZ emotes</li>
<li><code>/releaseinfo</code> - Opens the help with the release information</li>
<li><code>/clearchat</code> - Clears the current chat window of all text</li>
<li><code>/connection</code> - Show info about the current connection</li>
</ul>
<p>Other commands:</p>
<p><em>Tip:</em> You can circumvent Chatty commands and send Twitch Chat commands
directly by prepending them with a dot <code>.</code> instead of a slash,
for example: <code>.mods</code>.</p>
<h3><a name="commands-settings">Settings/Customization commands:</a></h3>
<ul>
<li><code>/clearchat</code> - Clears the current chat window of all text</li>
<li><a href="#settings">Setting commands</a></li>
<li><code>/setcolor &lt;name&gt;</code> - Opens the usercolor settings
for the given name</li>
<li><code>/echo &lt;text&gt;</code> - Outputs the given text as a info message</li>
<li><a href="#addressbook">Addressbook commands</a></li>
<li><a href="#settings">Setting commands</a></li>
<li><a href="#streamhighlights">Stream Highlights commands</a></li>
<li><a href="#streamchat">Stream Chat commands</a></li>
<li><code>/copy</code> - Copies the given text to the clipboard</li>
<li><code>/follow [user]</code>, <code>/unfollow [user]</code> - Follow
or unfollow the given user, or the current channel if no user is given</li>
</ul>
<p>GUI commands:</p>
<h3><a name="commands-gui">GUI commands:</a></h3>
<ul>
<li><code>/echo &lt;text&gt;</code> - Outputs the given text as a info message</li>
<li><code>/copy</code> - Copies the given text to the clipboard</li>
<li><code>/settings</code>, <code>/livestreams</code>, <code>/channeladmin</code>,
<code>/channelinfo</code>, <code>/search</code>, <code>/openFollowers</code>,
<code>/openSubscribers</code> - Opens the according dialog</li>
@ -220,15 +215,19 @@
in a menu)</li>
<li><code>/insertword &lt;text&gt;</code> - Same as <code>/insert</code>,
but adds spaces so it's seperated from text before and after (if present)</li>
<li><code>/openUrl &lt;url&gt;</code> - Opens the given url</li>
<li><code>/openUrlPrompt &lt;url&gt;</code> - Open the given url after
<li><code>/openUrl &lt;url&gt;</code> - Opens the given url (see <a href="help-setting_commands.html#openurl">Open URL Command settings</a>)</li>
<li><code>/openUrlPrompt &lt;url&gt;</code> - Opens the given url after
showing a prompt for confirmation</li>
</ul>
<p>Advanced commands (<em>not recommended for use unless you know what you do</em>):</p>
<h3><a name="commands-system">Housekeeping/System commands:</a></h3>
<ul>
<li><code>/server &lt;host&gt;[:port]</code> - Connect to a custom server</li>
<li><code>/raw &lt;command&gt;</code> - Send a raw command to the server</li>
<li><code>/uptime</code> - Shows how long Chatty has been running</li>
<li><code>/appinfo</code> - Shows Chatty uptime and current memory stats</li>
<li><code>/dir</code> - Show the directory the settings (and other stuff) are saved in</li>
<li><code>/wdir</code> - Show the current working directory</li>
<li><code>/openDir</code> - Opens the settings directory in your file browser</li>
<li><code>/openWdir</code> - Opens the current working directory in your file browser</li>
<li><code>/refresh &lt;emoticons/badges/ffz/ffzglobal/bttvemotes/emotesets&gt;</code>
- Refresh the given data from it's respective API:
<ul>
@ -241,9 +240,33 @@
channel name, to display Twitch Subemotes info correctly
(twitchemotes.com API)</li>
</ul>
<em>This downloads the lists from the Internet, so don't use this
unless you need to (it's basicially like pressing reload in your
browser, just only for some stuff).</em></li>
<em>This downloads the lists from the Internet, which may be useful
if new emotes have been added (it's basicially like pressing
reload in your browser, but only for some select stuff per command).</em></li>
<li><code>/releaseinfo</code> - Opens the help with the release information</li>
<li><code>/myemotes</code> - Show your subscriber emote codes (only works if you
have joined any channel before, this is only a quick info, better emote
integration maybe to be implemented later)</li>
<li><code>/ffz</code>, <code>/ffzGlobal</code> - Shows the FFZ channel emote codes for the current channel/global FFZ emotes</li>
</ul>
<h3><a name="commands-test">Test commands:</a></h3>
<ul>
<li><code>/testNotification [channel]</code> - Display a test notification (optionally with channel,
which means right-clicking on the notification will join that channel)</li>
<li><code>/debug simulate &lt;type&gt;</code> - Simulates a chat message
for testing. Some possible types: <code>sub</code>, <code>resub</code>,
<code>bits</code>, <code>authost</code>.
</li>
<li><code>/debug</code> allows for a number of debug commands to be run,
but those may produce errors and strange behaviour, so you usually
shouldn't mess around with it.</li>
</ul>
<h3><a name="commands-advanced">Advanced commands (<em>be careful with these</em>):</a></h3>
<ul>
<li><code>/server &lt;host&gt;[:port]</code> - Connect to a custom server</li>
<li><code>/raw &lt;command&gt;</code> - Send a raw command to the server</li>
<li><code>/changetoken &lt;token&gt;</code> - Checks if the given token
is valid and sets it as new token if it is</li>
</ul>
@ -995,6 +1018,50 @@ MiniK http://static-cdn.jtvnw.net/emoticons/v1/25/1.0 set:793 id:3287</pre
<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="automod">AutoMod</a>
<a href="#top" class="top">[back to menu]</a>
</h2>
<p><a href="https://help.twitch.tv/customer/portal/articles/2662186-how-to-use-automod">AutoMod</a>
is a Twitch feature that filters messages before they are send to the
chat clients. As mod in the channel you can review and either approve
or deny those filtered messages. In Chatty this can be done via
<code>Extra - AutoMod</code>.</p>
<p>In the dialog you will see filtered messages of the current channel (if
you are mod). Open the context menu on a message (usually right-click)
to approve or deny that message. Double-click on a message to open the
User Info Dialog for that user to be able to see his previous messages
or ban/timeout the user.</p>
<p>Shortcuts available when you have a message selected:</p>
<ul>
<li><kbd>A</kbd> to approve, <kbd>D</kbd> to deny message</li>
<li><kbd>W</kbd> to move up in the list, <kbd>Alt+W</kbd> to jump over
already handled messages</li>
<li><kbd>S</kbd> to move down in the list, <kbd>Alt+S</kbd> to jump over
already handled messages</li>
</ul>
<p>Messages can have different prefixes depending on their status:</p>
<ul>
<li>No prefix - The message has not been approved/denied yet</li>
<li><code>Approved</code> - You have approved the message</li>
<li><code>Denied</code> - You have denied the message</li>
<li><code>Handled</code> - The message has been handled already,
probably by another mod (the API does not return whether it's been
approved or denied)</li>
<li><code>Pending</code> - Your action is being sent to the Twitch API</li>
<li><code>N/A</code> - The message is no longer available to be
approved or denied (this seems to be the case after a few minutes)</li>
<li><code>Error</code> - An error occured sending your action to the
Twitch API</li>
</ul>
<p>Messages that have already been handled or that are older than 5 minutes
(and can thus <em>probably</em> not be approved/denied anymore) are
shown greyed out.</p>
<h2>
<a name="channelinfo">Channel Info / History</a>
<a href="#top" class="top">[back to menu]</a>
@ -1224,17 +1291,28 @@ MiniK http://static-cdn.jtvnw.net/emoticons/v1/25/1.0 set:793 id:3287</pre
<h3>Allow your moderators to add highlights</h3>
<p>You can also let your moderators add stream highlights
(<code>!highlight [comment]</code>), but you first have to
change some <a href="help-setting_commands.html#streamhighlights">settings</a>:</p>
(<code>!highlight [comment]</code>), but you first have to set the channel with a
<a href="help-setting_commands.html#streamhighlights">setting command</a>:</p>
<ul>
<li><code>/set streamHighlightChannel #&lt;yourchannelname&gt;</code> to
allow moderators in the given channel to run the command</li>
<li><code>/set streamHighlightChannelRespond 1</code> to send a response to
chat when the mod command is used (otherwise the message is just shown locally)</li>
<li><code>/set streamHighlightCommand !highlight</code> to set <code>!highlight</code>
as mod command</li>
</ul>
<dl class="defList">
<dt><code>/set streamHighlightChannel #&lt;yourchannelname&gt;</code></dt>
<dd>Allows moderators in the given channel to run the command.</dd>
<dd>For example if your channel/stream is called <code>zoton2</code> the
command you have to enter would be: <code>/set&nbsp;streamHighlightChannel&nbsp;#zoton2</code></dd>
</dl>
<p>Optionally you can also set the following settings:</p>
<dl class="defList">
<dt><code>/set streamHighlightChannelRespond 1</code></dt>
<dd>Send a response to chat when the mod command is used (otherwise the
message is just shown locally).</dd>
<dt><code>/set streamHighlightCommand !highlight</code></dt>
<dd>Change the mod command (in this example to <code>!highlight</code>,
which is the default)</dd>
</dl>
<p><em>Tip:</em> <a href="help-setting_commands.html">Setting commands</a>
are entered into the chat input box, just like Twitch Chat commands.</p>
<h2>
<a name="ignoreJoinsParts">Ignore joins/parts</a>
@ -1396,6 +1474,8 @@ MiniK http://static-cdn.jtvnw.net/emoticons/v1/25/1.0 set:793 id:3287</pre
<li>Thanks to <a href="http://java-sl.com">java-sl.com</a> for some nice articles.</li>
<li>Thanks to <a href="http://twitchemotes.com">Twitchemotes.com</a> for
their <a href="http://twitchemotes.com/api/sets">Emoteset API endpoint</a>.</li>
<li>Thanks to <a href="https://frankerfacez.com">FrankerFaceZ</a> for
their Emotes/APIs and support</li>
<li>Thanks to <a href="http://www.nightdev.com">Nightdev</a> for allowing the use
of the <a href="http://www.nightdev.com/betterttv/">BetterTTV</a> emotes.</li>
</ul>

View File

@ -14,14 +14,14 @@ h1 {
border-bottom: 1px solid #AAAAAA;
}
h2 {
margin: 14px 0 0 0;
margin: 18px 0 0 0;
font-size: 1.1em;
border-bottom: 1px solid #AAAAAA;
padding-bottom: 2px;
}
h3 {
font-size: 1em;
margin: 10px 0 0 0;
margin: 14px 0 0 0;
padding: 0;
}
li ul {
@ -42,6 +42,19 @@ li {
code {
background-color: #EEEEEE;
}
.codeblock {
margin-left: 22px;
margin-top:10px;
background-color: #EEEEEE;
font-family: monospace;
padding: 6px;
}
.codeblock pre {
margin: 0;
padding: 0;
}
cite {
background-color: #EEEEEE;
}
@ -115,6 +128,11 @@ table.files {
font-weight: bold;
font-style: normal;
}
.note {
padding-left: 10px;
}
.paragraphs dd {
padding-bottom: 4px;
/* padding: 0 0 0 16px;