diff --git a/help/0.8.3b/0_4_overview_top.png b/help/0.8.3b/0_4_overview_top.png new file mode 100644 index 0000000..9b2625b Binary files /dev/null and b/help/0.8.3b/0_4_overview_top.png differ diff --git a/help/0.8.3b/followers.jpg b/help/0.8.3b/followers.jpg new file mode 100644 index 0000000..e0ce6fe Binary files /dev/null and b/help/0.8.3b/followers.jpg differ diff --git a/help/0.8.3b/help-addressbook.html b/help/0.8.3b/help-addressbook.html new file mode 100644 index 0000000..4f2b988 --- /dev/null +++ b/help/0.8.3b/help-addressbook.html @@ -0,0 +1,223 @@ + + +
The addressbook allows you to add usernames and assign categories to + them, which can then be used in other places such as the Usercolor settings + or the Highlight settings. + Categories cannot contain spaces and are all made lowercase when added/loaded from file.
+ +The addressbook can be edited in several ways:
+<Main Menu> - Channels - Addressbook
)
+ where all entries are listed and you can add/edit/remove entries.Addressbook
)
+ 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).In addition to the addressbook dialog and user context menu, there are also some commands to
+ edit the addressbook. All commands are prefixed with /ab
+ (e.g. /ab add <name>
) or alternatively /users
(e.g. /users add <name>
):
add <name>
- Adds a nameadd <name> <categories>
- 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)set <name> <categories>
- Sets the categories for this name, adding it if necessary, replacing
+ any present categories for this nameremove <name>
- Completely removes the given nameremove <name> <categories>
- Removes the given categories from this name, but leaves
+ the namechange <name> <categoriesModification>
- Prepend categories with +
,
+ -
or !
to add, remove or toggle the categories respectively. You can specify more than
+ one set of categories, for example: change test +a,b -c !d
adds a and b, removes c and toggles dget <name>
- Shows the categories for this nameinfo
- Shows number of entries and used categoriesCategories are given as a comma-seperated list without spaces, e.g. cat1,cat2,cat3
.
The following commands edit all entries at once, so they should be used with care:
+renameCategory <currentName> <newName>
- Renames a category, which means all occurences
+ of currentName
are replaced with newName
in all entries. This can also
+ be used to merge categories, if newName
already exists.removeCategory <name>
- Removes the category with the given name from all entries/ab add josh vip
vip
to the user called josh
josh
's categories would now be: vip
)/ab set josh rainbow
josh
to rainbow
, replacing
+ any previously associated categoriesjosh
's categories would now be: rainbow
)josh
kind of colorful in chat, try it out with your own name Kappa)/ab add josh vip
vip
to the user josh
josh
's categories would now be: rainbow,vip
)/ab remove josh vip
vip
from the user josh
,
+ keeping the other categories untouchedjosh
's categories would now again be: rainbow
)The following features are a bit more advanced and should only be used if + you somewhat know what you're doing.
+ + +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.
+ +The following settings affect the this feature (you have to change them + via setting commands):
+ +abCommandsChannel
/clearSetting
command to
+ disable the mod commands again./set abCommandsChannel #yourchannel
abCommands
add
and set
+ commands, the setting value would be add,set
(no spaces)./set abCommands add,set
add,set,remove
.If you set the settings accordingly, then the mods will be able to use
+ e.g. !add name category
to add name
to your
+ Addressbook with the category category
. 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).
This is a rather experimental feature, so it might not work reliably.
+ +You can write Addressbook commands (one per line) to the addressbookImport.txt
+ file in the settings directory (enter /dir
to find out what
+ your settings directory is). You can use any commands specified in the Commands section above, without
+ the /ab
or /users
prefix (since it's already
+ implied that they are Addressbook commands). For example:
add darthclide level1 +change nightbot !vip +set testi ignore+ +
To perform an import, enter the /abImport
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 (Extra - Debug window
)
+ and the debug log file.
You can also set the abAutoImport
setting (/set abAutoImport on
)
+ 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 abAutoImport
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.
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 /abImport
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.
Example: mIRC script to edit the Addressbook.
+ + +You can add somewhat unique categories to a setting, which means that + only one user will have that category assigned, as long as you only use + Addressbook commands to apply that category (and not the context menu or + Addressbook dialog).
+ +Use /set abUniqueCats star
to set the category star
+ as unique category. That way, only one user can have that category.
+ What happens is that when using an Addressbook command like
+ /ab add Jack star
, it will first remove the star
category
+ from all other users and then add it to Jack
.
If you want to have more than one unique category, you can separate
+ several categories by comma: /set abUniqueCats star,gold
This is an experimental feature that adds Subscribers automatically to + an Addressbook category, depending on how many months they subscribed. + This works on Subscriber Notifications in chat, so you have to be in the + channel at the time of the subscription for it to work.
+First you need to do some configuration:
+/set abSubMonthsChan #<yourchannel>
- Set the
+ channel you want the feature enabled for/add abSubMonths <number>
- Add one or several
+ subscription lenghts in months (repeat the command with a different
+ number to add more than one)/remove abSubMonths <number>
- Remove a number
+ from the listThe months represent the categories that are automatically added. For
+ example if you configured the months as [3, 6, 12]
:
.. subscribed for 3 months in a row!
would add that
+ user to the 3months
category.. subscribed for 4 months in a row!
would add that
+ user to the 3months
category.. subscribed for 11 months in a row!
would add that
+ user to the 6months
category.. subscribed for 20 months in a row!
would add that
+ user to the 12months
category.. just subscribed!
won't do anythingRemember that this relies on the notification message to be in a certain + format, so this may not be the most reliable thing, especially if Twitch + decides to change the message in some way.
+ + + diff --git a/help/0.8.3b/help-admin.html b/help/0.8.3b/help-admin.html new file mode 100644 index 0000000..e789ff0 --- /dev/null +++ b/help/0.8.3b/help-admin.html @@ -0,0 +1,98 @@ + + ++ Change game/title | + Run commercials +
+ +Open the Admin Dialog via View - Channel Admin
or by
+ right-clicking on the channel to open the context menu and choose
+ Channel Admin
.
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 Editor access
for changing game/title and
+ Commercial access
for running commercials. See allow more access.
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.
+ +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
+ reload
-Button. If others may have changed the info in the meantime,
+ you may want to reload before trying to change it.
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 Enter
+ or click the Search
-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.
There are also status presets, which allow you to add a combination of
+ title and game, so you can select it later. By pressing Fav
+ 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 Update
button.
Press the Presets
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.
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.
+The Last Activity
columns shows when this status was last
+ set using the Update
button (or when it was added to the
+ favorites for the first time). The Usage
column shows how
+ often it was set using the Update
button.
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.
+ +The Last run
time shows when a commercial was last run
+ through Chatty (this session).
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 Run commercial
+ 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.
If you have Use delay
selected, then the commercial will be
+ scheduled to run after the specified time. If you have Repeat
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 Use delay
selected for Repeat
+ to work, they just both use the same time as delay.
The time for the delay will be interpreted as seconds by default, but you
+ can also specify minutes. Examples: 30
(30 seconds), 5m
+ (5 minutes), 120s
(2 minutes).
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 Commercials
tab in the Admin Dialog
+ (don't forget to press Set
to actually set it).
If you have the Admin Dialog open on the Commercials
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.
Chatty is tailored towards Twitch Chat and is not a general IRC client, + so using a Bouncer may not work correctly or may cause unexpected + behaviour. Nevertheless, if you want to try if it works for you, this + page should get you started.
+ +By default Chatty will connect to the server/ports that are set in the + settings, using the store OAuth token. To connect to a Bouncer you need + to change both the server and port and tell Chatty to use the Bouncer + password instead.
+ +You will need to start Chatty with some launch options. + You can create a shortcut + or .bat file for that.
+ +-server <host/ip>
-port <port>
-password [password]
If your bouncer uses special names starting with *
like
+ *status
, this will open an extra Tab in Chatty. You can
+ also use the /msg
command to directly write to that name
+ (e.g. /msg *perform list
).
If you want to connect via SSL to your Bouncer you will have to add the
+ port you use for connecting to the list of ports that Chatty will try to
+ connect to via SSL (/add securedPorts <port>
). Note
+ that the Certificate has to be trusted by Java to work (otherwise you
+ have to add it to your local Java installation yourself). This can
+ especially be an issue with self-signed Certificates.
You have to configure your Bouncer to connect to Twitch Chat. There are + probably guides out there how to configure your Bouncer. In regards to + connecting to Twitch Chat in particular you can use one of the guides + for regular IRC clients and apply it to the Bouncer.
+ +In addition to that, the Bouncer will need to send the following raw + commands after connecting to Twitch Chat, which will make it send info + like usercolors, emotes, user status and much more:
+ ++CAP REQ :twitch.tv/tags +CAP REQ :twitch.tv/commands+ +
To receive a userlist at all, you also need to send the following (even + then Twitch Chat will only send the userlist on join and then update it + via JOINs/PARTs, and under some circumstances it may not send a userlist + at all):
+ ++CAP REQ :twitch.tv/membership+ +
Note: Channel names on Twitch Chat must be all-lowercase (Chatty + will automatically change the case accordingly, but if you configure + channels to join through the Bouncer directly you have to be careful + with this).
+ +See more information on Twitch Chat. + +
This is a short guide to help you with installing Chatty and getting familiar with some of it's features.
+ +You can download Chatty from it's Website.
+ The download simply consists of a .zip
-file which you should
+ extract wherever you want to have Chatty. The extracted files include a
+ Chatty.jar
which you should usually be able to double-click to
+ start the program (if Java is installed properly). (See the help
+ if Chatty won't start.)
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 .zip
.
+ Basicially just unzip the .zip
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).
Your settings are saved seperately in the settings directory
+ 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 /openDir
in Chatty. There is also a backup
+ folder in there with backups of the settings.
Please check out the Release Information for any changes in a new version that + may require your attention.
+ +Note: 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.
+ +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.
+In the Connect
-dialog, click on Create login..
+ and then Request login data
and simply follow the instructions.
+ Once you successfully created the login, close the dialog until you get back
+ to the Connect
-dialog. (There is a Guide on what to do
+ when getting login data fails.)
In the Connect
-dialog enter the name of the channel you want
+ to join in the Channel:
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 Enter
+ or click on Connect
. After connecting, it will automatically join
+ the channels you specified.
Even after connecting you can join additional channels via Channels - Join Channel
+ or entering the command /join <channelname>
in the inputbox
+ (e.g. /join joshimuz
).
You can leave channels by right-clicking anywhere in the channel and
+ selecting Close Channel
from the context menu or right-clicking
+ on the channel's tab (only available if there is more than one channel) and
+ selecting Close
from the context menu.
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 TAB to auto-complete the name. + Press Up-Arrow key to go back to previous stuff you entered.
+ +To moderate a chat, you can of course use the regular moderations commands
+ like /ban
, /timeout
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 User
-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.
Also check out the options to pause chat + and timing out users via shortcuts only.
+ + + +Chatty regulary requests information about the current stream, which is
+ displayed in the titlebar and the Channel Info
-dialog.
You can open the Channel Info
via the View
-menu
+ or the channel context menu (right-click anywhere on the channel). The
+ Channel Info
contains the current title/game but also a history
+ of the Viewercount and previous title/games (if you hover over points).
Open the Live Channels
-window via Channels - Live Channels
+ 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.
(You need to have the required access with your login data to see streams + you follow.)
+ +You can enable/disable showing streams you follow in the Settings - Notifications
.
+ There you can also configure what kind of Tray Notification you want to have
+ pop up for stream status changes or highlighted messages.
To join channels directly out of the Live Channels
-dialog
+ right-click on a stream to open the context menu and then select Join channel
+ to join the channel for that stream and if you want also open the stream in
+ your browser or Livestreamer.
Settings
+ from the Main
-menu to get all kinds of settings to adjust
+ Chatty to your preference. Please make use of the Help
link
+ in the bottom left corner of the Settings
-dialog to get
+ help on the current page of settings you have selected.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 .chatty
(where it is
+ exactly is system-dependant, enter /dir
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.
This means that when you run more than one instance on the same computer, + the last one you close always overwrites the settings.
+ +You can change the default settings directory by using the -cd
+ 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.
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).
+See also: Create Shortcut.
+ +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.
+ +You can do this by simply copying the login
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.
You could also try to play around with symbolic links
+ to point to a shared login
file.
If you want to run Chatty on different computers with the same account, + you run into the same problem as mentioned under Sharing login data: + You can't have more than one access token with the same account for the same + app at the same time.
+To use Chatty on more than one computer with the same account, you'll
+ have to transfer the login data, either by copying the login
+ file or by entering the access token manually
+ (/get token
displays the token,
+ /changetoken <token>
changes it).
Use this guide when the normal procedure of getting login data fails.
+ +If you open the Get login data
dialog and it says it can't
+ listen to the port, first check the following:
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 (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):
++ | Chat | +User read | +Editor | +Commercials | +Subscribers | +
---|---|---|---|---|---|
Request new login | +x | ++ | + | + | + |
Request new login | +x | +x | ++ | + | + |
Request new login | +x | +x | +x | ++ | + |
Request new login | +x | +x | +x | +x | ++ |
Request new login | +x | +x | +x | +x | +x | +
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
+ http://127.0.0.1:61324
. Read on in the next section, especially
+ Manually add the login into Chatty.
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:
+
+ Get login data
dialog is still open and it says Ready.
.
+ It needs to be open for this to work and will close automatically when it received
+ the necessary data.If you can't get the page to load, you can manually add the login data into Chatty.
+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:
+http://127.0.0.1:61324/token/#access_token=[longish mix of letters and numbers]&scope=chat_login+channel_editor+channel_commercial+user_read
+
+ The access_token
(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):
/changetoken <the access token>
+ For example if the url looked like this:
+http://127.0.0.1:61324/token/#access_token=abcdefghi12345abcdefg&scope=chat_login+channel_editor+channel_commercial+user_read
+ Then you enter this in Chatty:
+/changetoken abcdefghi12345abcdefg
+
+ 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.
+If you want, you can check in Main - Login..
+ whether the token you entered has the correct access associated with it.
This applies to Windows 7, and probably other Windows versions. The info + can probably also be applied to other OS with some adjustments.
+ +You can create a shortcut for Chatty, which has some potential advantages (depending on what you need):
+-cd
to use a different
+ settings directory.Create a shortcut to Java to start Chatty (for this example the
+ Chatty.jar
is located in D:\Chatty\
):
New - Shortcut
from the context menu. Enter
+ javaw -jar "D:\Chatty\Chatty.jar"
as location of the
+ item.Properties
from the context menu. Make sure that under
+ Shortcut
the Start in
points to the folder
+ that the Chatty.jar
is in (otherwise some stuff might
+ not work).Chatty.jar
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.Properties
from the context menu. In the
+ Target
field, it should have the path to the
+ Chatty.jar
. Before that add: javaw -jar
,
+ so that in total it reads for example:
+ javaw -jar "D:\Chatty\Chatty.jar"
The javaw
part might automatically be changed into the full path
+ to the javaw.exe
when you save the shortcut.
Add launch options or icon:
+Properties
from the context menu, then go to the
+ Shortcut
tab.javaw -jar "D:\Chatty\Chatty.jar" -cd
Change Icon..
and then Browse..
to
+ select an item to use for the Shortcut from your harddrive.
+ (Download Chatty icon
+ as .ico
file, right-click and
+ Save target as..
)You can then start Chatty by using this shortcut or you can drag it to the + taskbar to attach it to it.
+ + + diff --git a/help/0.8.3b/help-guide_folders.html b/help/0.8.3b/help-guide_folders.html new file mode 100644 index 0000000..3da05d0 --- /dev/null +++ b/help/0.8.3b/help-guide_folders.html @@ -0,0 +1,230 @@ + + ++ Files/Directory structure | + Backup +
+Learn what directories and files Chatty creates/uses.
+ +The settings directory by default is in your user home directory in a
+ subfolder called .chatty
. If you use the -cd
+ commandline parameter, then the settings directory is the current Working
+ Directory.
You can use commandline parameters by creating a shortcut and setting the
+ target to something like javaw.exe -jar "D:\Chatty\Chatty.jar" -cd
.
Use the command /dir
to display and /openDir
to
+ open the Settings Directory.
<settings directory> | ++ |
|-- backup | +[Folder] | +
| |- backup_x_<filename> | +Setting backups | +
| |- backup_meta | +Backups meta (last backup, numbering) | +
|-- cache | +[Folder] | +
| |- <various cache files> | +Cached emotes/image files | +
|-- debuglogs | +[Folder] Files intended to be read + by the user | +
| |- debug_session.log.x | +Last session debug log (overwritten every run) | +
| |- debugx.log.x | +Rotating debug log | +
| |- debug_ircx.log.x | +Rotating raw IRC log (only if enabled) | +
|-- exported | +[Folder] Files intended to be read + by the user | +
| |- stream_highlights.txt | +Recorded stream highlights | +
|-- logs | +[Folder] | +
| |- <channel>.log | +Chat log files | +
|- addressbook | +[Settings] Addressbook entries | +
|- login | +[Settings] Your login data (keep this secure) | +
|- favoritesAndHistory | +[Settings] Channel History/Favorites | +
|- settings | +[Settings] Main Settings File | +
|- statusPresets | +[Settings] Stream Title/Game presets (Admin Dialog) | +
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 Run in
.
+ Make sure this points to the same folder the Chatty.jar
is in
+ (or something else if you want to customize it, just make sure the files you
+ need are there).
Use the command /wdir
to display and /openWdir
+ to open the Working Directory.
<working directory> | ++ |
|-- sounds | +[Folder] Sound files | +
| |- <sound>.wav | +.wav files | +
|-- img | +[Folder] Image files for custom usericons | +
| |- <various images> | +.png files | +
|- JIntellitype.dll | +DLL for global hotkey support | +
This is where the Chatty.jar is located and is used for loading libraries + that Chatty uses.
+ +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.
+ +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).
+ +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!
+ +If you lost your setting files (or some of them) but still have + a backup, you can manually copy the backup to restore it.
+/openBackupDir
to open the Backup folder
+ (or enter /dir
and navigate to the Backup folder
+ manually).backup_x_<name>
,
+ these represent the separate batches of backups.backup_x_<name>
+ to <name>
(for example backup_2_settings
+ to settings
). You can ignore the backup_meta
file./dir
or /openDir
commands),
+ overwriting any existing setting files.Some documentation of prior or current issues for reference.
+ + +Chatty just randomly closes, apparently the JRE completely crashes.
+ ++# +# 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 + +[..] ++ +
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:
+ +-Dsun.awt.nopixfmt=true
For example:
+ +javaw -Dsun.awt.nopixfmt=true -jar "H:\chatty\Chatty.jar" -cd
After some time, Chatty suddenly shows an error if using the Calibri font.
+ ++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) ++ +
Hopefully this will be fixed in future Java updates, but for now just don't +use a Calibri font.
+ +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. + +
Apparently in newer Java versions Toolkit.getImage()
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.
Use Toolkit.createImage()
and create an ImageIcon
with the created image.
+ Usage | + Settings | + Troubleshooting +
+Livestreamer + 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.
+ +You can open the Livestreamer dialog that Chatty provides via
+ Extra - Livestreamer
, where you can directly run Livestreamer
+ and change some settings.
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.
+ +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 Close
-button on the
+ top right, which turns into an End process
-button as long as
+ the process is still running. The Retry
-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).
The settings can be changed in the Livestreamer dialog.
+Select
+ which tells Chatty you want to select a quality in the dialog. Seperate
+ qualities by space or comma. Add a |
(vertical bar) to add
+ a seperator to the menu.
+
+ Best, High, Worst | Select
Source High Medium Low Mobile | Select
livestreamer
, 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. "C:\My Programs\Livestreamer\livestreamer.exe"
).
+ "C:\My Programs\Livestreamer\livestreamer.exe" --player "C:\Program
+ Files\MPC-HC\mpc-hc64.exe"
(specify full path to Livestreamer
+ and use a different player)/usr/local/bin/livestreamer
(this might work on Linux/Mac
+ if it can't find Livestreamer without the full path)If you get an error like Error: java.io.IOException: Cannot run
+ program "<...>": CreateProcess error=2 [..]
, then
+ Chatty probably can't find Livestreamer on your system.
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
+ Base command or commandline options
field. See the Settings section
+ above for examples and help on that.
+ Restrict Memory Usage | + OutOfMemoryError +
+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 at the time, 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 requires, just how + much Java uses.
+ +Use the /appinfo
command in Chatty to get some information
+ about the current memory usage.
A typical memory usage pattern, which can change over time as the program
+ is running while Java optimizes Gargabe Collection:
+
You can restrict how much memory Java is allowed to use by specifying
+ commandline parameters for Java. Create a shortcut
+ and add the appropriate parameter after the javaw.exe
but
+ before the -jar
parameter.
For example to restrict memory to 100 MB: javaw -Xmx100M -jar "D:\Chatty\Chatty.jar"
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.
+ + + + diff --git a/help/0.8.3b/help-releases.html b/help/0.8.3b/help-releases.html new file mode 100644 index 0000000..f1c17c0 --- /dev/null +++ b/help/0.8.3b/help-releases.html @@ -0,0 +1,1196 @@ + + ++ 0.8.2 | + 0.8.1 | + 0.8 | + 0.7.3 | + 0.7.2 | + 0.7.1 | + 0.7 | + 0.6.7 | + 0.6.6 | + 0.6.5 | + 0.6.4 | + 0.6.3 | + 0.6.2 | + 0.6.1 | + 0.6 | + 0.5.1 | + 0.5 | + 0.4 | + 0.3 +
+ +This page shows important information about new versions as well as the + full list of changes.
+ +During March Twitch migrated Twitch Chat to new servers (Amazon AWS), + which you probably noticed due to some issues for some third-party + tools. This however also brought some improvements:
+ ++Improvements +============ +- Added some account info to User Info Dialog (click on "More..") +- Added auto-unhost feature (to unhost when your stream goes live, disabled by + default) +- Added new Twitch Player URL in context menu +- Added feature to automatically add Addressbook categories based on Subscriber + notifications (experimental) +- Added feature to automatically copy messages into clipboard +- Admin Dialog: Added error message for trying to set invalid stream status +- Added context menu entries to directly host channel +- Made URL detection a bit more lenient +- Updated help + +System +====== +- Added single-instance mode, with the ability to join channels in the already + running instance +- Added in-app announcements (Help - Announcements), for more reliable + communication of relevant news about Chatty (if new announcement is available + a window will pop up on start and a notification will be shown in the main + menu bar) +- Moved debug logs into separate directory +- Added /proc command to start native processes out of Chatty +- Made restoring window position more lenient for partly off-screen positions + +Connection +========== +- Bouncer: Some changes allowing you to connect to a Bouncer +- Whispers: Moved to main chat (AWS) +- Whispers: Hidden userlist for Whisper tabs by default +- Whispers: Added auto-responses for ignored/non-whitelisted users (disabled by + default) +- Increased max reconnection attempts to 40 +- Added `force_verify=true` parameter to Authorize URL (makes Twitch always ask + if you want to Authorize, makes sure you are logged in to the right account) +- Added some support for selecting the correct chat server + +Emotes +====== +- Emote Dialog: Improved shown info a bit +- Added /emoteonly and /emoteonlyoff commands (in case they get enabled again) +- Added "emotesets" parameter to /refresh command +- Changed twitchemotes.com API URL (which is the source of emoteset information) +- ShortenDisplayOfExcessivelyLongEmoteCodesLookingOutTheirWindow + +Settings +======== +- Added more chat font size choices to GUI +- Added input font setting to GUI +- Added setting to prevent highlights from specific users (e.g. your own bots) +- Added setting to toggle closing of Emote Dialog when double-clicking on Emote +- Added setting to remember Status History table sorting order +- Added setting to toggle Usercolor correction +- Added setting to display more verbose uptime in titlebar (enabled by default) +- Added setting to toggle check for restoring off-screen window position +- Added setting to prepend arbitrary text to the window title +- Changed default for showing animated emotes to off +- Changed default for Min. Userlist Width to 0 +- Changed default for Whisper Display Mode to per user +- Changed defaults for server/port (actively changed when updating to this + version, if setting values are on the previous default) +- Changed default for Highlight Mod Command to !highlight, ignore case for both + the channel and command setting +- Made setting names case-insensitive (for use with setting commands) +- Changed the process of saving settings in an attempt to make it more reliable +- Added menu entry to save settings manually + +Bugfixes +======== +- Fixed Admin Dialog sizing causing display issues +- Fixed spam protection message being displayed on the wrong channel +- Fixed new Twitch Emotes code being one character short +- Fixed autojoin not working sometimes +- Fixed framerate of GIFs, which may break some GIFs that worked before, but + prevents high CPU usage (displaying animated GIFs in Java is hard) +- Check if Java supports opening URLs on the current platform and run native + command if necessary +- Fixed sounds not being closed when finished playing +- Fixed tabs not changing correctly on System Look&Feel +- Fixed error on host notification due to moving Whispers to AWS ++ +
/w
(whisper) command and receive whispers in Chatty, read the
+ Whisper Help (some configuration required).Chat
).+#### 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 dedicated ignore user lists (separate for chat and whispers) + +#### 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 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) + +#### 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 +- Fixed tab not showing new message if message was highlighted with + `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) ++ +
+Core Changes: +- Connection: Implemented IRCv3 tags/commands/membership support +- Userlist: IRCv3 now supports optional joins/parts (correct userlist), which is + enabled by default in Chatty (doesn't mean joins/parts have to be shown) +- Added experimental support for secured connections + +Emoticons: +- Changed Emoticon parsing to use spaces as delimiter instead of word boundaries + (to match changes made to Twitch Chat) +- Scaling: Added settings to scale emotes in chat and the Emotes Dialog +- BTTV: Implemented BTTV Custom Channel Emotes, switched to new BTTV API +- IRCv3: Implemented new Twitch Emotes API, including using IRCv3 tags +- Emote Dialog: Added overview of all global emotes (Twitch and Other) +- Detail View: Added Detail View that can be opened for an emote with different + scaling and a table of information about the emote +- Context Menu: Added more entries and information +- Added emote image caching, making loading of emotes a bit faster and hopefully + more reliable if the server can't be reached at the time of loading +- Added feature to add custom emotes (locally), also allowing you to replace + other emotes +- FFZ: Switched to new API (and showing more info about the emotes) + +TAB Completion: +- Changed to work with @ in front (or any other non-word characters around it) +- Added info popup to show completion information (how many items are found, + which item you are at while cycling through results) +- Added completion for emotes (Shift-TAB) +- Added completion for setting names (TAB when using after setting command) +- Added completion for some commands (TAB after /) +- Added support for custom completion items that you can add in the settings or + via the /customCompletion command + +StreamChat: +- Added fitting context menu to stream chat dialog +- Added setting to START inserting text a the top in Stream Chat + (but not insert text at the top in general), added streamChatResizable setting +- Added commands /clearStreamChat, /testStreamChat, /setStreamChatSize, + /getStreamChatSize + +Other Enhancements: +- Added bot badge (bot names from BTTV/FFZ APIs and local setting) +- Added ability to record current stream time via commands to assist in creating + stream highlights +- Added setting to clear chat when channel is cleared by a moderator +- Hosting: Added info in the title which channel is being hosted, added warning + in chat when a channel is still being hosted when the stream is going live +- Streamlined reconnection messages a bit +- Output message if channel attempting to join doesn't exist on Twitch +- Added correctly capitalized names from IRCv3 display-name tag, removed + commands to change capitalization of names locally +- Added experimental showing of slowmode/submode status in the titlebar (only + shows correctly if mode toggled while you are already in the channel, until + chat sends that info on join as well) +- Added feature to locally set custom names for any user which show up in chat + and the userlist +- Highlighting: Added more prefix options +- Ignore: Added prefix option to ignore info messages +- Added Miscellaneous-menu to User Context menu and added entry Copy Name + (meaning copy to clipboard) +- Added Miscellaneous-menu to Channel Context menu and added entry to join + currently hosted channel +- Added /copy command which copies the given text to the clipboard +- Added /color command which redirects to the Twitch Chat /color command +- Added /livestreamer command to open streams/dialog via command +- Added /appinfo command +- Added /r9k and /r9koff commands +- Added workaround for Twitch API sometimes returning stream information with + missing channel object (no title available), assuming previous title +- Updated help + +Changes: +- Files: Moved cache files to be saved in the /cache folder +- Reduced Twitch API debug log spam a bit +- Increased join delay a bit +- Updated Settings Dialog layout to adjust to the dialog size better +- Changed Twitch API version calls to use v3 by default +- Changed Usericon image files starting with "http" to be interpreted as URL +- Disabled auto request of mods list for the time being, since mod status for + messages should always work and mod status in the userlist should probably + work if the userlist works in the first place +- Decreased Live Streams dialog scroll speed a bit + +Settings: +- Highlighting: Added highlightIgnored setting whether to try to highlight + messages that have already been ignored (disabled by default) +- Changed capitalizedNames (first letter only) setting to default to on (only + affects fresh settings) +- Debugging: Added setting to log raw IRC traffic to file (disabled by default) +- Added mainResizable setting to be able to turn off resizing of the main window +- Added setting to ignore Stream Status Notifications for Stream Offline +- Added some more support for different setting types to setting commands +- Changed setting commands to support numeric lists +- Changed Settings Dialog to only tell you to reconnect if you don't have to + also restart Chatty (required by a setting change) + +Bugfixes: +- Fixed bug where channel would constantly be reopened when it failed to join + (especially happening on non-existing channels) +- Fixed bug where reonnection timer would sometimes not be cancelled +- Fixed synchronization that could lock up the GUI when performing API requests +- Fixed username case-sensitivity issues for commands +- Fixed error in stream status writer when stream doesn't have a game set +- StreamChat: Fixed bug where stream chat wouldn't scroll down properly +- Addressbook: Fixed remove commands issues with case-sensitivity +- Run correct commercial length in Admin Dialog when using a hotkey +- Fixed close channel hotkey to close active channel rather chan active tab +- Possibly fixed some info messages from Twitch Chat not showing up +- Changed "Mr. Freeman" to "Dr. Freeman" +- Fixed rare error in tables (like Follower Dialog) +- Fixed and enabled workaround for some combining characters causing performance + issues (replacing more than two combining characters in a row with ****) ++ +
+New features: +- Added customizable hotkeys feature allowing you to add/remove/change hotkeys + in the settings (Global Hotkeys Windows only) +- Added Stream Chat dialog (only regular messages, optional message timeout to + make them disappear after some time, mainly for testing right now) +- Added support for global mods +- Added $chan parameter to Custom Commands +- Log to file: Added setting to customize timestamp (via setting commands) + +Changes: +- Changed inputbox font to prevent bug where fallback fonts wouldn't work + properly in JTextPane +- Changed default for "Restore dialogs" setting to "Restore dialogs from last + session" (only if you start from fresh settings) +- Backup: Increased setting backup count to 5 backups +- Changed staff usermode symbol to & (text symbol, not the badge) +- Added scaling to emotes if the image is too big, set maximum size to 100x50 +- Improved setting commands (added add/remove commands for String lists, save + default for lists/maps), improved help for setting commands +- Added "set:" commandline parameter to set any setting that can be set with the + /set command +- Changed to new BTTV emotes API +- Improved URL parsing a bit +- Updated help + +Bugfixes: +- Fixed Simple Title menu setting not being updated correctly +- Set foreground color of Viewer History based on the current foreground color + of the dialog, so it fits the LAF +- Set Notification foreground color to black, in case a LAF uses another color + that doesn't go well with the yellow background (Notification colors should be + customizable eventually) ++ +
+New features: +- User Dialog Buttons (Timeout/Custom Commands) now support shortcuts, Ban and + Unban buttons are not hardcoded anymore and have to be added to the setting + (setting is automatically changed if you switch from a version before 0.7.2) +- Added User/Line Selection feature to select a User in chat via the keyboard + so e.g. timeouts are possible completely via the keyboard +- Added feature to modify Addressbook entries via a file +- Added color restriction for Usericons +- Highlight/Ignore: Added prefixes ("start:", "status:", "!status:", "!cat:", + "chanCat:", "!chanCat") +- Channel Info Dialog now allows to be resized a lot smaller, Viewercount info + now adjusting better to smaller sizes +- Added setting to change Look&Feel (only Default and System for now) +- Added setting to attach dialogs to main window, so they always stay in the + same relative position when the main window is moved +- Added some keyboard shortcuts +- Added some support for FFZ feature friday, added /ffzGlobal command to show + global FFZ emote codes + +Changes: +- Added menu entry to open login configuration for easier access (no need to + disconnect from chat) +- Improved login configuration dialog +- When login was determined invalid by automatic check: Changed warning message, + don't remove automatically anymore but let user do it if necessary +- Added Options submenu to View menu to allow more options with direct access +- Added more options to Title/Game Presets dialog due to S'ome demand +- Logging to file now enabled by default (only if you start from fresh settings) +- MOD/UNMOD messages are now disabled by default (from fresh settings) +- Custom Commands executed from the Channel Context Menu now include the name + of the channel as first parameter (without leading #) +- Some small improvements of labels/info texts in Settings Dialog +- Increased join delay, increased delay between failed join attempts +- Ping connection more often if inactive to detect disconnect quicker and + possibly prevent disconnect in some cases +- Improved URL detection (again) +- Improved debug messages a bit +- Improved error catching in some places +- Added more tests +- Updated help + +Bugfixes: +- Fixed URLs that don't have a protocol prefix (e.g. http://) being opened + without a prefix, which resulted in the browser not opening correctly +- Fixed error in FrankerFaceZ emote parsing +- Fixed bug where "Close to tray" wouldn't work without "Minimize to tray" being + enabled as well +- Fixed layout problem in Settings Dialog when log path was too long +- Use usercolor corrected for readability for colored /me messages ++ + +
Favorites
+ page of the Emote Dialog. Right-click on the emote you want to add to
+ open the context-menu and click on Favorite
, then open the
+ Emote Dialog (Extra - Emoticons
or Ctrl+E
) and
+ choose the Favorites
page to view your favorites.exported
subfolder of the settings directory (so
+ e.g. C:\Users\name\.chatty\exported\
). If you are using
+ this feature e.g. by refering to the created textfiles in your
+ streaming software, you'll have to adjust the path to the textfile
+ there.+New features: +- Added Emoticon Favorites, that are displayed in the Emote Dialog (you can only + add Twitch Emotes for now, not FFZ or BTTV) +- Added support for correct capitalization of names in chat (experimental, you + have to enable it in the settings if you want to try it) +- Show correctly capitalized stream names in Live Streams/Channel Info Dialog + (independent of the Correctly Capitalized Names setting) +- Added minimize to tray/close to tray options +- Added setting for auto scroll down timeout length +- Added setting to change font size of dialogs (experimental, only Userinfo now) +- Added setting to customize chat log file location +- Added context menu to Follower/Subscriber Dialog to export list to file +- Added support for FrankerFaceZ global event emotes + +Changes: +- Changed tray icon to only show when needed +- Set proper tooltip for tray icon +- Added some more timestamp options +- Changed stream status writer output to "exported" subfolder of settings folder +- Changed stream status writer to ignore case of stream name +- Channel Info: Added approx. last stream length as tooltip to "Offline" text +- Changed Twitch badges to use images instead of alpha (shows new colors now) +- Changed base colors for badges to new Twitch colors (affects FFZ Mod Icon and + Fallback Icons) +- Allow for selection of text in chat by double-clicking (focus to inputbox now + only on single-click on chat) +- Detect a few more URL formats to be made clickable +- Improved debug logging a bit (memory usage) +- Some small improvements to memory usage +- Added some more characters to Font Selection Dialog, but also an input field + to enter your own text to test the font +- Catch the error if hotkey library couldn't be found and output warning instead +- Updated help + +Bugfixes: +- Fixed info messages sometimes going to the wrong window if popouts are used +- Fixed subscriber sorting in userlist (but overall sorting can still be screwed + up sometimes) +- Fixed wrong channel being joined when joining channel out of user context menu + with "Capitalize Names (First Letter)" option being enabled (fixed implicitly + by changing some stuff around for supporting capitalized names) +- Added workaround for Twitch emotes appearing wrong on Retina displays +- Nothing to do with Chatty in particular (it's the same for every IRC client), + but the "xy just subscribed" message should now work for everyone again, + because Twitch fixed it :) ++ +
Just a reminder: If you don't care about a correct userlist or joins/parts,
+ you may want to switch to Twitch Client Version 3 (Settings - Advanced
),
+ which has a few advantages.
+ More information..
+New features: +- Added Emoticon Dialog, showing emotes you paid for (Subscriber/Turbo) and + channel-specific emotes (FFZ/BTTV) +- Added Followers/Subscribers lists, added new follower sound (works only if + Followers Dialog is open) +- Livestreamer: Added setting to use auth (for sub-only streams), added setting + whether to open the Livestreamer Dialog when opening a stream from the menu +- Added setting to write stream info to a file (e.g. for display on stream) +- Automatically request moderator list once per channel, added /fixMods command + to temporarily fix mods status without showing the list of all moderators +- Added /host and /unhost commands +- Added shortcut Ctrl-W to close active tab/restore popout to tab +- Admin Dialog: Added option to automatically repeat commercial on the set delay +- Added stream uptime to Channel Info Dialog (how long ago a stream was started) + +Changes: +- Changed message parsing to support "<name> is now hosting you" notification + (only works on Twitch Client Version 3 though, see Settings - Advanced) +- Added setting to specify the timezone of the timestamp seperately from the + system timezone setting +- Added kadgar.net to open live streams from the context menu +- Added optional filter to remove combining characters used in some languages + that may cause an error in some cases +- Livestreamer: Reuse open tabs if process stopped and opening stream with the + same stream/quality, re-enable quality selection buttons if process stopped, + improved labels and help +- Added more timestamp options in the settings and changed to showing as example +- Added gzip support to Twitch API requests +- Added check to confirm status of stream going offline, which may or may not + prevent wrong offline notifications if the Twitch API returns false data +- Added hint about entering Twitch Commands in invalid command message +- Updated help + +Bugfixes: +- Fixed error in message parsing +- Fixed display error with ban messages +- Fixed a possible bug with notifications +- Now showing "<number> /host commands remaining this half hour." message ++ + +
+New features: +- Added support for some of the BetterTTV emotes +- Added feature to ignore indiviual emotes, which makes them not turn into an + image (but their code will still show up) +- Changed game select dialog to one single list for favorites/search as to not + waste so much space +- Added setting to change the livestreamer command (so you can also e.g. set the + full path to Livestreamer if necessary) +- Added option to combine ban messages of the same user within 10 seconds, for + example "<name> has been banned from talking (3)" means banned 3 times +- Added "/ab change" command to add/remove/toggle categories in a single command +- Added /uptime command +- Added /openUrl and /openUrlPrompt commands (for use in custom commands) +- Added ignore setting to not show ignored messages info (count/nick) in chat if + the ignored messages dialog is currently open + +Changes: +- Live Streams window always on top of main window (seems a bit flickery though) +- More Dialogs now closeable with ESC +- Added Ctrl+J shortcut for opening Join Dialog +- Save Channel Favorites sort order between sessions +- Increased number of saved lines per user from 20 to 100 +- Reorganized Settings Dialog a bit (Usericons/Emoticons on seperate pages) +- Added context menu to Race Id (blue link) in Race Viewer +- Possibly improved debugging of emoticon loading errors a bit +- Updated help + +Bugfixes: +- Search dialogs (Ctrl+F) fixed for popouts +- Fixed error on update notification +- Improved API response parsing a little bit +- Fixed context menus in Highlights/Ignored Messages dialogs ++ + +
+New features: +- Ignore messages (similiar to the Highlight system, match messages by keywords, + usernames, addressbook categories and channels) +- Improved Emote Context Menu (now with channel name on subemotes and clicking + on emote code inserts it in the input box) +- Improved subscriber detection on Twitch Client 1 +- Improved Update Notification to now also show in the Main Menubar (clicking + on it opens a window showing the changelog) +- Livestreamer Context Menu quality selection now customizable +- Added some commands (including /ffz to show FFZ emotes of the current channel, + some commands to open dialogs and stuff intended for use in Custom Commands) + +Changes: +- Addressbook categories are now all made lowercase when added/loaded from file +- Regular commands can now be also used in Context Menus/User Dialog settings +- Improved error handling a bit (hopefully) +- Removed Ignore Joins/Parts setting in favor of Twitch Client 3 +- Changed Twitch Client 1/3 setting to include small explanation +- Added sort by viewercount in Live Streams Dialog +- Added chan: and !chan: prefixes (Highlights and Ignore) +- Updated help +- Show how many Highlighted/Ignored messages are in the dialogs in the View-menu +- Improved text settings editor (auto adjust size when typing, added help) +- Changed Context Menu/User Dialog settings to allow more flexible formatting + (linebreaks allowed, / for command optional, | for seperator doesn't have to + be directly in front of a command, but still applies to the following one) +- Moved to new FFZ server and updated parsing (recently added emotes should now + show up) + +Bugfixes: +- Fixed horizontal scrolling sometimes happening in chat window +- Fixed URL Context Menu stream detection to be case-insensitive +- Fixed display of "<" in Notifications +- Hopefully fixed possible display error ++ +
+New features: +- Reworked usericon (badges) system, which also allows custom usericons, + either replacing the default ones or adding some of your own +- Added Custom Commands, which allow you to define aliases for anything you + can enter into the inputbox (like chat messages, commands) +- Added settings to add Custom Commands to the User/Channel Context Menus and + changed Timeout buttons setting to also add Custom Commands to User Dialog +- Added option to always show the chat scrollbar, which can be useful for + streamers who always want to capture the same subregion of the window +- Added /clearchat command which clears all text from the current chat window +- Added settings for what to do when Chatty is started (show connect dialog + or connect immediately and autjoin channels etc.) + +Changes: +- Only show the "<user> has been banned from talking" message for users that + are currently known in the channel (that have said something, have joined, + been modded, etc.) +- Removed hardcoded /slap command, but added it as default to Custom Commands +- Removed "Set color" entry from User Context Menu, but added /setcolor + command (so it can be readded using Custom Commands if necessary) +- Updated help +- Changed list settings editor (used for Highlights, Logging, Commands) +- Reorganized Settings Dialog a bit +- Updated /testNotification command to also allow for a channel parameter +- Changed Highlight Notification to switch to the channel the highlight + originated in (similiar to Stream Status Notifications) +- Regular commands now case-insensitive +- Handle image URLs which may brake due to possible changes in the Twitch API +- Added /echo command to just output text as info message (e.g. for testing) + +Bugfixes: +- Fixed speedrun.tv Race Link in SRL Race List context menu +- Made "Races with.." search case-insensitive +- Fixed possible flickering of chat window when being scrolled up +- Remove linebreaks from messages send to the server +- Fixed some possible display bugs in Settings Dialog +- Right-clicking on emotes now works on the whole emote ++ +
SRL
-menu.Extra
-menu)
+ and optional context menu entry.+New features: +- Added SpeedrunsLive (SRL) race viewer +- Added automatic settings file backup (copies settings to the /backup folder + when you start Chatty, at most once per day) +- Added Livestreamer support (start Livestreamer out of dialog/context menus) +- Added feature for unique addressbook categories under some circumstances +- Added "Simple Title" setting to have only "Chatty" as title (Extra menu) + +Changes: +- Improved debug logging (added append to current file, max file size, rotate + between several files when max file size is reached) +- Improved scrolling when window is made smaller +- Added small delay between joins, automatically rejoin if join failed, added + "Joining #channel.." message (which indicates a JOIN was send to the server) +- Some smaller improvements +- Added commands to open the current settings/working directory +- Updated help + +Bugfixes: +- Possibly maybe fixed bug with default userlist width, but it can still be a + bit finicky +- Fixed bug in Channel Favorites dialog when table is empty +- Fixed /myemotes command +- Fixed bug when joining channel out of popout ++ +
Close
but also
+ Popout
the channel.30s
button if the Admin Dialog is open on the
+ Commercials tab.+New features: +- Popout channels into their own window to be able to view them side-by-side +- Added context menu and improved sorting to Channel Favorites dialog +- Added check whether window restore position is actually on a screen (if not + then open on default position) +- Added Highlight prefix to cutomize color for individual highlight items + (also added ordering buttons that can be necessary for this feature) +- Added navigation buttons with page history to Help window +- Added command to manually refresh emoticons (and badges if you rejoin) +- Added command to show a list of your subemote codes (better emote + integration possibly maybe soon) +- Added option to show action messages (/me) colored like in webchat + +Changes: +- Commercials hotkey now simulates a click on the 30s button if the + Admin Dialog is open on the Commercials tab (so you can also use a delay) +- Added more information to the emote context menu (unfortunately you have + to right-click on the left side of the emoticon to open it) +- Changed default access options to all selected (you can still deselect them if + you don't need them and you think it's safer not having them on the token) +- Decreased scrolling step a bit +- Improved scroll detection for scrolled up timeout +- Improved main window title change responsiveness +- Some small improvements +- Reorganized and updated help + +Bugfixes: +- Fixed some possible errors by adding some checks +- Fixed bug when adding a usercolor (not correctly enabled Done button) +- Fixed bug canceling the list item edit dialog (highlights/logging) ++ +
Chat Client Version 3
option in the Settings
+ Dialog under Advanced
. More information..+New features: +- Admin Dialog: Select previously used or favorited stream status (title/game) + from the presets dialog for your title changing convenience +- Optional new chat version that has no joins/parts but has better channel + association for bans/timeouts/subscribers and "xy just subscribed" message +- Added /slap command due to S'ome demand +- Improved connecting to chat (automatically trying different servers/ports) +- Added more shortcuts and stuff +- Added option to rejoin currently open channels when connecting + +Changes: +- Moved Ignore joins/parts option to settings dialog +- Some small improvements +- Updated help + +Bugfixes: +- Hopefully fixed synchronization error +- Fixed error when editing game favorites +- Fixed error when no stream title is set ++
+New features: +- Added Addressbook to associate name with categories, that can be referenced + from usercolor settings and highlight settings +- Added usercolor settings to locally assign custom usercolors +- Option to restore dialog positions/reopen dialogs on start + +Changes: +- Improved setting for timeout buttons/added to GUI, improved timeout messages +- Highlight: Default username now matching on word bounds, added word bounds + matching prefixes, added highlight next messages +- Reorganized settings dialog to accomondate new settings/features +- Updated help +- Parse /mods response to make users mods +- Improved Named Colors panel in color chooser +- Added Ctrl-Shift-Tab to switch to previous channel +- Added server/port settings +- Added setting to enable/disable stream status messages in chat + +Bugfixes: +- Fixed FrankerFaceZ mod icon parsing to reflect recent changes +- Fixed parsing error +- Fixed userstats max length +- Added scrolling to "Removed Streams.." list ++ + +
+New features: +- New more flexible notifications that replace the system tray notifications + (you can still switch back to them though) +- Added chat logging to record messages and stream/chat infos to file +- Added Spam Protection +- Admin Dialog: Relative times, use own channel when no channel is joined, + last commercial run time, improved several channels support, dialog + not modal anymore, configurable commercial run delay, added help +- Added message sound, load sound file names from sounds folder, improved + sound settings, changed volume values (you may need to adjust your volumes) +- Check if connection was lost a bit faster depending on previous activity +- Added new error dialog +- Show important release information on first startup of new version + +Changes: +- Changed shutdown process +- Improved settings dialog (help, icons, components, restart required + warning) +- Remove additional whitespace from incoming messages +- Replace some special html character codes in incoming messages +- Default userlist width setting, userlist width 0 now possible +- Always output stream status on join (not only if it's new) +- Improved help +- Added setting to enable (and thus disable) open url prompts +- Added Copy URL option to url prompt +- Added setting to highlight own messages (always enabled before) +- Added setting to change the tabs order (join order/alphabetical) +- Added context menu item to clear the highlights dialog +- Fixed bug in ViewerHistory when item was still hovered when channel + was changed +- Added help window icon +- Count number of mods on /mods-command response +- Prevent auto-scrolling when search is active +- Added speedrun.tv option for stream urls ++ + +
Changes: +- FrankerFaceZ: Show custom mod icons (available in some channels) +- FrankerFaceZ settings, Emoticons/Icon settings seperate +- Prevent dialogs that can open automatically (error messages) from + stealing focus +- Added chat buffer size setting +- Added setting to enable/disable mod/unmod messages +- Added some shortcuts +- Added command to show working directory +- Added color preset +- Improved help +- Improved viewer history (fixed times per channel) +- Improved debug output +- Added command/guide in case getting login data doesn't work + +Bugfixes: +- Fixed error in Viewer history ++ + +
<Read user info>
access to
+ be able to use that. Go to
+ <Main - Connect - Configure login..>
, remove the
+ login and request it again.<Main - Settings - Notifications>
if you have the
+ necessary access.+New features: +- Get notified when streams you follow go online (requires + <Read user info> access, which wasn't even in Chatty before, so you'll + have to request new login data) +- View a list of live streams (you followed or whose channel you are in) +- FrankerFaceZ emoticons +- Added search, allowing you to find text in the current chat window +- Deleted messages (from timeouts/bans) now get shortened to a maximum length, + or you can use the previous behaviour or let the whole message be replaced + with <message deleted> +- Change the displayed time range in Viewer History +- Automatically check if the login is valid, if it is suspected not to be +- Clickable links in Channel Info Dialog (also turns #srl-abcd into a race link) +- Cycle between tabs with Ctrl+TAB + +Changes: +- Updated Help +- Changed Settings Dialog Layout +- Detect subscribers even when in more than one channel (may not work correctly + always, but it's a better guess than before) + +Bugfixes: +- Changed color of inputbox cursor to foreground color +- Possibly made emoticon image loading a bit more reliable, but it's hard to + tell what happens when the loading fails +- Handle long URLs in the URL open dialog better ++ + +
+New features: +- Added version checker to inform you about new versions of Chatty +- Added window icon +- Added colors to viewer history to indicate stream status changes, hovering + displays stream title/game at that time (in addition to viewercount/time) +- Stream information is now requested for all channels you have currently joined +- Added tray notifications for highlighted messages and stream status changes +- Added sound notifications for highlighted messages and stream status changes +- Added some commandline parameters, settings and context menu entries + +Changes: +- Nicks in JOIN/PART/MOD/UNMOD lines now clickable +- Settings now saved in seperate files for general settings, login data and + history/favorites +- Fixed tab colors, added indicator for new stream status +- Added delay for global hotkey so it doesn't repeat as much if kept pressed +- Updated and improved help +- Added Mod/Unmod buttons to user dialog (only in your own channel) + +Bugfixes: +- Fixed bug where a status change could reopen a tab that couldn't be closed +- Improved error handling for API responses +- Fixed bug where focus sometimes wouldn't be on inputbox when changing tabs or + clicking in channel ++ + +
+New features: +- Added Admin Dialog that let's you change the title/game of your stream + and run commercials (optional global hotkey for running commercials) +- Added Channel Favorites/History that automatically saves channels you joined + and also allows you to add favorites (history can be deactivated in the + settings) +- Added Highlight system that makes a message appear in another color if defined + keywords are found in it and/or it was send by a defined user (defaults to + always highlight your own name) +- Added join dialog +- Messages from user "twitchnotify" as info messages (when someone subscribed) +- Added Warning when joining more than one channel +- Added context menus for nicks/links/channel/tabs +- Restore window position from last session +- Better debugging and error handling +- Automatically scroll down after 30s of inactivity when being scrolled up + +Changes: +- User Info Dialog: Auto-update message history, show bans, show channel context +- Lowered stream info (title, game, viewercount) update delay to 120s +- Improved default user colors +- Emoticons that contain only word characters match at word boundaries (to match + the new behaviour in Twitch Webchat) + +New settings: +- Option for capitalized names +- Option to show ban message (.. has been banned from talking), defaults to not + showing it +- Color GUI settings (with default and dark preset) +- And of course quite a few for the new features/bugfixes + +Bugfixes: +- Fixed bug where channels would re-open without being + able to close them +- Fixed bug where the userlist wasn't loaded correctly on join + when the channel was joined before in the same session +- Disabled Direct3D Hardware Acceleration by default to possibly + fix Chatty appearing completely black under certain circumstances ++ +
First published version was 0.2 so changelog starts from version 0.3.
+ + + diff --git a/help/0.8.3b/help-setting_commands.html b/help/0.8.3b/help-setting_commands.html new file mode 100644 index 0000000..736536e --- /dev/null +++ b/help/0.8.3b/help-setting_commands.html @@ -0,0 +1,576 @@ + + +There are a couple of commands that allow you to change settings from + the chat inputbox. (You should probably roughly know what you're doing + before using these.)
+ +/set <setting> <value>
changes a setting/get <setting>
shows the current value of a
+ setting/reset <setting>
resets the setting to the
+ default (hard-coded) value/clearsetting <setting>
sets string settings to
+ an empty string/add <setting> <value>
adds item to a list
+ of strings/numbers/remove <setting> <value>
removes item from
+ a list of strings/numbersTip: You can use TAB Completion + for setting names when using it behind a setting command.
+ +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.
+ +Settings with a slightly darker background color
+ 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 lighter color 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 /get
.
+ Font | + Time | + Server/Connection | + Chat | + Window | + Stream Chat | + Stream Highlights | + Debugging | + Bot Badges | + Copy Messages +
+Setting | +Type | +Values | +Default | +Description | +
---|---|---|---|---|
dontSaveSettings | +Boolean | +false | +Don't save settings when Chatty is closed (-ds commandline option). |
+ |
timeoutButtons | +String | +See Command Settings Help | +too long | +Buttons in the Userinfo dialog (not only timeout buttons) | +
userContextMenu | +empty | +Custom entries in the User Context Menu | +||
channelContextMenu | +empty | +Custom entries in the Channel Context Menu | +||
twitchnotifyAsInfo | +Boolean | +true | +Show messages from user "twitchnotify" as info messages. + Turn off to show as regular message, so you can e.g. highlight + it. | +|
backupDelay | +Integer | +Number of days | +1 | +How many days to wait between a Backup | +
backupCount | +Integer | +Number of backups | +5 | +How many backups to rotate through | +
hotkeys | +List | +Cannot be edited by command | +The hotkeys that are currently defined | +|
globalHotkeysEnabled | +Boolean | +true | +Enable global hotkeys that are defined in the settings. + Disable this to temporarily turn off the global hotkeys you + defined. | +|
imageCache | +Boolean | +true | +Whether images (emotes, usericons) are cached in local + files. | +
Setting | +Type | +Values | +Default | +Description | +
---|---|---|---|---|
font | +String | +Font name, e.g. Arial or Arial Bold |
+ Consolas | +The font used for the chat | +
fontSize | +Integer | +Font size, e.g. 14 |
+ 14 | +The font size used for the chat | +
lineSpacing | +Integer | +Numbers between -1 and 10 probably
+ make the most sense. |
+ 3 | +The space between chatlines | +
inputFont | +String | +Font name and size, as understood by Font.decode() | +Dialog 14 | +The font for the chat input box (should only be set to
+ Java logical fonts like Dialog or
+ Monospaced , otherwise fallback fonts in
+ chat may not work correctly*) |
+
dialogFontSize | +Integer | +Font size or -1 to keep default |
+ -1 | +Setting to customize the font size of dialogs, currently + experimentel and only for User Info Dialog. | +
* 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 add your own fallback fonts + 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).
+ +Setting | +Type | +Values | +Default | +Description | +
---|---|---|---|---|
timestamp | +String | +Format as understood by
+ SimpleDateFormat
+ or off |
+ [HH:mm] | +The timestamp used for all lines in chat | +
timestampTimezone | +String | +As understood by Timezone.getTimeZone()
+ e.g. GMT+2 or PST |
+ empty |
+ The timezone used for the timestamp |
+
logTimestamp | +String | +Format as understood by
+ SimpleDateFormat
+ or off |
+ [HH:mm:ss] | +The timestamp used for all lines in the chatlog files | +
Setting | +Type | +Values | +Default | +Description | +
---|---|---|---|---|
serverDefault | +String | +The server address, host or IP | +irc.twitch.tv | +Default server to connect to, which can be changed in + the Settings Dialog and is saved between sessions | +
portDefault | +String | +One or more ports, seperated by comma | +6667,80 | +Default port to connect to, which can be changed in the + Settings Dialog and is saved between sessions | +
server | +String | +The server address, host or IP | +empty | +If set, overrides the defaultServer , can be
+ set by commandline options, not saved in between sessions |
+
port | +String | +One or more ports, seperated by comma | +empty | +If set, overrides the defaultPort , can be
+ set by commandline options, not saved in between sessions |
+
username | +String | +Your username | +empty | +Public part of the Login data + to login into chat | +
token | +String | +OAuth token | +empty | +Secret part of the Login data
+ to authorize with Twitch, don't show this to anyone. You
+ shouldn't change this directly, but use the /changetoken
+ command instead when manually setting the token. |
+
spamProtection | +String | +messages/seconds, e.g. 10/20 |
+ 18/30 | +How many messages Chatty allows you to send to the server + in the given time, to prevent a ban from chat | +
membershipEnabled | +Boolean | +true | +Refers to the twitch.tv/membership 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) |
+
Setting | +Type | +Values | +Default | +Description | +
---|---|---|---|---|
pauseChatOnMouseMove | +Boolean | +false | +Enables the Pause Chat + feature | +|
pauseChatOnMouseMoveCtrlRequired | +Boolean | +false | +Require Ctrl to be pressed to start pausing + chat | +|
commandOnCtrlClick | +String | +Command to run (only the command name) | +empty | +The command to run when clicking on a user while holding + Ctrl | +
Setting | +Type | +Values | +Default | +Description | +
---|---|---|---|---|
windows | +Map | +Cannot be edited by command | +The windows/dialogs positions/sizes as they where loaded + when you started Chatty (NOT necessarily the current ones). | +|
tabOrder | +String | +normal , alphabetical |
+ normal | +How tabs are added (in the order they are added or + alphabetical). | +
tabsMwheelScrolling | +Boolean | +false | +Scroll through tabs with mousewheel. | +|
tabsMwheelScrollingAnywhere | +Boolean | +false | +Allow scrolling through tabs with mousewheel everywhere + on the tabpane where nothing else can be scrolled (mainly + the inputbox). | +
Setting | +Type | +Values | +Default | +Description | +
---|---|---|---|---|
streamChatChannels | +List[String] | +Channel name (with leading #) or empty | +empty | +Forwards messages from the given channels to + Stream Chat. | +
streamChatMessageTimeout | +Integer | +Number of seconds, negative to disable | +-1 | +How long messages are displayed before they disappear + from Stream Chat. | +
streamChatBottom | +Boolean | +true | +Start inserting messages at the bottom. Messages are + always inserted below previous messages, but disabling this setting + will make them start at the top. Requires a + restart of Chatty after changing to take any effect. | +|
streamChatResizable | +Boolean | +true | +Whether the Stream Chat dialog is resizable by dragging + the edges. | +
Setting | +Type | +Values | +Default | +Description | +
---|---|---|---|---|
streamHighlightChannel | +String | +Channel name (with leading #) or empty | +empty | +Allows moderators in the given channel to run the + !addStreamHighlight command. | +
streamHighlightChannelRespond | +Boolean | +false | +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. | +|
streamHighlightCommand | +String | +The command to use for moderators | +!addstreamhighlight | +Change this to define the command that can be used by
+ mods to add stream highlights in the channel defined with
+ the streamHighlightChannel setting. |
+
Setting | +Type | +Values | +Default | +Description | +
---|---|---|---|---|
debugLogIrc | +Boolean | +false | +Log raw IRC messages in the Debug Window. | +|
debugLogIrcFile | +Boolean | +false | +Log raw IRC messages to the debug_irc.log file in the + settings directory. | +
Setting | +Type | +Values | +Default | +Description | +
---|---|---|---|---|
botBadgeEnabled | +Boolean | +true | +Show bot badge in chat for known bots. | +|
botNames | +List[String] | +Name of the bot | +some default names | +List of locally defined known bots. You have to restart + Chatty for changes to take effect. | +
botNamesBTTV | +Boolean | +true | +Use bot names from BTTV API. BTTV emotes have to be enabled for this to work. | +|
botNamesFFZ | +Boolean | +true | +Use bot names from FFZ API. FFZ emotes have to be enabled for this to work. | +
This can automatically copy all incoming messages into the clipboard.
+Setting | +Type | +Values | +Default | +Description | +
---|---|---|---|---|
cmEnabled | +Boolean | +false | +Enable/disable the copy messages feature altogether. | +|
cmChannel | +String | +Channel Name (including leading #) | +empty | +Restrict copying messages to this channel. Leave empty + for no channel restriction. | +
cmTemplate | +String | +Template for the copied text | +{user}: {message} | +This is the template for what is put into the clipboard.
+ {user} is replaced with the name of the
+ user who send the message, {message} is
+ replaced with the text of the message itself. |
+
cmHighlightedOnly | +Boolean | +false | +Only copy highlighted messages. | +
Main + | Messages + | Chat + | Emoticons + | Usericons + | Usercolors + | Highlight + | Ignore + | Sounds + | Notifications + | Log to file + | Window + | Commands + | Other + | Advanced + | Hotkeys + | Completion
+This page details some of the settings in the Settings Dialog
+ (Main Menu - Settings
). Also try hovering over settings
+ in the settings dialog itself, sometimes you can get a tooltip with some
+ additional information. You can open this help in the settings dialog by
+ clicking on the "Help" link on the bottom left.
Change font and font size by clicking on Select font
.
Input font is restricted to two fonts by default, because other fonts + cause issues due to a bug in Java. The number behind the font is the + font size. You can manually change this setting via + Setting Commands (as with most + settings) if you really need another font, but pay attention to the + note about the adverse + effects it may have.
+ +You can select what will happen when you start Chatty:
+This allows you to define how timeouts or bans are displayed in Chatty.
+Tip: Click on a username in chat to open the User Info Dialog, + which also shows the timeouts/bans and the original messages.
+Please Note: The timeout duration/reason is in Beta at + Twitch, so stuff may or may not change at some point and break + the display in Chatty. Telling the difference between a timeout and + permanent ban also depends on this, so if this info isn't available + users who were just timed out may be shown as banned.
+<message deleted>
.[12:30] Spammer: Deleted spam message Long copy pas..
[23:12] Spammer: spam message (10m)
[23:12] Spammer: spam message (banned)
(permanent ban)[23:12] Spammer: spam message (10m)*
[23:12] Spammer: spam message (banned) [rude tbh]
[23:12] Spammer: spam message (10m) [emote spam]
<name> has been timed out
<name> has been banned
(permanent ban)<name> has been timed out (3)
.<name> has been timed out (60s)
<name> has been banned [rude tbh]
<name> has been timed out (600s) [emote spam]
+ /set timestamp <format>
. The format can be anything
+ specified by the Java
+ SimpleDateFormat
+ class.Advanced - Correct Userlist
is enabled).Names in Twitch Chat are send all-lowercase by default, however there is + an IRCv3 tag send with each message with the display name which Chatty + can use to show correct capitalization. You have the following settings:
+The previous function that requested correctly capitalized names from the
+ Twitch API has been removed. This also means that the associated commands
+ (/refreshCase
, /setCase
and /getCase
)
+ have been removed as well. If you want to customize the capitalization of someone else's
+ name locally, you can now use the Custom Names feature.
+ The names in the userlist will not be correctly capitalized until Chatty has
+ received a message from that user during this session.
<x>
seconds of inactivity: 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.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.
+ +Please note: 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).
+ +Chat is paused as long as you move the mouse over chat or if you hold + Ctrl (and initiated pausing by moving the mouse). A little + popup in the top-right will indicate that the chat is paused.
+ +Holding Ctrl basicially acts as if you moved the mouse + continuously.
+ +Emotes added to this list will not be turned into an image, but instead + are just shown as their emote code.
+The code added to the list has to be the
+ exact code used internally to find the emote in the messages. Usually this is simply
+ the emote code as you would type it in chat, but some emotes have a special syntax
+ that you might not even know (e.g. :)
has \:-?\)
as actual code).
+ It is recommended to use the emote context menu (right-click on an emote in chat) to
+ ignore emotes, because then the correct code will automatically be added to
+ the list.
botNames
+ setting, the BTTV API and the FFZ API.
+ By adding entries to the table you can either replace the default icons (Mod, Turbo, Subscriber, ..)
+ or add additional icons for certain users or addressbook categories. The order
+ of the entries can matter, they are matched from the top, so if more than one
+ icon matches that is supposed to replace a default icon, then the first one
+ is used. If more than one Addon
icon matches, then all are used
+ (unless you use the $stop
restriction, see section Restriction below).
You have the following options when you add/edit an item:
+Moderator, Subscriber, Turbo, ..
) or if
+ it should be an additional icon added after the default ones (Addon
).
+ Currently, you can have as many Addon-Icons as you want and they are
+ all displayed at once (if they match the requirements of course).serenity
) or an
+ addressbook category (e.g. $cat:vip
, which would refer to
+ the category vip
). If you keep this empty, then no restriction
+ is applied.Addon
carries an
+ implicit restriction, since e.g. the default moderator icons are only
+ displayed if the user is a moderator.Addon
+ icons:
+ $stop
means if this icon matches (and is thus used),
+ it stops searching for further Addon
icons. So
+ it's not really a restriction for this icon, but
+ rather a restriction that affects the following icons and
+ can be used to limit the number of Addon
icons.$first
puts this Addon
icon before
+ the regular icons. The $stop
restriction only
+ applies to one group of Addon
icons separately
+ (before or after the regular icons).$cat:streamer $first
, lotsofs
!#channel
) to have
+ it displayed in all channels except the one you specified. If you keep
+ this empty, then it will be displayed in all channels..png
and
+ should usually be about 18x18 pixels (because that is the size of the
+ default icons). The image files are looked for in the /img
+ subfolder of the working directory (similiar to the /sounds
+ folder). You can click on Image Folder
to show information
+ about it and rescan it to update the list of images in the dropdown menu.$ffz
which will
+ make it use a FrankerFaceZ icon for that, if available (this only really
+ applies if you use the Type Moderator
and want to
+ replace the moderator icon in all channels execept the ones that have a
+ FFZ Mod Icon).http
is interpreted as URL.This allows you to specify your own usercolors for either certain types + of users (mod, subscriber etc.) or specific usernames. There are special + items that you can use to specify that (to specify a username, just enter + it without anything else):
+$mod
- Moderators$sub
- Subscribers$turbo
- Turbo Users$admin
- Admins$staff
- Staff members$all
- All users, this can be used to specify a default
+ color (should be put at the very end of the list)$broadcaster
- Broadcasters$cat:<category>
- A category from the Addressbook#<color code>
- A Html color code, e.g. #0000FF
for blue, which can
+ be used to replace colors$color:<color code or name>
- A Html color code or name (names
+ as hardcoded into Chatty, may be different from other programs), e.g. $color:Blue
for blue,
+ which can be used to replace colorsThe order of the
+ entries in the table matters, because it is checked from the top. If you
+ were to put the $all
item at the very top, any items below
+ wouldn't do anything, because the first item would already match all users.
+ This e.g. allows you to specify what color a user should have when he is
+ both a subscriber and a moderator (by either putting $mod
+ or $sub
first).
If an item is red and has "(error)" appended (e.g. "$color.Blue (error)"), + this means the item is invalid. In the example this is because a point has + been used instead of a colon, so "$color:Blue" would be correct. This can + also happen if it doesn't recognize the given color or the item is just in + an invalid format.
+ +user:
+ prefix with your own name.Add items to the list to make a message highlighted if any one of them + match the message. The following two types of prefixes can be used to change + highlighting behaviour per item.
+ +By default, matching is done case-insensitive and when the word or phrase + appears anywhere in the message. However, you can add the following + prefixes in front of the text to change this matching behaviour. You can + only use one of these prefixes per item, because all text following the + prefix is interpreted as text to match.
+cs:
makes it case-sensitive, so cs:test
+ matches test
but not Test
.w:
matches at word boundaries, e.g. w:anna
+ will match anna
or Anna:
but not
+ Hannah
or annah
. (Is actually just a
+ shortcut for a special regex, so special regex characters will work.)wcs:
is the same as w:
, but case-sensitive.start:
to match at the start, so start:!bet
will
+ match messages starting with !bet
.re:
to use a regular expression, e.g. re:(?i).*\bGTA ?[V5]\b.*
+ to match GTA5, GTA 5, GTA V, gta5, .. (as a word) anywhere in the message. Note
+ that the regex always tries to match the entire message, so you have to
+ add the appropriate wildcards to match parts anywhere in the message.The following prefixes mostly influence which messages are matched, + however they don't change the matching of the text itself, but instead + provide other information for the highlight system. They can be + placed in front of the Text Matching Prefixes (or the text if you don't + have any other prefixes) and you can even use more than one per item. + These prefixes have to be seperated from eachother and the text by a + space.
+user:
to specifiy one exact username (case-insensitive)
+ which should highlight only if this user send the message, doesn't
+ search in the message itself.cat:
to specify a category the user who send the message
+ should be in (as defined in the Addressbook).!cat:
to specify a category the user who send the message
+ can NOT be in.chan:
to specify one or more channels the message has
+ to be send in to match (several channels are specified as comma-seperated
+ list, without spaces).!chan:
to specify one or more channels the message must
+ NOT be send in to match.chanCat:
to specify one category the channel the message
+ was send in has to be in (as defined in the Addressbook
+ with the name of the channel, including leading #).!chanCat:
to specify one category the channel the message
+ was send in can NOT be in.status:
to specify that the user has to have one of the
+ given status codes (case-sensitive):
+ m
Moderators
Subscribera
Adminf
Staffb
Broadcastert
Turbo Userg
Global Moderatorr
Bot as in Robot (depending on what the FFZ/BTTV APIs provides (if
+ enabled) and values in the botNames setting)M
User with any kind of moderator/special powers
+ (so Broadcaster/Moderator/Global Moderator/Admin/Staff combined)status:st
matches
+ all subscriber and turbo users.!status:
to specify that the user must NOT have any of
+ the given status codes (see status:
for codes). For example:
+ !status:stM
matches all 'normal' users that have no
+ badge by default (NOT a Subscriber, Turbo User or any kind of Moderator).color:
to specify a color other than the default one
+ for displaying this highlight. If you have items with a custom
+ color defined, which match something that might also be matched
+ by other items (with another color or custom color)
+ then the order of items is important so it displays the desired color.
+ Items on the top are matched first, so move items up that should take
+ precedence. For example test
and
+ color:blue test2
. If test
is on the top
+ it will never get to the blue one, because test
will
+ always match when test2
would match as well.config:
to specify one or more options (seperated
+ by comma) that changes the behaviour):
+ silent
- Disable sounds for this item!notify
- Disable notifications for this iteminfo
- This item applies to info messages instead
+ of regular user messages (works only for Ignoring messages at the
+ moment)word1 word2
word1 word2
, Word1 word2
anywhere in the messageword1
or only word2
anywhere in the messagew:anna
Anna?
, Anna :D
, Anna,
Wanna?
, Hannah
, annah
user:joshimuz cs:Hello
Hello
anywhere in the message, if the message was sent
+ by the user named joshimuz
hello
cs:Hello user:joshimuz
Hello user:joshimuz
anywhere in the messageHello
, does NOT matter who send the messagecs:abc re:\w+
abc re:\w+
anywhere in the messageabc test
, but also NOT Abc re:\w+
re:abc \w+
abc test
aabc test
re:.*abc \w+.*
abc test
anywhere in the messagecolor:yellow wcs:S
S:
, Hello S!
and makes the message
+ display in yellow colors:
, Hello s!
, SSSS
, ssss
chan:lotsofs,joshimuz cs:Hello
Hello
, but only if in
+ the channel #lotsofs
or #joshimuz
status:s chanCat:vip start:!test
!test
send by
+ subscribers of the channel, but only if the channel is in the
+ Addressbook category vip
(e.g.
+ /ab add #joshimuz vip
, notice the leading #
)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 View - Ignored
.
+
The matching of messages works the same as the Highlights + system, please see that help for information on that. For quick + reference here just a few examples: +
+ +user:name
name
in all channelsuser:name chan:tirean,gocnak
name
in channels #tirean
and #gocnak
config:info subscribed to
x has subscribed to y
info messages that
+ you get when someone subscribes in the channel that is being hostedcat:ignore !chan:lotsofs,joshimuz
ignore
in all channels,
+ except #lotsofs
and #joshimuz
chan:joshimuz re:!bet.*
!bet
, but only in #joshimuz
!status:smb chanCat:subonly
subonly
(e.g. /ab add #joshimuz subonly
,
+ notice the leading #
)Ignored
dialog)The Ignored Users
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.
Ignored users are independant of the main ignore list, so they also apply + if ignore is disabled.
+ +You can enable or disable all sounds here. Sounds are searched in the
+ displayed folder, which is the current working directory. Any valid sound
+ files in the folder should be selectable as a sound to be played. If you
+ added or removed files, you may have to use Rescan folder
to
+ make the files show up in the list. You can open the folder in your standard
+ file browser from here to add files to it more quickly.
You can specify requirements, soundfile, volume and delay for + different types of events:
+You can set a delay (seconds) so that the same sound won't be played twice during + the set number of seconds. So if e.g. 3 highlighted messages come in within + 10 seconds and the delay is set to 15 seconds, only one sound will be played.
+ +Each sound has different options for when the sound should be played. See + the Notification Settings for help on the options.
+ +You can show notifications for two kinds of things:
+For both these you can select separately if and when they are shown:
+In addition, the option Don't notify about "Stream offline" allows you + to never show when a stream changes status to offline, so you will only be + notified about streams going live or changing title/game.
+ +Select here whether to use the Chatty Notifications or the default + System Tray Notifications. This settings DOES NOT enable or + disable notifications altogether, just switch between the types.
+If you have Chatty Notifications selected, you can change some + more options:
+auto
means
+ it's on the same screen as the Chatty window)Enable this to make Chatty get a list of your followed streams regulary + so it can display notifications if their status changes. This simpy allows + Chatty to know about your followed streams, so notifications aren't the only + advantage. It also allows it to record the viewer count and status history + of followed live streams as long as Chatty is running.
+ +If you enable logging, chat messages (and more if enabled) will be written + into a seperate textfile for each channel.
+You can specify which channels should be logged:
+Normal chat messages are always logged, however you can log additional + information:
+[12:32:25] BAN: name, name2
[12:32:25] MOD: name1, name2
[12:32:25] JOIN: name1, name2
[21:06:21] Viewerstats (21:03-21:06): avg:28.612 min:28.432 max:28.887 [3/28.519-87+455_]
).[15:23:58] VIEWERS: 12521
Main - Exit
or the tray icon
+ context menu.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:
+ +/<commandName> <what the command should do>
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:
+ +/hello Hello World!
If you added that to the custom commands and enter /hello
+ in the inputbox, then it would send Hello World!
, just as
+ if you would have written it yourself and pressed Enter.
You can also specify parameters in the command text, which will be replaced + when you execute the custom command. For example:
+/permit !permit $$1
When you enter /permit name
, then it will replace $$1
+ with the first word after the command, which in this case would be
+ name
, making the actually send text !permit name
.
This is the syntax for specifying parameters (word in this context means + anything seperated by a space):
+$1, $2, $3
$1-
$2-, $3-
etc.$$1
$$2, $$3-
is also possible\$1-
$
) by prepending a backslash
+ \
, which means this won't be interpreted as a parameter
+ and not be replaced\
, you can escape the
+ backslash itself, for example \\$1-
will be replaced
+ (leaving one backslash in front of the replaced parameter)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.
+ +So you can for example add just /Permit
to the menu, but
+ the custom command /permit !permit $$1
will actually be
+ executed as !permit <name of the user>
.
Context | +Parameters | +
---|---|
All | +$chan - the currently active channel (without leading #) |
+
User Context Menu | +$1 - name of the user |
+
User Dialog | +$1 - name of the user |
+
Channel Context menu | +$1 - name of the currently active channel (without leading #) |
+
Hotkey | +$1 - the currently selected user (if present) |
+
In addition, there is an implicit channel context, which means channel-aware
+ commands like /ban
are executed in the appropriate channel.
You can add custom commands and regular commands to the User Context Menu
(when you right-click
+ on a user in chat), the Channel Context Menu
(when you right-click anywhere on the chat
+ that is not otherwise linked) and customize User Dialog Buttons
(Custom Commands
+ and Timeout Buttons).
Commands can be added in the following format:
+/<commandName1>, /<commandName2>
For example:
+/Slap, /Permit
Which means the command with the name slap
will be added
+ first, then permit
after that. You can use spaces,
+ linebreaks and/or commas as seperators between commands.
This is the syntax for specifying commands in the Context Menus/User Dialog:
+/Slap /Permit
or Slap, Permit
or Slap Permit
/
, then the name
+ (without parameters) and space, linebreak or comma to seperate to the next command./
in front.//Slap
//
will put the command
+ in the special submenu More..
(for Context Menus) or
+ in a second line of buttons (for the User Dialog).| Slap
or |//Slap
|
(vertical bar) will add a seperator before the
+ menu item for the next command.
+ The |
doesn't have to be directly in front of the command,
+ it simply applies to the following command./Set_color
is displayed as Set color
In addition, you can define for the User Dialog Buttons:
+5, 2m, 10m, 24h
s
- seconds,
+ m
- minutes, h
- hours, d
- days.120s, 120
is displayed as 120s
and 2m
/Ban[B], /Unban[U], 2s[P]
+
) can
+ be used instead (which will be replaced with a space automatically)./Slap[NUMPAD1|Np1], /Permit[NUMPAD2|]
|
) 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.nokeylabels
/unhost
command to your channel if you started
+ your stream session in the last 15 minutes and the stream status
+ changes (usually from offline -> live).autoUnhostStreams
setting, via
+ /add autoUnhostStreams <streamName>
, in order to
+ tell Chatty that you are authorized/want to use the automatic /unhost
+ feature in that channel).You can let Chatty write information (title, game, viewercount) of a
+ certain stream to a file. The file will be written to the subfolder exported
of the settings directory
+ (enter /dir
to find out where that is). Stream information is
+ only written if Chatty gets that data, so for it to work properly you need
+ to currently have the channel of that stream open in Chatty. (When you change
+ the setting, data will be requested once for testing, but you have to be in
+ the channel for it to be updated regulary.)
To save stream information to a file, you have to define it in the + setting. Each line represents one stream/file and the content to write into + the file. The format for each line is:
+ +<streamname> <filename> [online/offline] <content>
The optional parameter online/offline
defines whether to
+ write the given content to the file when the stream is online or offline. So
+ you could for example define one line for online, which writes the viewercount
+ and another for offline which writes "Offline" or maybe no content at all, which clears the file.
+ If you only define one for online, then
+ the file is not written if the stream is offline, so the previous info will
+ stay in there. If you ommit this parameter, then online is assumed.
The following codes in the content will be replaced with the appropriate data:
+%title
- The title of the stream%game
- The game of the stream%viewers
- The current viewercountExample which will write two files (if joined to #joshimuz):
+
+
+ joshimuz title.txt %title (%viewers Viewers)
+
+ joshimuz title.txt offline Stream offline
+ joshimuz game.txt %game
+ joshimuz game.txt offline
+
If the stream is online, it writes the title and viewercount to title.txt
+ and the game to game.txt
.
+ If the stream is offline it writes "Stream offline" to title.txt
and empties
+ game.txt
.
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 setting commands.
+ +6667,443
)The server/port values are used when connecting, unless the commandline
+ parameters -server
and/or -port
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 /get server
+ and /get port
.
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 Correct Userlist setting).
+ +You can add hotkeys for certain actions. In general, there + are the following types of hotkeys:
+With the Enable global hotkeys setting you
+ can enable/disable the currently defined global hotkeys if your
+ Chatty version supports global hotkeys. It does not do
+ anything on it's own, it just toggles global hotkeys you defined
+ on and off, in case you only need them sometimes and they
+ interfer with other programs you use. You can also toggle that
+ setting in the main menu under Extra - Options
or
+ use setting commands to change the globalHotkeysEnabled
+ setting directly.
If a dialog pops up that tells you that global hotkeys + have not been properly initialized, check out the + Troubleshooting page.
+ +When adding or changing a hotkey you have the following options:
+Custom Command
,
+ you have to enter the command to perform in the field below
+ (just the name of the command, see Commands).50
will execute the
+ action only once per 5 seconds, even if you keep the hotkey
+ pressed. This can be useful for actions you normally would
+ only want to execute once (e.g. running a commercial,
+ sending a message to chat) and
+ that you don't want to spam by accident.TAB Completion allows you to write the beginning characters + of a nickname in chat and then press TAB to complete it. To learn how to + use TAB Completion check out the general help.
+ +Custom Completion allows you to add terms and their completion, + allowing you to not only complete names in chat (TAB) or emotes + (Shift-TAB) but also custom stuff you added to the list by prepending the term with a + point and using Shift-TAB.
+ +Example: Add chatty
as Key and
+ http://chatty.github.io
as Value
+ and then in the inputbox type .chatty
(notice the dot in front) and press
+ Shift-TAB to complete it to the URL.
Custom Completion items can only have one completion, so you
+ can't have .chatty
complete to several things
+ as it could be the case with a nickname.
Besides the Settings Dialog, you can also use the
+ /customCompletion
command to modify custom
+ completion items:
/customCompletion add <item> <value>
- Add an item/customCompletion set <item> <value>
- Change an item that already exists/customCompletion remove <item>
- Remove an itemRemember that you can also use TAB Completion for commands. Kappab
+ + + diff --git a/help/0.8.3b/help-short_guides.html b/help/0.8.3b/help-short_guides.html new file mode 100644 index 0000000..983ed6b --- /dev/null +++ b/help/0.8.3b/help-short_guides.html @@ -0,0 +1,157 @@ + + ++ Local Subscriber-Only Mode | + Chatty for Streamers | + Join Eventchat +
+Probably shorter guides about some aspects of Chatty.
+You can create your own local subonly mode, which ignores all messages + written by non-subscribers.
+ +Features used: Ignore System, Addressbook, + Custom Commands
+ +Go to Main - Settings - Ignore
and make sure Enable Ignore
+ is ticked. Then add to the list (press the Plus-Button):
!status:smbaf chanCat:subonly
The !status:smbaf
prefix matches on messages send by users that
+ don't have any of the status levels defined, in this case users
+ that are neither a subscriber (s
), moderator (m
), broadcaster (b
),
+ admin (a
) or staff (f
). So basicially this only matches on normal users.
The second requirement for a match is the chanCat:subonly
+ prefix, which refers to the channel category subonly
, 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.
To make use of the Ignore Entry defined in the previous section, you need
+ to add the subonly
category to the channel you want to have
+ it enabled for. To do this, you could open the Addressbook Dialog
+ (Channels - Addressbook
) and add the channel with the
+ category there (channels need a leading # in this case, so e.g. #joshimuz
).
You can however also use Addressbook Commands:
+/ab change #joshimuz !subonly
This toggles the subonly
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.
To do this a bit more conveniently, you can add it as a custom command. Go
+ to Main - Settings - Commands
and add the following to the
+ list:
/Toggle_Subonly /ab change #$$1 !subonly
If you enter /Toggle_Subonly joshimuz
, this will automatically
+ run the Addressbook as mentioned above ($$1
means this is
+ being replaced with the first word after the command).
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 Channel Context Menu
+ (on the same page in the settings). Just click on Edit
and add
+ the command name (without any parameters):
/Toggle_Subonly
Now if you right-click on a channel, the context menu that opens should
+ have an entry Toggle Subonly
, which you can
+ use to turn your own local subonly mode for the current channel on and off.
<View - Channel Info>
to see your current
+ stream title/game, a graph of your viewercount and how long your current
+ stream already is going.<Extra - Followers/Subscribers>
dialog
+ to view your 100 most recent Followers/Subscribers and some stats based
+ on that.<View - Channel Admin>
dialog to change
+ the title/game of your stream and run commercials:
+ Settings - Window - Always show chat scrollbar
, so you can always capture the same
+ region, independant of how many messages are in the chat window./set font Arial Bold
./clearchat
+ command (e.g. if you changed some settings before starting the stream
+ you don't want to show).As of March 2016 Twitch doesn't use separate Event Chat servers + anymore.
+ + +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).
+ +In order to join Event Chat in Chatty, you have to connect to a different
+ server. See Twitchstatus.com for an (unofficial) list
+ of servers (make sure you choose the Event Chat
tab and use
+ a server/port combination that is marked as irc
in the
+ Protocol
column).
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 + seperate instances of Chatty at the + same time.
+ +There are different ways of connecting to a different server:
+/server <host>[:port]
command connects to the given server and
+ port manually (for example /server irc.twitch.tv:443
,
+ replace with an Event Chat server accordingly).-server
and -port
commandline options
+ allow you to specify a different server when you start Chatty.Server
and Port
settings in the
+ Settings Dialog under Advanced
allows you to set
+ fixed settings for the server to connect to. This especially makes sense
+ if you are using seperate settings for different instances of Chatty.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
+ Settings - Commands
, add a new Custom Command and enter:
+ /eventchat /server <server>:<port>
(replace
+ with the appropriate IP and port of course). Then you
+ can just enter /eventchat
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 irc.twitch.tv
if you didn't change the
+ server settings).
SpeedRunsLive 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.
+ +Open the race list via SRL - Race List
, 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.
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).
+ +Use SRL - Races with..
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.
You may want to check if Irc logging is enabled in the Debug Window
+ (Extra - Debug window - Checkbox: Irc log
), which should
+ be disabled by default, but can lower performance if checked.
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.
+ +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.
+ +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 hotkey
+ in the .zip
filename and try that instead.
Chatty requires the jintellitype-1.3.8.jar
to be in the
+ lib
subfolder of where the Chatty.jar
is
+ located.
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: + +
.dll
)JIntellitype.dll
isn't stored where the program can
+ find it
+ Find out if you have the 64bit or 32bit version of Java (e.g. by
+ entering java -version
on the commandline to check if there
+ is 64bit in the response), then check if you downloaded the matching
+ version of Chatty.
Enter /wdir
in Chatty to find out what your working directory
+ is and make sure the JIntellitype.dll
is in there. If you
+ are starting Chatty via a shortcut, remember that the directory
+ specified in the Run in
field determines your working
+ directory (on Windows at least, but global hotkeys are currently Windows only
+ anyway).
See the Chatty Livestreamer Help.
+ +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.
+ +/dir
in Chatty to find out what your settings
+ directory is (/openDir
to open it) and whether that's
+ the one you used before (there should be quite a few files and
+ folders).backup
folder you can try to restore the
+ automatic backup. More Information...The image/sounds folders are based on the current Working Directory, + which is set when you start Chatty. More Information..
+ +If you repeatedly get disconnected because of possibly invalid login
+ data, please go to Main - Login.. - Verify login
.
+ 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.
If the login data isn't valid, you can just remove the login and request + new login data. Also see the section about login + for more information about invalid logins.
+Another reason may be that you are connecting to the wrong port.
+ +It's possible that your internet/firewall doesn't like the port you are
+ using to connect. By default it tries to connect to 6667
+ first. Twitch may also have changed the ports. You can check Twitchstatus.com
+ (not an official Twitch site) which chat server/ports are available (make sure to use an irc
server).
+ The host irc.twitch.tv
should resolve to the available server IPs, so you normally
+ shouldn't have to enter an IP directly (for main chat).
If you are using a shortcut to start Chatty, also check any + custom server/port you may have defined there using commandline parameters.
+ +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: <JRE_INSTALL_DIR>/jre/lib/fonts/fallback
On Windows, the JRE would usually be located in
+ C:\Program Files\Java\
or
+ C:\Program Files (x86)\Java\
.
Note: If you set the inputFont
+ setting to something else
+ besides a Java logical font, then the font fallback mechanism may break.
+ This was the case before version 0.7.3.
You need to have at least Java 7 JRE (Java Runtime Environment) installed to run Chatty.
+If you try to start Chatty by double-clicking the Chatty.jar
,
+ first make sure that .jar
files are associated with Java,
+ and not some other program like WinRAR. The icon of the Chatty.jar
+ should have a Java icon (coffee cup). If you right-click the Chatty.jar
+ you can select the program to open it with under Open with
.
If you are sure that the Chatty.jar
is actually started with
+ Java, but no program window appears, it may be that an error occured before
+ the window (GUI) could be created.
Running Chatty from the commandline has the advantage of being able to + get messages from before the GUI is established. It also may work when Java + isn't integrated into the OS correctly (but is installed).
+ +Chatty.jar
is located
+ Chatty.jar
is located. Click on Open
+ command window here
in the context menu.java -jar Chatty.jar
+ and press Enter.When you enter the above command and Chatty starts correctly (but doesn't
+ when you double-click the Chatty.jar
), this may mean that
+ Java isn't integrated into the OS properly. You can create a
+ shortcut or a .bat-file to
+ start Chatty similiar to entering the command above, but much more
+ conveniently.
If Chatty doesn't start when you enter the above command, check the + commandline window for error messages. + Send a screenshot of the commandline + window along with information on what other things you tried if you + require further assistance with it.
+ +If the integration of Java into the OS may not be correct, and you want + to try to fix it, you can try this.
+ +Open a commandline window and enter assoc .jar
which should output
+ .jar=jarfile
and enter ftype jarfile
which should
+ output something like "C:\Program Files\Java\jre7\bin\javaw.exe" -jar "%1" %*
+ (see also
+ Could not find the main class. Program will exit.)
If you experience this when entering java -jar Chatty.jar
+ in the commandline, then it probably can't find Java because it's not in the
+ PATH
environment variable (that defines where to look
+ for programs of which only the filename has been entered, not the whole path).
You can enter PATH
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.
See next section. Of course you'll have to navigate to the folder + manually.
+ +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:
+<user_dir>/.chatty/debuglogs/
+ (Example: C:\Users\<username>\.chatty\debuglogs\
)
If you have Chatty running you can enter /openDir
to open it
+ or /dir
to output the path, then simply navigate to the
+ debuglogs
subfolder.
In that folder, there are two kinds of debug files:
+debug.log
which is overwritten everytime you start
+ Chatty. It may also have a number at the end (like debug.log.1
)
+ if Java couldn't open the usual debug.log
.debug0.log, debug1.log, ..
), 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.So to find possibly relevant data:
+debug.log
first.debug0.log, debug1.log, ..
+ files could contain the necessary information, based on the last
+ modification dates.
+ Contact me please.
+ + + + + + + + + + diff --git a/help/0.8.3b/help-whisper.html b/help/0.8.3b/help-whisper.html new file mode 100644 index 0000000..e94fae5 --- /dev/null +++ b/help/0.8.3b/help-whisper.html @@ -0,0 +1,110 @@ + + ++ Settings | + Usage | + Troubleshooting +
+ +Chatty implements the /w
command that Twitch Chat
+ provides, allowing you to send private messages in chat to other users.
+ Chatty does not provide the Whisper History as on the website and is
+ only a very basic implementation in general.
The Whisper Feature is disabled by default.
+ +In April 2016 Twitch moved Whispers from the Group Chat servers to the + new AWS Twitch Chat servers. There is no additional server configuration + required anymore.
+ + +whisper
will be able to send whispers to you.
+ Messages from other users are discarded. Alternatively you can
+ also blacklist users by adding them to the
+ blockwhisper
category (which makes most sense with
+ the Whitelist setting disabled).Miscellaneous - Ignore (whisper)
. 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.<name>
+ <message>
instead of having to use the
+ /w
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.
+ Hey how are you? :)
wont't be send to the
+ user named Hey
). The tab for collecting all
+ whispers is named $[whisper]
.$<username>
.[Auto-Message] This user has not
+ allowed to receive whispers from you.
. The message is
+ only sent once per session to each different user that whispers
+ to you and is also spam protected.When the Whisper Feature is connected ([W]
appears in the
+ titlebar) you can receive and send whispers:
-[name]-
/w <name> <message>
, then this will be
+ indicated in chat by the nickname being marked like this:
+ >>[name]
/me
).+ General usage + | + + + Chat basics + + + Chat moderation / utility + + + Chat customization + + + Stream features + +
+ Settings / Files
+
Also check out the official + YouTube Channel + with guides and stuff. + |
+
+
+ Miscellaneous
+
+
+ Guides
+
When in a channel, Chatty shows some information about that channel
+ in the titlebar, e.g.:
[40|59] - GTA:SA Speedruns (Grand Theft Auto: San Andreas)
The first number is the number of people in the chat, the second is the + viewercount, followed by the current stream title and game. Anything other + than the number of people in the chat is requested from the Twitch API about + every two minutes.
+ +In addition, the titlebar will also show additional information, if enabled:
+Sub
for Subscriber-Only ModeSlow: <time>
for SlowmodeR9k
for R9Kbeta ModeYou can toggle showing some information under View - Options - Titlebar
.
You can customize some shortcuts/hotkeys in the settings.
+Default shortcuts which can't be changed:
+The following are more default shortcuts, however these can be changed + in the settings:
+All command names are case-insensitive. Something like <parameter>
+ represents a required parameter which must be entered for the command to
+ work properly (you don't enter the surrounding < >
,
+ they are just there to show it's a parameter). Equivalently [parameter]
+ represents an optional parameter.
Chat commands:
+/me <message>
- Send an action message (* nickname says something) to the channel/to <nick> [time] [reason]
- Timeout the user with the given nickname for "time" seconds (time is optional)/timeout
, /ban
, /unban
,
+ /slow
, /slowoff
,
+ /subscribers
, /subscribersoff
,
+ /clear
, /mods
, /host
,
+ /unhost
, /color
+ just like in normal Twitch Chat/join <channel>
- Joins the given channel/part
or /close
- Leaves the current channel/reconnect
- Disconnects and reconnects/fixMods
- Temporarily fixes the list of mods (like
+ /mods
but without showing the list of mods in chat)/ignore <user>
, /unignore <user>
- To ignore/unignore user (chat and whisper)/ignoreChat
, /unignoreChat
, /ignoreWhisper
, /unignoreWhisper
+ - To ignore/unignore user only from chat/whispering youInfo commands:
+/connection
- Show info about the current connection/uptime
- Shows how long Chatty has been running/appinfo
- Shows Chatty uptime and current memory stats/dir
- Show the directory the settings (and other stuff) are saved in/wdir
- Show the current working directory/openDir
- Opens the settings directory in your file browser/openWdir
- Opens the current working directory in your file browser/testNotification [channel]
- Display a test notification (optionally with channel,
+ which means right-clicking on the notification will join that channel)/myemotes
- 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)/ffz
, /ffzGlobal
- Shows the FFZ channel emote codes for the current channel/global FFZ emotes/releaseinfo
- Opens the help with the release informationOther commands:
+/clearchat
- Clears the current chat window of all text/setcolor <name>
- Opens the usercolor settings
+ for the given name/echo <text>
- Outputs the given text as a info message/copy
- Copies the given text to the clipboardGUI commands:
+/settings
, /livestreams
, /channeladmin
,
+ /channelinfo
, /search
, /openFollowers
,
+ /openSubscribers
- Opens the according dialog/insert <text>
- Inserts the given text into the input box at
+ the current caret position (can be useful for Custom Commands put
+ in a menu)/insertword <text>
- Same as /insert
,
+ but adds spaces so it's seperated from text before and after (if present)/openUrl <url>
- Opens the given url/openUrlPrompt <url>
- Open the given url after
+ showing a prompt for confirmationAdvanced commands (not recommended for use unless you know what you do):
+/server <host>[:port]
- Connect to a custom server/raw <command>
- Send a raw command to the server/refresh <emoticons/badges/ffz/ffzglobal/bttvemotes/emotesets>
+ - Refresh the given data from it's respective API:
+ emoticons
: Twitch Emotesbadges
: Twitch Badges (current channel)ffz
: FFZ Emotes (current channel)ffzglobal
: Global FFZ Emotesbttvemotes
: BTTV Emotes (global and current channel)emotesets
: Association between emoteset and
+ channel name, to display Twitch Subemotes info correctly
+ (twitchemotes.com API)/changetoken <token>
- Checks if the given token
+ is valid and sets it as new token if it isThe login data consists of a username (or account name) and most + importantly an access token, which is sort of a revokable + password that can also have different types of access associated with + it, the ones usable for Chatty being:
+ +Chat access
Read user info
Editor access
Run commercials
Show subscribers
Once requested from Twitch, the login data is stored locally on your + computer along with the other settings of Chatty. + Since Twitch gives out the + access token per application, any access token for the same account + requested with Chatty will be invalidated when you request a new access + token. (This doesn't seem to be the case anymore.)
+ +If getting login data fails, read this guide. + If your login was determined invalid, read down below.
+ +To allow Chatty more access than it already has (e.g. if you haven't
+ selected editor access before, but you want it now), you need to request
+ a new access token. Just go to <Main - Login..>
,
+ delete the login and request it again with the necessary access.
To allow Chatty less access than it already has (e.g. you don't want it + to have editor access anymore) you need to first revoke access + completely in your Twitch Account + Settings, then + authorize access again. What will not work is just requesting a new + token without selecting the now unwanted access. Twitch will always + respond with a token that has at least as much access as the previous + one.
+ +The access token is saved in the login
file in the settings
+ directory and can thus be accessed
+ by anyone having access to your computer.
+ It allows anyone who obtains it to chat in your name and access the other
+ things listed above (if you allowed it when getting the token). If you think
+ the token may have been compromised, please immediately go to your Twitch
+ Settings subsection
+ Connections
+ and revoke the accesss there. You can then request a new one for
+ which Twitch will ask you to authorize Chatty again.
If your login is determined invalid (either by checking it manually or + when Chatty performed an automatic check), this can mean one of two things:
+What happens when your login is no longer valid:
+How to proceed:
+<Main - Login..>
to open the Login configuration
+ and click on [Verify login]
.<Main - Login..>
to open the Login configuration
+ (unless you are already there), [Remove login]
and create
+ a new login.There are a few special symbols that are used for users in chat. These + are displayed in the userlist and - if usericons are disabled - also in chat.
+FrankerFaceZ provides a custom + mod icon for some channels. You can disable this in the settings if you + want to keep the default one for all channels.
+ +The userlist on the side of the channel shows all users currently + considered to be in the channel.
+ +In order to receive JOIN/PART messages, the setting Correct Userlist
+ under Settings - Advanced - Connection
has to be enabled.
JOIN/PART messages are sent in batches and can be pretty delayed. So if + someone joins the chat, he may only appear as joined after e.g. 15 + seconds. If you want to use this to directly react on stream to someone + joining, then including stream delay your reaction may be e.g. 30 + seconds too late (possibly longer). The user may even have already left + the channel again, but it just doesn't show yet.
+ +The userlist can also take some time to initially load after you join a + channel, or not load at all sometimes.
+ +Also note that the userlist doesn't necessarily have to do with who + watches your stream. A user can be logged into chat without watching the + stream and vice versa. Overall, just don't take the userlist too + seriously.
+ +When you type in the inputbox, you can TAB-complete different types of + things:
+/
(using TAB, e.g. /sub
then TAB to complete to /subscribers
)Datsh
then Shift-TAB to complete to DatSheffy
)There are a couple of settings + that change the behaviour of the TAB Completion.
+ +How the TAB Completion process works:
+ +The found matches are all ordered alphabetically, except for nickcompletion + for which you can choose different types of sorting. By default nicknames use + predictive sorting, which means users who recently wrote a message or highlighted + you have a higher priority, increasing the chance that the users you want to + address appear as the first few matches.
+ +z
in the editboxze_tt
+ with two other resultszMASKm
by:
+ zMASKm
zeblover
+ and Shift-TAB again to cycle to zMASKm
dat
in the editboxDatHass
with two other resultsDatSheffy
by:
+ DatSaunce
+ and TAB again to cycle to DatSheffy
DatSheffy
Chatty provdes an input history for the chat input box that allows you to + call up lines you entered previously, to make it easier to e.g. repeat + commands with similiar parameters, repeat messages you send to chat or just + look up what you wrote before. You can even save messages to the history + that you haven't send yet to be able to send them later.
+This does not apply anymore since Twitch changed their system to use + IRCv3 capabilities. Joining several channels does not have any drawbacks.
+ +If enabled, the history automatically saves channels you join and when + you last joined them. By default channels expire from the history after + 30 days of not joining them (can be changed).
+You can also add channels from the history or any + you enter manually to the favorites, which will always be kept until you + remove them yourself.
+ +The highlight system allows you to add words or phrases that make chat
+ messages appear in another color and appear in a seperate window, which you can
+ open under View - Highlights
(you can clear the highlights window
+ in it's context menu).
The ignore system works very similiar to the highlight system, just that
+ it hides messages instead of highlighting them. They however also get
+ added to a seperated window, which you can open under View - Ignored
+ (you can clear the messagess in the window in it's context menu).
Right-click on a user in chat to open the User Context Menu, where you
+ can ignore or unignore that user from the Miscellaneous
+ submenu. You can view and edit the list of ignored users in the settings.
The color of a user is displayed in the User Info Dialog. Color Names + are used where possible, HTML Color Codes are displayed in the Tooltip. + Colors with asterisk (*) are default colors (the user hasn't set one + or hasn't said anything during this session yet). A color in parentheses + means it's the original color, while the other color is the corrected one + that is actually displayed.
+Chatty attempts to make colors more readable automatically by changing + them to increase contrast. This doesn't work very well though, although it + should work for extreme cases like white on white or black on black.
+ +You can also specify custom colors for certain users or types of users + in the settings. Custom colors are indicated by two asterisks (**) in the + User Info Dialog.
+ +Chatty supports the default Twitch Emoticons (Normal/Turbo/Subscriber), + which should work the same as in normal Twitch Chat. It however also + supports FrankerFaceZ, a custom + set of emotes that is normally made available in normal Twitch Chat by use of browser + extensions. It also supports BetterTTV emotes.
+ +You can enable/disable Emoticons in general (displaying the icons instead
+ of the text) in the settings under Emoticons
. You can also
+ ignore specific emotes in the same place in the settings.
In chat you can right-click on an emoticon to show some info about it.
+ Click on the emote code (e.g. FrankerZ
) in the context menu
+ to insert the emote in the inputbox. If it is a subscriber emote, you
+ also have some more options.
Use Extra - Emoticons
or press Ctrl-E to open
+ the Emote Dialog, which has various pages:
Favorites
page lists emotes you have added to the favorites
+ via the Emote Context Menu (right-click on an emote in the dialog or chat and
+ choose Favorite
, emotes that already are favorited can be
+ removed from favorites the same way).My Emotes
page lists the emotes you paid for (Subemotes/Turbo).Channel
page lists the emotes that are specific to the current channel
+ (FFZ and BTTV, if there are any). It also includes
+ the subscriber emotes of the current channel (if it has any), whether you
+ can use them or not (but it displays a message if you are not subscribed).Twitch
page shows all free global Twitch emotesOther
page shows all global FZZ/BTTV emotesClick on an emote to insert it into the current channel inputbox. Double-click + on an emote to also close the Emote Dialog in the process, or press ESC or + Ctrl-E to close it. Right-click on an emote to show a context menu + with some more information/options.
+ +Right-click on an emote and choose Show Details
to open the
+ Detail View in the Emote Dialog, which shows the emote in different sizes
+ and some information about it. Clicking on an emote in chat also opens the
+ Detail View.
Note that you need to have joined at least one channel for your subemotes/turbo emotes + to show up, because only then does Twitch Chat send that information to the client.
+ +You can add your own local emotes by creating a file called emotes.txt
+ in the settings directory (enter /dir
in Chatty to find the
+ settings directory, /openDir
to directly open it). The
+ file can have one emote on each line, for example:
+D: aww.png size:18x18 +re:Gr[e|a]yface Kappa.png +# Switching Kappa and MiniK +Kappa http://static-cdn.jtvnw.net/emoticons/v1/3287/1.0 +MiniK http://static-cdn.jtvnw.net/emoticons/v1/25/1.0 set:793 id:3287+ +
This can be used to replace existing emotes, since custom emotes are + checked first and thus take precedence. This is not intended to replace + FFZ or BTTV emotes, just to help configure emotes to your personal + preference. For example you could also add an image for you own name to + have it highlighted in chat in a different way.
+ +The syntax per line is (you can use as many spaces or TABs as seperators as you want):
+ +[settings] <code> [settings] <image> [settings]
Settings can be in any of the shown places, but are always optional. Available settings are: +
+ +set:<setid>
to specify a
+ Twitch emote set. This will only affect messages you write yourself.id:<emoteid>
to specify a Twitch emote id to
+ replace. This will only affect incoming messages.chan:<channel>
to restrict the emote to the
+ given channel.size:<width>x<height>
to specify the
+ size of the emote (you can omit this if you want to use the image
+ size).Required:
+re:
+ to specify a regular expression. Otherwise it is interpreted as plain text
+ (the same as regular Twitch emotes, case-sensitive and usually separated
+ by space from other characters).emotes.txt
in), so just put them in the same directory.
+ You should also be able to use URLs to load the image from the internet.Lines starting with #
are ignored and can be used for comments.
The emotes.txt
file is loaded when you start Chatty, so if you edit the file
+ while Chatty is running, you have to use the /reloadCustomEmotes
+ command for it to take effect.
+ Emote images may be cached, so if you change the image, you MAY have to
+ clear the cache (/clearemotecache CUSTOM
).
This has been moved to it's own page
+ +With this feature, you can select a user in chat with keyboard shortcuts + (if the window is active). So you can e.g. timeout a user with your keyboard + alone.
+ +Press Ctrl-Space (can be changed in the settings) to enter + this mode. If there are any user + messages in chat, then the newest message will get another background color + which shows that it is selected. In that mode, the focus is on the textpane, + which enables more shortcuts:
+When you move up and down, it actually switches to the next user instead + of to the next line. So if the same user send 10 messages in a row, it will + jump to the first message of the next user above it.
+ +In addition to the currently selected message, it will also highlight all + other messages by the same user. You can also hold AltGr and + click on a username in chat to highlight all that users messages (and enter + User Selection Mode).
+ +You can also click and hold in an empty area of the textpane, which puts + and holds the focus there, so you can just use the shortcuts in the list + above to enter the User Selection Mode and switch between messages. However + if you let go of the mouse key, it will immediately leave the mode again.
+ +You can also configure global hotkeys with some User Selection actions. + However, if the focus is not on the chat, then the usual shortcuts won't + work, so you'll have to define additional global hotkeys to e.g. timeout the + currently selected user. See the hotkey settings for what actions are + available.
+ +Stream Chat is a seperate dialog, opened via the /openStreamChat
+ command or the Extra
menu, that can have chat messages from one or several
+ channels redirected to it (only regular chat messages, so no JOINS/PARTS, info messages
+ and so on). It also can have a message timeout set, so messages will
+ disappear after a certain amount of seconds.
The idea is to capture Stream Chat to display chat on stream and + messages will only be displayed if the chat has been recently active. So + this doesn't really make a lot of sense for busier channels, unless you + simply prefer to only have regular messages or to have a seperate dialog + for the capture.
+ +You need to add the channel which messages are redirected to the
+ Stream Chat dialog before anything will appear. The setting you are required
+ to change is streamChatChannels
,
+ which is a list setting giving you different ways of editing it:
/set streamChatChannels #<channel>
- To set
+ the channel to only this one/add streamChatChannels #<channel>
- To add
+ a channel in addition to the ones already set/remove streamChatChannels #<channel>
- To remove
+ a channel from the listCheck out other settings that are also edited with setting commands.
+In addition, make sure you have Settings - Window - Restore dialogs
+ set to at least Restore dialogs from last session
in order
+ to keep the position/size of the Stream Chat dialog between sessions.
/openStreamChat
- Opens the Stream Chat dialog/setStreamChatSize <width>x<height>
- Set the exact size of the Stream Chat dialog in pixels/getStreamChatSize
- Shows the size of the Stream Chat dialog in pixels/clearStreamChat
- Removes all messages/streamChatTest [message]
- Adds a test message to the Stream Chat dialog, if you don't specify a message
+ a default one is usedYou can give people in chat custom names that will appear in chat and + in the userlist instead of the regular Twitch username and in the User Info + Dialog in addition to the regular Twitch username. In other places (like + the User Context Menu or auto-completion) the regular Twitch username is + used.
+ +The following commands are used to set custom names:
+/setname <name> <custom name>
- to set a custom name/resetname <name>
- to remove a custom nameIf enabled in the settings under Main - Settings - Chat
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
+ Ctrl to keep the chat paused even without moving the mouse.
Optionally, you can set it to require Ctrl being pressed in + conjunction with moving the mouse to initiate pausing. You can let go of + Ctrl as soon as pausing is started and it will stay paused as + long as you move the mouse inside the chat area.
+ +A little popup in the top-right will indicate that the chat is paused.
+ +Please note: 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.
+ +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 + Ctrl.
+ +A certain time after not moving the scroll position, it will scroll down + automatically (unless Ctrl is still being pressed).
+ +Holding Ctrl 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 (Main - Settings - Chat
).
It is recommended to enable the pause chat feature if you are using this, + or else misclicks could be very common.
+ +The Channel Info Dialog shows the current stream status of the active + stream. The data is requested from the Twitch API in a semi-regular interval, + so it can take some time to update.
+ +If the stream is online, the Online: 1h 30m
+ shows how long ago the stream was started. That time comes directly from the
+ Twitch API, so it is able to show the correct online time, even if you started
+ Chatty after the stream started.
If there is a time in parentheses
+ (like 1h 30m (2h)
), then that time denotes how long the stream
+ was online, but including small offline periods (PICNICs) of at most 10 minutes,
+ which means that this time is more of a guess of what might be expected as
+ stream online time and also depends on when Chatty got the data (if you join
+ the channel after a PICNIC, then it won't include the time before, because it
+ never received the data for it).
The History is a graph that shows the development of the viewers + of the currently active channel and also indicates stream status changes + (online/offline/title/game) by different colors.
+Hover over points to display the stream status and viewercount + at that time. Right-click for a context-menu.
+
+
+ There are two ways to change which time range is being displayed: +
|
+ + + + | +
The History is recorded while you have the channel open in Chatty + as well as for all followed channels, if you have that feature + enabled.
+The shown data usually fits to the available vertical space
+ (so if the min/max viewercounts were 341/403 then only this
+ range is shown). If you choose Toggle Vertical
in
+ the context-menu, you can switch between the shown range
+ (min/max) and the full range (0-max).
Chatty can show Notifications when the status of a stream changes.
+ There is also a Live Streams window (Channels - Live Channels
)
+ that shows the currently live streams. Both these features always include channels you have
+ joined and - if enabled - channels you have followed. Streams that are
+ no longer online, or whose channels you have left and you don't follow,
+ are added to a list that you can open in the Live Streams window context
+ menu (Removed streams..
).
Chatty Notifications are little info boxes that can be shown for stream + status changes and highlighted messages. When you left-click on a notification + it is closed immediately, right-clicking closes it as well and in addition + also joins the associated channel.
+ +Chatty can request a list of streams you follow on a regular basis, so + you have both an overview of currently live streams as well as be + informed about status changes (offline -> online, title change, game change). + This is always available for streams whose channels you have joined in chat, + but with this feature enabled, this works for all streams you follow even + without joining their channel.
+This feature requires Read user info
access, so Chatty can
+ request your followed streams. Read the section about login
+ to learn more about login data and access.
You can enable/disable this feature in the Settings under Notifications
.
This has been moved to it's own page
+ +You can open a list of the Followers of a channel by joining that channel
+ and then opening the Followers Dialog via Extra - Followers
.
+ It always opens on the currently active channel, or if you are in no channel
+ at all, your own channel.
You can open a list of your Subscribers by opening the Subscribers Dialog
+ via Extra - Subscribers
. It always opens on your own channel,
+ because you can only display the Subscribers of your own channel. If you don't
+ have any Subscribers, it will simply show an empty list (and an error). You
+ also need to have selected the necessary access when
+ requesting login data.
You can save the current list to a file by right-clicking on the dialog + (not the list) and selecting the format.
+ +Both the Followers and Subscribers Dialog otherwise work in pretty much + the same way. Data is only requested as long as you have the dialog open. It + is requested in a semi-regular interval and then displays that data in the + list (and some stats).
+If followers/following is mentioned below, then the same applies for + subscribers/subscribing in the appropriate dialog.
+
+ At the top it shows some stats: +
There are different background colors for some entries: +
The time has different colors for older entries: +
At the bottom, it shows approximately how long ago data was last received, + or a short error message if an error occured. + |
+ + |
Everything that determines whether a follower is new or a refollow is + saved per session. So if you restart Chatty, it assumes that all followers + except from the first request are new. So if you start Chatty, open the + Followers Dialog on your channel, it will load the followers for the first + time and show none of them as new. Now if it updates a minute later, and there + are users it hasn't seen as having followed before, then it assumes these + users as new followers.
+ +Now a user of course might have been a follower for a year, then unfollow + and follow again. Chances are that Chatty won't notice that and assume a new + follower. What it however does is that it only shows each user as new follower + once per session. So if someone follows and Chatty shows that user as a new follower, + then that user unfollows and follows again, Chatty will notice that the first + and the second follow time are different, and will show this user as a refollow + (the name slightly grey).
+ +So this basicially just prevents the same user from e.g. making a sound + go off (if you have that enabled) several times just by refollowing several + times. At most that will happen once per session. Other than that + the data is mostly shown just as it comes in from Twitch. It will still + show refollows on the top of the list.
+ +Chatty can help you with creating Highlights of your stream by recording + the stream time (how long the stream has been online) using a command or + hotkey. When you add a Stream Highlight in Chatty, it is written to a file + which you can then view later.
+ +The following commands are available:
+/addStreamHighlight [comment]
- Adds a highlight at
+ the current time, with a comment if you want to./openStreamHighlights
- Opens the file where the stream
+ highlights are stored in your default text editor.You can also add a hotkey to add stream highlights, so you can also do it + yourself while streaming out of a game (given that global hotkeys work in + the game).
+ +The highlights are written to the file stream_highlights.txt
+ in the exported
subfolder of the settings directory (which
+ you can open with the /openDir
and show with the
+ /dir
command).
You can also let your moderators add stream highlights
+ (!addStreamHighlight [comment]
), but you first have to
+ change some settings:
/set streamHighlightChannel #<yourchannelname>
to
+ allow moderators in the given channel to run the command/set streamHighlightChannelRespond 1
to send a response to
+ chat when the mod command is used (otherwise the message is just shown locally)/set streamHighlightCommand !highlight
to set !highlight
+ as mod commandBoth the ignore joins/parts and Twitch Client Version 3 option have + been removed. You can now disable the Correct Userlist + setting to not get any joins/parts if you think it could improve performance.
+ +Using the /proc
command you can start processes directly out
+ of Chatty. An example of where this is already integrated into Chatty is
+ starting Livestreamer, however this is a more basic implementation.
+ This is probably only interesting for advanced users.
/proc exec <command and parameters>
- Try to
+ start a process on your computer./proc list
- List of processes currently running out of
+ Chatty./proc kill <id>
- Forcefully end the process with
+ the given id (get the id from the list of processes).Example: /proc exec notepad H:\hl.txt
will start Notepad
+ and open the given file.
Note: Commands and output of the process is logged in the Debug Log which
+ is written to file and output to Extra - Debug window
.
There are a few options you can launch Chatty with, that will override + settings loaded from the settings file. You need to run Chatty from the + commandline or Create a shortcut + to use these.
+ +These need to be defined after the Chatty.jar
, for example:
+ javaw -jar Chatty.jar -channel lotsofs
-server <host/ip>
-port <port>
-user <username>
-password [password]
-token [token]
-connect
-channel <channel>
-ds
-cd
-set:<settingName> <setting value>
/set
+ command (see Setting Commands).-single [port]
-single
parameter with the same port (or
+ no port to use the default one) for all instances that you want to
+ have run in the same single instance mode.-channel
parameter is used when
+ forwarded to an already running instance (joining the channel).This has been moved to it's own page
+ +Settings are loaded from files when Chatty is started and saved into files
+ once it is closed. By default these files are saved in a subfolder
+ .chatty
of your user directory. You can also use the
+ -cd
commandline parameter to use the current working
+ directory instead. You can find out which folder is used by entering the
+ /dir
command.
Since Version 0.4 of Chatty, the settings are no longer saved in a single
+ settings
-file, but instead several files:
login
: Contains the login data, including the access
+ token, which should be kept confidential.favoritesAndHistory
: Contains channel history and
+ favorites, as well as game favorites.settings
: The main file, which contains all customizations
+ made to Chatty that should not be confidential or private.statusPresets
: Contains status (title/game) presets
+ from the Admin Dialog.If you are referring to a specific version of Chatty, please provide the
+ actual version number, which you can find on the top of the main help page in Chatty
+ (this one if you are reading this in Chatty, otherwise go to Chatty and open
+ Help - About/Help
or press F1).
Some of the resources that were helpful in the development of this program:
+Chatty is using a few libraries/resources made freely available by others:
+This application (except for the parts mentioned in the previous paragraph) + is released under the MIT License.
++ +Copyright (c) 2014 tduva + +Permission is hereby granted, free of charge, to any person obtaining a copy +of this software and associated documentation files (the "Software"), to deal +in the Software without restriction, including without limitation the rights +to use, copy, modify, merge, publish, distribute, sublicense, and/or sell +copies of the Software, and to permit persons to whom the Software is +furnished to do so, subject to the following conditions: + +The above copyright notice and this permission notice shall be included in +all copies or substantial portions of the Software. + +THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR +IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY, +FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE +AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER +LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, +OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN +THE SOFTWARE.+ + + diff --git a/help/0.8.3b/jconsole.jpg b/help/0.8.3b/jconsole.jpg new file mode 100644 index 0000000..698957c Binary files /dev/null and b/help/0.8.3b/jconsole.jpg differ diff --git a/help/0.8.3b/style.css b/help/0.8.3b/style.css new file mode 100644 index 0000000..bb18a0f --- /dev/null +++ b/help/0.8.3b/style.css @@ -0,0 +1,153 @@ +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; +} + +.dl-settings { + margin-left: 20px; + margin-top: 10px; +} +.dl-settings dt { + font-weight: bold; + margin-top: 3px; +} + +.dl-settings dd { + margin-bottom: 3px; + margin-top: 2px; + margin-left: 20px; +} + +.dl-settings-sub { + margin-top: 4px; +} + +.del { + text-decoration: line-through; +} \ No newline at end of file diff --git a/help/0.8.3b/userdialog.jpg b/help/0.8.3b/userdialog.jpg new file mode 100644 index 0000000..7f8c6fa Binary files /dev/null and b/help/0.8.3b/userdialog.jpg differ diff --git a/help/0.8.3b/viewerhistory_small.gif b/help/0.8.3b/viewerhistory_small.gif new file mode 100644 index 0000000..b9c67e1 Binary files /dev/null and b/help/0.8.3b/viewerhistory_small.gif differ