From beb543d77396bfc45ef13ef4a66c33cd01b20712 Mon Sep 17 00:00:00 2001 From: tduva Date: Mon, 4 Apr 2016 07:42:16 +0200 Subject: [PATCH] Update beta help --- help/0.8.2b/help-addressbook.html | 71 ++++++++++++++- help/0.8.2b/help-bouncer.html | 59 +++++++++++++ help/0.8.2b/help-guide2.html | 10 +-- help/0.8.2b/help-releases.html | 83 ++++++++++++++++- help/0.8.2b/help-setting_commands.html | 45 +++++++++- help/0.8.2b/help-settings.html | 11 ++- help/0.8.2b/help-troubleshooting.html | 12 ++- help/0.8.2b/help.html | 118 +++++++++++++++++++++++-- 8 files changed, 383 insertions(+), 26 deletions(-) create mode 100644 help/0.8.2b/help-bouncer.html diff --git a/help/0.8.2b/help-addressbook.html b/help/0.8.2b/help-addressbook.html index 1ddf5db..279be86 100644 --- a/help/0.8.2b/help-addressbook.html +++ b/help/0.8.2b/help-addressbook.html @@ -5,10 +5,23 @@

Addressbook

-

- Editing Locally (Commands) | - Advanced Usage (Mod Commands, Change via file) -

+

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 @@ -81,10 +94,12 @@ +

Advanced Usage

The following features are a bit more advanced and should only be used if you somewhat know what you're doing.

+

Moderator Commands

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, @@ -118,6 +133,7 @@ actual response, you need to have Chatty on stream (which means the response is also affected by stream delay of course).

+

Change Addressbook via file

This is a rather experimental feature, so it might not work reliably.

@@ -151,6 +167,53 @@ set testi ignore the file should not be necessary.

Example: mIRC script to edit the Addressbook.

+ + +

Somewhat unique categories

+

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

+ + +

Automatic Subscriber Categories

+

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:

+ + +

The months represent the categories that are automatically added. For + example if you configured the months as [3, 6, 12]:

+ diff --git a/help/0.8.2b/help-bouncer.html b/help/0.8.2b/help-bouncer.html new file mode 100644 index 0000000..efa48d5 --- /dev/null +++ b/help/0.8.2b/help-bouncer.html @@ -0,0 +1,59 @@ + + + Chatty - Using a Bouncer + + + +

Using a Bouncer

+

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.

+ +

Connecting to the Bouncer

+

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>
+
This will overwrite the Server in the settings for this session (but + not change the setting). Set this to the IP/Host of your Bouncer.
+ +
-port <port>
+
Same as server, set this to the port of your Bouncer.
+ +
-password [password]
+
Set this to the password of your Bouncer. The password is not saved + in between sessions which is why you need this option.
+
+ +

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).

+ +

Configuring the Bouncer

+

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
+ +

See more information on Twitch Chat. + + + + diff --git a/help/0.8.2b/help-guide2.html b/help/0.8.2b/help-guide2.html index c7e6b81..1637d73 100644 --- a/help/0.8.2b/help-guide2.html +++ b/help/0.8.2b/help-guide2.html @@ -30,7 +30,7 @@ Subscribers - Request new login + Request new login x @@ -38,7 +38,7 @@ - Request new login + Request new login x x @@ -46,7 +46,7 @@ - Request new login + Request new login x x x @@ -54,7 +54,7 @@ - Request new login + Request new login x x x @@ -62,7 +62,7 @@ - Request new login + Request new login x x x diff --git a/help/0.8.2b/help-releases.html b/help/0.8.2b/help-releases.html index 194e65a..2173fba 100644 --- a/help/0.8.2b/help-releases.html +++ b/help/0.8.2b/help-releases.html @@ -15,6 +15,7 @@

Release Information

+ 0.8.2 | 0.8.1 | 0.8 | 0.7.3 | @@ -39,7 +40,85 @@ full list of changes.

- Version 0.8.1 (This one!) (2015-08-10) + Version 0.8.2 (This one!) (2016-03-10) + [back to top] +

