-Copyright (C) 2017-2018 tduva and contributors
+Copyright (C) 2017-2020 tduva and contributors
This program is free software: you can redistribute it and/or modify
it under the terms of the GNU General Public License as published by
@@ -33,15 +33,14 @@ along with this program. If not, see <http://www.gnu.org/licenses/>.
Learn what directories and files Chatty creates/uses.
@@ -36,6 +37,9 @@
subdirectory called .chatty. You can enter the command
/dir to display and /openDir to open the
settings directory that Chatty currently uses.
+
+
If you want to replace, copy or delete setting files in any way, make
+ sure to close Chatty before doing so.
You can change the settings directory via different ways:
@@ -192,6 +196,18 @@
This is where the Chatty.jar is located and is used for loading libraries
that Chatty uses.
Locate your settings directory by entering /openDir in
+ Chatty. If you customized your Chatlog or Sounds directory you may
+ want to find those in the Settings.
+
Close Chatty.
+
Delete the directory where Chatty is installed (where the Chatty.exe
+ or Chatty.jar are located) and the settings directory.
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,
diff --git a/help/help-laf.html b/help/help-laf.html
new file mode 100644
index 0000000..b612898
--- /dev/null
+++ b/help/help-laf.html
@@ -0,0 +1,524 @@
+
+
+
Chatty Help - Look & Feel
+
+
+
+
Look & Feel
+
A Java Look & Feel affects the colors/style (look) of the entire
+ program as well as some of the behavior/shortcuts (feel). Various
+ different Look & Feel can be selected in the Settings under "Look"
+ (additional chat-specific customization is possible on some subpages
+ such as "Chat Colors" or "Font").
+
+
Note: Changing Look & Feel properties can cause some slight
+ GUI issues, so a restart of Chatty is recommended to complete your
+ changes.
The JTattoo Look & Feel (HiFi, Noire, Minte, Graphite, Aero, Fast, Luna)
+ allow you to use these properties, which overwrite their default
+ values. There are also a few properties that
+ can have an effect in every Look & Feel. They can be changed using
+ setting commands:
+
+
+
/set lafCustomTheme <property> <value> - set one property value
+
/remove lafCustomTheme <property> - remove one property
+
/clearSetting lafCustomTheme - remove all properties
+
+
+
Tip: Enter /set lafc + TAB to
+ autocomplete setting name.
+
+
The following list may not contain all properties. Some more may be
+ listed here,
+ although that list is likely also not complete. Chatty also has some
+ new properties added.
+
+
Not all properties work the same for all Look & Feel and the
+ documentation on that isn't complete, so you'll just have to try
+ around a bit.
+
+
+
Colors must be given as "red green blue", e.g.
+ /set lafCustomTheme selectionBackgroundColorLight 255 60 0
+
Settings that have [Light/Dark] have a top and bottom
+ color for gradients. For example for buttonColor[Light/Dark]
+ you can set both buttonColorLight and
+ buttonColorDark (to the same if you don't want a gradient).
+
Settings that say on/off are enabled when set to
+ on and disabled otherwise on any other value
+
+
+
+
+
Window Properties
+
+
+
windowTitleForegroundColor
+
text
+
Active window title
+
+
+
+
windowTitleBackgroundColor
+
bg
+
+
Fast only?
+
+
+
windowTitleColor[Light/Dark]
+
bg
+
Active window title/Dark for window frame
+
+
+
+
windowInactiveTitleForegroundColor
+
text
+
Inactive window title
+
+
+
+
windowInactiveTitleBackgroundColor
+
bg
+
+
Fast only?
+
+
+
windowInactiveTitleColor[Light/Dark]
+
bg
+
Inactive window title/Dark for window frame
+
+
+
+
windowIconColor
+
fg
+
Window icons (minimize/close/..)
+
+
+
+
windowIconShadowColor
+
fg
+
^ Shadow
+
+
+
+
windowIconRolloverColor
+
fg
+
^ Mouseover
+
+
+
+
windowBorderColor
+
border
+
Outer (active) window border
+
+
+
+
windowInactiveBorderColor
+
border
+
Outer (inactive) window border
+
+
+
+
windowInnerBorderColor
+
border
+
Inner (active) window border, defaults to windowTitleColorDark
+
HiFi/Noire only
+
+
+
windowInactiveInnerBorderColor
+
border
+
Inner (inactive) window border, defaults to windowInactiveTitleColorDark
+
HiFi/Noire only
+
+
+
+
General Properties
+
+
+
foregroundColor
+
text
+
Most text
+
+
+
+
backgroundColor
+
bg
+
Many backgrounds
+
+
+
+
+
frameColor
+
fg
+
Some frames around GUI elements (like scrollpane, edit box)
+
+
+
+
frameColor2
+
fg
+
^ Secondary color (bottom/right), if applicable
+
+
+
+
+
controlForegroundColor
+
fg
+
Various GUI elements (e.g. tabs)
+
+
+
+
controlColor[Light/Dark]
+
bg
+
^
+
+
+
+
controlHighlightColor
+
fg
+
Table header?
+
+
+
+
controlShadowColor
+
fg
+
Table header?
+
+
+
+
controlDarkShadowColor
+
fg
+
Tabs Shadow/outline
+
+
+
+
inactiveColor[Light/Dark]
+
bg
+
^ When inactive window
+
+
+
+
+
disabledBackgroundColor
+
bg
+
For disabled GUI elements ("greyed out")
+
+
+
+
disabledForegrundColor
+
text
+
^
+
+
+
+
focusColor
+
fg
+
Focused GUI element dashed line (like button)
+
+
+
+
focusCellColor
+
fg
+
Focused Tree item border
+
+
+
+
gridColor
+
fg
+
Table grid
+
+
+
+
tabSelectionForegroundColor
+
text
+
Selected tab
+
+
+
+
textShadow
+
fg
+
on/off
+
+
+
+
+
Menu Properties
+
+
+
menuForegroundColor
+
text
+
Menu/Context Menu
+
+
+
+
menuBackgroundColor
+
bg
+
^
+
+
+
+
menuColor[Light/Dark]
+
bg
+
+
Not for HiFi/Noire
+
+
+
menuSelectionForegroundColor
+
text
+
Menu/Context Menu mouseover
+
+
+
+
menuSelectionBackgroundColor
+
bg
+
^
+
+
+
+
menuSelectionBackgroundColor[Light/Dark]
+
bg
+
+
Graphite
+
+
+
+
Button Properties
+
+
+
buttonForegroundColor
+
text
+
Button
+
+
+
+
buttonColor[Light/Dark]
+
bg
+
Button
+
+
+
+
rolloverForegroundColor
+
text
+
Button/Tab mouseover
+
HiFi/Noire not for Tab
+
+
+
rolloverColor[Light/Dark]
+
bg
+
Button/Tab mouseover
+
+
+
+
pressedForegroundColor
+
text
+
Button pressed
+
+
+
+
pressedBackgroundColor[Light/Dark]
+
bg
+
Button pressed
+
+
+
+
+
Input Properties
+
+
+
inputForegroundColor
+
text
+
Input like textfields, comboboxes, lists..
+
+
+
+
inputBackgroundColor
+
bg
+
^
+
+
+
+
selectionForegroundColor
+
text
+
Selected text/list entries
+
+
+
+
selectionBackgroundColor
+
bg
+
^
+
+
+
+
selectionBackgroundColor[Light/Dark]
+
bg
+
Selected tab
+
+
+
+
(Note: The chat inputbox colors are changed in the "Chat Colors" settings)
+
+
+
+
Tooltip Properties
+
+
+
tooltipForegroundColor
+
text
+
Tooltips
+
+
+
+
tooltipBackgroundColor
+
bg
+
^
+
+
+
+
tooltipShadowSize
+
+
number
+
+
+
+
tooltipCastShadow
+
+
on/off
+
+
+
+
tooltipBorderSize
+
+
number
+
+
+
+
+
Other Properties
+
+
+
macStyleWindowDecoration
+
+
on/off
+
+
+
+
macStyleScrollBar
+
+
More minimalistic scrollbar, on/off
+
+
+
+
linuxStyleScrollBar
+
+
on/off
+
+
+
+
centerWindowTitle
+
+
on/off
+
+
+
+
menuOpaque
+
+
Non-transparent menus, on/off
+
+
+
+
tabSeparatorStyle
+
+
Style of the separator between the tabs and content, a single
+ number (0-8, 0 default)
+
HiFi/Noire only
+
+
+
drawSquareButtons
+
+
Don't draw rounded buttons
+
Not all LaF
+
+
+
flatColors
+
+
Use some inactive window colors for the Noir Look&Feel, on/off
Tab color when a message was highlighted in the channel
+
+
+
+
cTabForegroundUnread
+
text
+
Tab color when messages have been received since last having
+ it open
+
+
+
+
cInputBorder
+
border
+
The border around the chat inputbox (e.g. border(1,255 0 0)
+ for a red border)
+
+
+
+
+
Not used in Chatty or not sure what it is
+
+
+
tabAreaBackgroundColor
+
+
+
+
+
+
toolbarForegroundColor
+
+
+
+
+
+
toolbarBackgroundColor
+
+
+
+
+
+
toolbarColorLight
+
+
+
+
+
+
toolbarColorDark
+
+
+
+
+
+
desktopColor
+
+
+
+
+
+
+
\ No newline at end of file
diff --git a/help/help-memory_usage.html b/help/help-memory_usage.html
index 3cd73e3..a732884 100644
--- a/help/help-memory_usage.html
+++ b/help/help-memory_usage.html
@@ -22,7 +22,7 @@
Java prefers to allocate more memory than absolutely needed, so it
can reduce the work going into Garbage Collection, which reduces CPU
usage.
-
Java management and ressources it has to have loaded add some
+
Java management and resources it has to have loaded add some
overhead that other programs may not have.
Chatty stores a lot of information for all it's features to work,
such as emoticons, badges, stream info, user data - some of which
diff --git a/help/help-releases.html b/help/help-releases.html
index f67a67d..391c340 100644
--- a/help/help-releases.html
+++ b/help/help-releases.html
@@ -17,6 +17,7 @@
The new "Look" settings now contain more customization options, including
+ the "HiFi Custom" Look & Feel, which allows setting a custom
+ foreground and background color and various other styling options. Also
+ contains a link to documentation for more advanced usage now.
+
+
Note: The Moderation Log (and related features) now require the
+ "Moderate Channel" access. View and change your access under "Main - Login..".
+ Restart Chatty after changing to ensure everything updated.
+
+
+### Customization / GUI Improvements
+- Added more Look customization
+- Added more Notification options
+- Added more information to Stream Status Notification
+- Added setting to customize User Dialog timestamp
+- Added timestamp custom AM/PM formatting
+- Added Copy/Cut/Paste context menus in some places
+- Improved various Settings Dialog sections
+
+### Moderating / Broadcasting
+- Added "Open in.." menu to User Context Menu (open in other channel)
+- Added account register time to Followers/Subscribers list
+- Open User Dialog and User Context Menu from Followers/Subscribers list
+- Admin Dialog: Added warning if title may be too long
+- Added /commerical command
+
+### Text Matching (Highlight, Ignore, Msg. Colors, ..)
+- Removed escape char `\` from meta prefixes (so writing regex doesn't require
+ escaping backslashes, now only quoting possible, e.g. `+start:"!bet top5"`)
+- Added prefixes `blacklist:` (blacklist per item) and `text:`
+- Added negated variants for text matching prefixes (such as `!start:`)
+- Now supprting several text matching prefixes per item (prefix prefix with +),
+ like `+start:!set w:bet` (starts with "!set" and contains the word "bet")
+- Added "config:url" to require a URL to be in the text (same URL detection as
+ clickable URLs in chat)
+- Improved setting editor (shows more information, works better for testing)
+
+### Twitch Features
+- Removed Chat Rules dialog (Twitch removed the API)
+- Removed Rooms support (Twitch discontinued Rooms)
+- Show more detailed Points Redemption messages in your own channel (if you have
+ allowed proper access, see "Main - Login..")
+- Recognize founders as subscribers
+
+### Third-Party Features
+- Added limited support for seasonal combined emotes (such as "Kappa TopHat"),
+ doesn't work in combination with animated emotes
+- Changed to BTTV v3 API
+
+## Other Changes
+- Switched to another Websocket library, in an attempt to improve connection
+ reliability for PubSub (Moderation Log) and FFZ-WS
+- Added PubSub/FFZ-WS connection status to title
+- Updated notifications in menubar, show some additional warning messages
+- Mentions: Recognize users from user-related info messages
+- Changed reconnecting timing a bit
+- Updated translations (Thanks to contributors!)
+- Updated help
+
+### Bugfixes
+- Fixed removed custom names sometimes not updating immediately
+- Fixed Emote Dialog sometimes not updating to current channel
+- Fixed /echo causing an empty TAB to open when used before connecting
+- Added "chan" parameter as was documented to Notification OS Command
+- Fixed some command TAB Completion case issues
+- Fixed some updating GUI issues related to changing Look and Feel settings
+- Changed to new Twitch Authentication URL
+
This update adds limited support for the new channel points feature (more
diff --git a/help/help-setting_commands.html b/help/help-setting_commands.html
index f9a1287..5c7a5f2 100644
--- a/help/help-setting_commands.html
+++ b/help/help-setting_commands.html
@@ -57,8 +57,7 @@
Settings with a slightly darker background color
- are settings that are not available in the Settings Dialog and can only be
+
Some settings 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
@@ -78,8 +77,8 @@
Copy Messages |
Open URL Command
Show Badges: Shows badges as images instead of
just text
-
Enable Custom Usericons: Use the custom icons
+
Enable Custom Badges: Use the custom icons
defined in the table below
-
Enable Bot Badge: Enables showing of the bot badge
+
Show Bot Badge: Enables showing of the bot badge
for known bots. Chatty shows a single bot badge for all known bots. The
list of bot names comes from different sources: The botNames
- setting, the BTTV API and the FFZ API.
-
-
BTTV: Use botnames from the BTTV API
-
FFZ: Use botnames from the FFZ API
-
-
+ setting, the BTTV API and the FFZ API. (See also: Setting Commands)
Add entries to the table to show additional icons (Addon-Type)
or replace the default icons (all other Types).
The order of the entries can matter, they are looked at from the top:
@@ -201,7 +199,7 @@
matches is used.
-
Custom Usericon Properties
+
Custom Badges Properties
Type
A type of Addon will add an additional badge. All
@@ -301,7 +299,7 @@
you can specify the new badge id/version yourself.
Note: The order of Addon-badges relative to eachother is
- determined by the order they are added to the Custom Usericon table.
+ determined by the order they are added to the Custom Badges table.
Image File
The image to use. Must be a .png and is recommended to
@@ -313,7 +311,7 @@
it and rescan to update the list.
The special image file name$default will use
the default image file, that would be shown without defining
- Custom Usericons. This can be useful if you e.g. want to replace all
+ Custom Badges. This can be useful if you e.g. want to replace all
Badge Types, except for one, so you can define that one to use the
default.
Tip: You should also be able to manually enter the full
@@ -765,6 +763,10 @@
the search text to modify the matching behaviour: [text-prefix:]<search text>
+
text: is the same as without a prefix, but can be useful
+ to make sure the text isn't interpreted as a prefix, for example
+ text:start:Let's go would match start:Let's go
+ anywhere in the message (case insensitive).
cs: makes it case-sensitive, so cs:test
matches test but not Test.
w: matches at word boundaries, e.g. w:anna
@@ -801,6 +803,19 @@
+
All Text Matching Prefixes can be inverted (matches when it doesn't find
+ the search text) by prepending an exclamation mark, for example: !start:!bet all.
+ See the blacklist: Prefix description
+ for further information on the differences between blacklisting and
+ negated matches.
+
+
Additionally, several Text Matching Prefixes can be specified by prepending
+ a plus sign. In this case the value cannot contain spaces or must be
+ quoted. Example: +!start:"!bet all" regi:Regular search text
+
+
Only the main search text (no prefix or using any of the non-modified
+ Text Matching Prefixes) will mark Highlight matches in chat.
The following prefixes don't match on the text itself, but define other
things that should or should not trigger a Highlight. You can place one
@@ -817,14 +832,13 @@
Prefixes can normally not contain spaces (it wouldn't be clear
whether the space is part of the prefix value or a separator between
prefixes), however you can enclose the prefix value (or part of it)
- in quotes or escape each space with a backlash. Example:
- replacement:"text with space" or
- replacement:text\ with\ space
-
Quotes and backslashes have to be escaped when intended to be used literally (\" or \\).
+ in quotes. Two quotes can be used to add a literal quote. Example:
+ replacement:"text with ""space""" (meaning
+ the value is text with "space")
When a prefix can have several values, they must be comma-separated
(without spaces). Example: cat:category1,category2.
- Commas in list values can be quoted or escaped as well for them to
- be used literally instead of as a separator.
+ Commas in list values can be quoted as well for them to be used
+ literally instead of as a separator.
Possible matching prefixes:
@@ -897,8 +911,27 @@
specified in the same config: prefix, only one
has to match), prefix value with reg: to use
regex matching on the value.
+
config:url - Message must contain a URL (same
+ as what is made clickable)
+
blacklist: to specify one or more text patterns
+ (separated by comma) that will prevent the overall match if they
+ encompass the entire text match. Example: blacklist:"!bet all" start:!bet
+ will match all messages starting with !bet but will not
+ match !bet all. Can use any regular Text Matching Prefix.
+ This is of course similiar to using a negated text match, like
+ +!text:"!bet all" start:!bet, however the blacklist is
+ "passive", so while +!text:"!bet all" will match only
+ if !bet all is not present anywhere, blacklist:"!bet all"
+ (by itself) will always match because it is not actually
+ a requirement itself, it just modifies text matching requirements,
+ so technicially there is no requirement for a match.
+ Additionally, a negated match like +!text:!cheesecake reg:^!\w+
+ will prevent the match if !cheesecake appears anywhere
+ in the message, while blacklist:!cheesecake reg:^!\w+
+ will only prevent the match when it fully encompasses the regular
+ text match, so only when the message starts with !cheesecake.
color: to specify a color other than the default
diff --git a/help/help.html b/help/help.html
index ecb277c..be48b04 100644
--- a/help/help.html
+++ b/help/help.html
@@ -5,7 +5,7 @@
-
@@ -344,8 +344,18 @@
/follow and /unfollow commands.
Your Subscriptions
-
Enables more accurate display or your emotes (for "Extra - Emotes
+
Enables more accurate display of your emotes (for "Extra - Emotes
Dialog", TAB Completion and when sending a message).
+
+
Moderate Channel
+
Required to receive moderator actions in channels you are a moderator,
+ which show under "Extra - Moderation Log", show which mod performed
+ an action in chat and shows messages caught by AutoMod (depending
+ on settings under "Main - Settings - Moderation").
+
+
Points Redemptions
+
Enables more accurate display of Channel Points Redemptions in your
+ channel.
Extract the .zip into a folder of your choice and start Chatty.jar.
@@ -195,7 +195,7 @@ function getDownloads(tag) {
Non-Windows
-
For OS other than Windows (e.g. Linux or MacOS) you will need to download the JAR-Version (.zip) and must have Java 8 or later installed on your system. Extract the .zip into a folder of your choice and start Chatty.jar.
+
For OS other than Windows (e.g. Linux or MacOS) you will need to download the JAR-Version (.zip) and must have Java 8 or later installed on your system. Extract the .zip into a folder of your choice and start Chatty.jar.
Note: If the language you want to work on hasn't been added yet, tell me, then proceed with step 1 once it has been added.
-
Remember that you can also join languages that have already been completely translated, since future Chatty updates will likely also require more or updated translations. This is especially true now, since still not all GUI parts have been added for localization yet.
-
-
Note that not everything can be translated yet, and the help pages probably won't be at all, since it would be too much work to keep updated. My goal for now is to make the basic functions of the program more comfortable to use for people who don't speak English as their first language.
+
Note that not everything can be translated yet, and the help pages probably won't be at all, since it would be too much work to keep updated.
You don't have to translate everything. If there is no good translation for something, just keep it in English (this especially applies if the English term is commonly used in that language and better fitting).
Strings that aren't translated will automatically fallback to English, so please don't just copy the English strings to fill translations, unless the English string is the translation (see previous point).
Something like {0} in a string means it is replaced with the number 0 parameter. It should say in a comment what it gets replaced with (although most of the time it's clear from context already).
@@ -140,7 +138,7 @@
-
Replacements use the MessageFormat class. Mostly it's enough to just stick close to the template.
+
Substitutions use the MessageFormat class. Mostly it's enough to just stick close to the template.
Important: Any single quote (') in a string that contains a replacement needs to be escaped with a single quote (e.g. Can''t join ''{0}'').
Translate Chatty to main page
Translate Chatty to main page