+

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.

+ +

Twitch Chat now supports SSL + on ports 6697 and 443 and Chatty will automatically add these to the default ports if + your port setting is still on the previous default (otherwise you might + have to add it yourself). The migration also got rid of Event Chat which + previously meant some big channels were on separate severs and not easily accesible from Chatty or + Mobile Chat. Now all channels should be on the same servers.

+

Full Changelog

+
+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 single-instance mode, with the ability to join channels in the already
+  running instance
+- Improved Emote Dialog info a bit
+- 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 new Twitch Player URL in context menu
+- 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)
+- Added some support for selecting the correct chat server
+- Added auto-responses to whispers for ignored/non-whitelisted users (disabled
+  by default)
+- Added feature to automatically add Addressbook categories on Subscriber
+  notifications (experimental)
+- Added feature to automatically copy messages into clipboard
+- Moved debug logs to down directory
+- Increased max reconnection attempts to 30
+- Added error message for setting invalid stream status in Admin Dialog
+- 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)
+- Added /proc command to start native processes out of Chatty
+- ShortenDisplayOfExcessivelyLongEmoteCodesLookingOutTheirWindow
+- Updated help
+
+Settings
+========
+- Added more font sizes 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 on double-click on Emote
+- Added setting to remember Status History table sorting order
+- Added setting to toggle Usercolor correction
+- Added setting to display more detailed uptime in titlebar (enabled by default)
+- Changed default for showing animated emotes to off
+- Changed default for Min. Userlist Width to 0
+- Changed defaults for server/port (actual values 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 (when using 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
+
+ +

+ Version 0.8.1 (2015-08-10) [back to top]

Highlights / Important Information

@@ -52,7 +131,7 @@
  • Readded FFZ Feature Friday support and improved it.
  • Show more stream and channel state information (like slowmode, submode, etc.).
    • -

    Full Changelog

    +

    Full Changelog

     #### New features
 - Added experimental Whisper support (this will probably not be developed much
diff --git a/help/0.8.2b/help-setting_commands.html b/help/0.8.2b/help-setting_commands.html
index bdc4ae3..736536e 100644
--- a/help/0.8.2b/help-setting_commands.html
+++ b/help/0.8.2b/help-setting_commands.html
@@ -60,7 +60,8 @@
         Stream Chat |
         Stream Highlights |
         Debugging |
-        Bot Badges
+        Bot Badges |
+        Copy Messages
     
    
             
@@ -528,6 +529,48 @@
                     
    
                 
    Use bot names from FFZ API. FFZ emotes have to be enabled for this to work.
                 
    
             
    
+            
+            
    Copy Messages
    
+            
    This can automatically copy all incoming messages into the clipboard.
    
+            
+                
+                    
+                    
+                    
+                    
+                    
+                
+                
+                    
+                    
+                    
+                    
+                
+                
+                    
+                    
+                    
+                    
+                    
+                
+                
+                    
+                    
+                    
+                    
+                    
+                
+                
+                    
+                    
+                    
+                    
+                
+            
    SettingTypeValuesDefaultDescription
    cmEnabledBooleanfalseEnable/disable the copy messages feature altogether.
    cmChannelStringChannel Name (including leading #)emptyRestrict copying messages to this channel. Leave empty
+                        for no channel restriction.
    cmTemplateStringTemplate 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.
    cmHighlightedOnlyBooleanfalseOnly copy highlighted messages.
    
 
 
 
diff --git a/help/0.8.2b/help-settings.html b/help/0.8.2b/help-settings.html
index b50ab97..17a554c 100644
--- a/help/0.8.2b/help-settings.html
+++ b/help/0.8.2b/help-settings.html
@@ -32,9 +32,18 @@
         Main
         [back to menu]
     
-    
    Font
    
+    
    Chat Font
    
     
    Change font and font size by clicking on Select font.
    
     
+    
    Input 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.
    
+    
     
    Startup
    
     
    You can select what will happen when you start Chatty: