From 9561c3e2f834c10bc4ae55c39be3d0f137bf8cbc Mon Sep 17 00:00:00 2001 From: tduva Date: Thu, 14 Feb 2019 14:18:03 +0100 Subject: [PATCH] v0.9.5 files --- help/help-admin.html | 53 ++++++++------ help/help-livestreamer.html | 4 ++ help/help-memory_usage.html | 133 +++++++++++++++++++++++++----------- help/help-releases.html | 62 ++++++++++++++++- help/help-settings.html | 92 +++++++++++++++++++------ help/help.html | 14 ++-- index.html | 22 +++--- 7 files changed, 279 insertions(+), 101 deletions(-) diff --git a/help/help-admin.html b/help/help-admin.html index 5274fb1..a2cb81f 100644 --- a/help/help-admin.html +++ b/help/help-admin.html @@ -6,7 +6,8 @@

Admin Dialog

- Change game/title | + Access | + Change stream title/game/tags | Run commercials

@@ -14,32 +15,39 @@ right-clicking on the channel to open the context menu and choose Channel Admin.

-

In the Admin Dialog you can edit your title/game and run commercials, if - you have allowed Chatty access (you need Editor Access/ - Commercial access respectively, see allow more access).

-

The Admin Dialog is always opened for the currently active channel, unless there is no channel open (which is the case just after you started Chatty), in which case it will open for your own channel (you login with).

-

Change game/title

-

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.

+

Access

+

The Admin Dialog requires the following access:

+ -

Select a game

+

If some access is missing, please go to Main - Login.. in + the main menu and check for the access you need.

+ +

Change stream title/game/tags

+

The Status-Tab lets you view and (if you have access) change some stream + settings.

+ +

Set the title

+

Simply enter the stream title you want to use in the input field.

+ +

Select a game/category

Use Select game to open a dialog where you can search for - a game and also add games to the favorites.

+ a game (and other categories like Creative) and also add games to + favorites.

-

Select communities

-

Communities in Twitch are an additional category you can select for your - stream. If you want to use a Community, you need to select an already - existing one. As with games, you can add favorite Communities. Make sure - to adhere to the rules when selecting a Community for your stream.

+

Select tags

+

Tags are an additional categorization for streams. You can select up to + five tags and also add tags to favorites.

Presets

-

Status Presets allow you to store the current title, game and communities +

Status Presets allow you to store the current title, game and tags for later use. A status is automatically added every time you press the Update button (can be disabled in the History settings), but will be removed after some time of not being used. You can also add @@ -47,9 +55,12 @@ button, which means it is never automatically removed from the Status Presets.

-

Press the Presets button to open the Presets, where you can - select a status (double-click to immediately use it) and filter by - current game or favorites.

+

In the Presets dialog there are different ways to use an entry:

+

The Last Activity column shows when this status was last set using the Update button (or when it was added to the diff --git a/help/help-livestreamer.html b/help/help-livestreamer.html index b03de90..0efa6b1 100644 --- a/help/help-livestreamer.html +++ b/help/help-livestreamer.html @@ -54,6 +54,10 @@

Auto-opens the Livestreamer Dialog when you open a stream out of a context menu.
+
Auto close dialog when starting player
+
Auto-closes the Livestreamer Dialog when the text Starting player + comes up in the log.
+
Context menu qualities
You can customize which quality options appear in the context menu. The options you enter here are directly given as a parameter to diff --git a/help/help-memory_usage.html b/help/help-memory_usage.html index 42e9378..3cd73e3 100644 --- a/help/help-memory_usage.html +++ b/help/help-memory_usage.html @@ -6,52 +6,107 @@

Memory Usage

-

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

+

This page gives some information about memory usage and performance and + how to affect memory usage.

+ -

Use the /appinfo command in Chatty to get some information - about the current memory usage.

+

Introduction

+

There are a few reasons Chatty may use a considerable greater amount of + memory compared to other IRC clients:

-

A typical memory usage pattern, which can change over time as the program - is running while Java optimizes Gargabe Collection:
- Typical memory usage pattern

+ -

Restrict Memory Usage

-

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.

+

You can use the /appinfo command in Chatty to get some + information about current memory usage. Note that these values can be + somewhat different from what is shown in e.g. Task Manager.

-

For example to restrict memory to 400 MB: javaw -Xmx400M -jar "D:\Chatty\Chatty.jar". - You should test out yourself how low you can go, although more than 150 MB - is usually recommended. Note that Java will show a higher usage than - this in the Task Manager, since this pretty much only restricts how much - the program can store, Java will need some more for it's own management - and data.

-

For the Windows Standalone version you can add this value to the file - Chatty.cfg located in the app subfolder of - the Chatty folder (it should already be there by default, so you can - simply adjust it if necessary).

+

Increase or reduce allocated memory

+

When you start a Java program there is some default maximum amount of + memory it is allowed to use, which can vary on a case-by-case basis.

-

OutOfMemoryError

-

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.

+ +

You can tell Java the maximum amount heap memory it can use by using the + launch option -Xmx400M. In this example it allows a maximum + heap of 400MB, which is recommended for good performance. You should + normally never set it below 200MB or you may experience issues.

+ +

JAR Version

+

Create a shortcut (you may + already have created one with the installer). When editing the shortcut + change the target and add the launch option after Java but before the + -jar part (you may have to add the javaw and + -jar parts). It should end up looking similiar to:

+

javaw -Xmx400M -jar "D:\Chatty\Chatty.jar"

+ +

Standalone Version

+

The Chatty.exe of the Windows Standalone + version will look for launch options in the file Chatty.cfg + in the app folder, so you can add the -Xmx400M + there, after [JVMOptions] (should already be there by + default, so you can just change the number).

+ + +

Running out of memory

+

If Java cannot clean up enough memory to make space for new data to be + stored, an OutOfMemory exception will occur.

+ + + +

Short of analyzing a heap dump, basicially a full copy of the programs + memory, it is hard to tell what exactly takes up the memory. Such + analysis is often performed duing development and testing, but if an + issue can not be reproduced then finding the exact cause can be + difficult.

+ +

Reducing memory usage

+

The following settings can be adjusted to reduce memory usage:

+ +
+
Moderation - Clear message history of inactive users
+
Long running instances will accumulate more and more messages stored + for display in the User Dialog. Setting this to a lower value can + reduce memory usage.
+
diff --git a/help/help-releases.html b/help/help-releases.html index 02f57c3..7b4d7e4 100644 --- a/help/help-releases.html +++ b/help/help-releases.html @@ -17,6 +17,7 @@

Release Information

+ 0.9.5 | 0.9.4 | 0.9.3 | 0.9.2 | @@ -54,7 +55,66 @@ full list of changes.

- Version 0.9.4 (This one!) (2019-01-08) + Version 0.9.5 (This one!) (2019-02-14) + [back to top] +

+

Twitch released the Stream Tags API for third-party developers, so Chatty + now supports setting Stream Tags in the Admin Dialog, including the + ability to add Favorites and set them via Presets.

+ +

There have also been improvements on base memory usage and memory usage + for long running instances, which may improve overall performance as + well.

+ + 
+### Chat
+- Added symbol `!` for VIPs and sort in userlist
+- Improved support for some new chat messages
+- Changed Cheeremote default setting to animated
+- Limited inputbox to 500 characters (Twitch Chat cuts off messages longer than
+  500 characters, so this probably makes sense in most cases)
+- Disabled gift sub combining since it didn't work well enough
+
+### Moderation
+- Append approved/denied behind AutoMod messages
+- Don't hide indirect ModLog actions (e.g. "add blocked terms" when denying
+  AutoMod message)
+- Treat AutoMod messages like regular messages concerning bans (so e.g. they get
+  deleted when the user is timed out)
+- Shorten and filter linebreaks from AutoMod messages (normal chat messages
+  cannot contain linebreaks, but AutoMod messages apparently do sometimes)
+- Added setting to remove User Dialog messages of inactive users to reduce
+  memory usage (defaults to 12 hours, changeable in Moderation Settings)
+
+### Other
+- Added Stream Tags support to Admin Dialog
+- Added setting to automatically close Livestreamer/Streamlink Dialog when
+  player is started
+- Replace Emoji codes in Custom Commands as well
+- Added setting to Stream Highlights to select which user types can trigger chat
+  command (e.g. Moderators and VIPs)
+- Added setting to always show tray icon
+- Changed tray icon action to switch between show/minimize to tray
+- Added setting to automatically hide Live Streams window when minimizing Main
+  window
+- Added splash screen window icon
+- Changed image file cache duration in an attempt to improve startup time
+- Improved memory usage
+- Improved debug output
+- Updated help
+
+### Bugfixes
+- Added handling for possible regex error
+- Added limit to some input fields to prevent hanging when inadvertently pasting
+  very long text
+- Removed confusing Program Group page from installer
+- Fixed AutoMod message timestamp custom color
+- Fixed loading FFZ Emotes for namechanged channels
+- Fixed User Dialog ban info being overwritten sometimes
+
+ +

+ Version 0.9.4 (2019-01-08) [back to top] 

diff --git a/help/help-settings.html b/help/help-settings.html
index 3d8b7eb..3a29893 100644
--- a/help/help-settings.html
+++ b/help/help-settings.html
@@ -633,6 +633,8 @@
         Moderation
         [back to menu]
     
+    
+    
Moderator-only Information

     

         
Show Moderator Actions in chat

         
Show commands that moderators execute directly in chat. You can also
@@ -667,6 +669,13 @@
             can also view those messages even if this setting is disabled.

     

     
+    
User Dialog

+    

+        
Clear message history of users inactive for

+        
Remove the messages visible in the User Dialog for each user if a
+            new message hasn't been added for a while. This is mostly for saving
+            memory when Chatty is running continuously for a long time.

+    

 
     

         Names
@@ -784,6 +793,11 @@
                     like "Test " (which reg:Test would
                     match).
             
+            Note: There appears to be an error in the Java Regex implementation
+                which can cause some patterns to cause errors sometimes (possibly
+                related to backreferences, also see this).
+                When editing a Highlight/Ignore entry you will be warned when a
+                pattern could be problematic.
         
     
     
@@ -1203,10 +1217,11 @@
                 at the same position when you reopen them during the same
                 session (so they are put on the default location when you open
                 them the first time after starting Chatty).
-                
  • Restore dialogs from last session: Puts
-                dialogs at the same position they were at when you closed Chatty
-                last session and also keeps the position during the session.
    • 
-                
  • Reopen dialogs from last session: Reopens
+                
  • Keep location / size from last session:
+                Puts dialogs at the same position/size they were at when you
+                closed Chatty last session and also keeps the position during
+                the session.
    • 
+                
  • Reopen from last session: Reopens
                 any dialogs that were open when you closed Chatty last session
                 and also puts them at the same position they were before.
    • 
             
@@ -1215,12 +1230,26 @@
             restores the position on start only if a large portion of the top of
             the dialog/window is visible on screen. This is to prevent dialogs
             from being lost off-screen by accident.
-        
  • Attach dialogs position to main window: If enabled,
+        
  • Move dialogs when moving main window: If enabled,
         moves the dialogs like Channel Info or Admin Dialog along with the
         main window, so they always keep the same relative position. You can
         still move the dialogs by themselves of course.
    • 
     
     
+    
    Minimizing / Tray
    
+    
      
+        
    • Minimize to tray: When minimizing the main Chatty
+        window, it will be minimized to tray.
      • 
+        
    • Close to tray: Closing the main Chatty window will
+        not actually exit the program, but instead minimize it to tray. You can
+        actually close the program via Main - Exit or the tray icon
+        context menu.
      • 
+        
    • Always show tray icon: Always show the tray icon,
+        even when not minimized to tray.
      • 
+        
    • Hide Live Streams window on minimize: When you
+        minimize the main window, automatically hide the Live Streams window.
      • 
+    
    
+    
     
    Other
    
     
      
         
    • Open URL Prompt: Enable this to be asked
@@ -1230,20 +1259,17 @@
         scrollbar in the chat window (there should never be a horizontal one),
         even if no scrolling is necessary. This can be useful for using window
         capture for streaming, because you can always keep the same subregion.
      • 
-        
    • Minimize to tray: When minimizing the main Chatty
-        window, it will be minimized to tray.
      • 
-        
    • Close to tray: Closing the main Chatty window will
-        not actually exit the program, but instead minimize it to tray. You can
-        actually close the program via Main - Exit or the tray icon
-        context menu.
      • 
-        
    • Default Userlist Width: The default width of the
-            userlist in pixels.
      • 
-        
    • Min. Width: The minimum width of the userlist in
-            pixels.
      • 
         
    • Enable userlist by default: Show the userlist by
             default. When you disable this the userlist will be entirely hidden
             from the start. You can always use a shortcut (Shift+F10
             by default) to toggle the userlist per channel.
      • 
+        
    • Default Userlist Width: The default width of the
+            userlist in pixels.
      • 
+        
    • Min. Width: The minimum width of the userlist in
+            pixels.
      • 
+        
    • Enable input field by default: Show the chat input
+            field by default. You can also configure a hotkey in the Hotkey
+            settings to toggle the input field.
      • 
     
    
     
     
    Popout
    
@@ -1769,7 +1795,7 @@
         history:
    
     
      
         
    • The Channel History adds channel that you join to a list
      • 
-        
    • The Status Presets adds title/game/community that you set through
+        
    • The Status Presets adds title/game/tags that you set through
             the Admin Dialog to a list
      • 
     
    
     
@@ -1784,13 +1810,35 @@
         which writes the current uptime/optional note to a textfile.
    
     
     
    
-        
    Mod Command Channel
    
-        
    Allows moderators in the given channel to run the command.
    
-        
    For example if your channel/stream is called zoton2 you would enter zoton2.
    
+        
    Command Channel
    
+        
    Allows users in the given channel to run the command.
    
+        
    For example if your channel/stream is called zoton2 you
+            would enter zoton2.
    
         
-        
    Mod Command
    
-        
    The command the mods have to use to add a Stream Highlight.
    
-        
    With the default !highlight mods would enter !highlight [optional message].
    
+        
    Command Name
    
+        
    The command used to add a Stream Highlight.
    
+        
    With the default !highlight mods would enter
+            !highlight [optional message].
    
+        
+        
    Command Access
    
+        
    Which users have access to the command. It is highly recommended to
+            restrict this to trusted users only, such as Moderators.
    
+        
    There are a few presets available which should fit most needs (they
+            all include the broadcaster as well). This setting is using the
+            Highlighting status:
+            prefix to match only on some types of users. The preset names/values
+            are:
+            
      
+                
    • Moderators: status:bm
      • 
+                
    • Moderators/VIPs: status:bmv
      • 
+                
    • Moderators/VIPs/Subscribers: status:bmvs
      • 
+            
    
+        
    
+        
    If you want to set a custom value, you can use the command
+            /set streamHighlightMatch <value>. You can use
+            anything the Highlighting
+            syntax provides (for example Addressbook categories), not just the
+            status: prefix.
    
     
    
     
     
    
diff --git a/help/help.html b/help/help.html
index c64b977..a7a7346 100644
--- a/help/help.html
+++ b/help/help.html
@@ -5,7 +5,7 @@
         
 
 
-    
    Chatty (Version: 0.9.4)
    
+    
    Chatty (Version: 0.9.5)
    
     
@@ -194,7 +194,7 @@ function getDownloads(tag) {
 	
    
         
    
             
@@ -321,12 +321,12 @@
             when they start streaming.
         
         
    Editor access
    
-        
    Allows you to change the title/game of your stream and streams you
-            are an editor in via the Admin Dialog.
    
+        
    Allows you to change the stream title/game on your channel and
+            channels you are an editor for (Admin Dialog).
    
         
         
    Edit broadcast
    
-        
    Allows you to create Stream Markers on your streams and streams that
-            you are an editor for.
    
+        
    Allows you to create Stream Markers/set Stream Tags on your channel
+            and channels that you are an editor for.
    
         
         
    Run commercials
    
         
    Allows you to run comercials on your stream 
@@ -1383,8 +1383,8 @@ MiniK   http://static-cdn.jtvnw.net/emoticons/v1/25/1.0     set:793 id:3287/openDir and show with the
         /dir command).
    
     
-    
    Allow your moderators to add highlights
    
-    
    You can also let your moderators add Stream Highlights
+    
    Chat Command
    
+    
    You can also let users in chat (e.g. Mods/VIPs) add Stream Highlights
         (!highlight [comment]), which you can configure under
         Main - Settings - Stream Highlights.
    
     
diff --git a/index.html b/index.html
index 0b3958c..c86ea95 100644
--- a/index.html
+++ b/index.html
@@ -16,9 +16,9 @@ function loaded() {
 		      { ceiling: null,  text: "$years years ago" }
 		]
 	}
-	document.getElementById("ago").innerHTML = "Version 0.9.4 released "+humanized_time_span("2019/01/08", Date(), custom_date_formats)+"";
+	document.getElementById("ago").innerHTML = "Version 0.9.5 released "+humanized_time_span("2019/02/14", Date(), custom_date_formats)+"";
 
-	getDownloads("v0.9.4");
+	getDownloads("v0.9.5");
 
 	slideshow_init("slideshow");
 }
@@ -115,8 +115,8 @@ function getDownloads(tag) {
 	
    
 		
    Streaming
    
 		
      
-			
    • Set your stream title & game (with custom Presets) and run commercials
      • 
-			
    • Write current stream uptime to a file, via configurable hotkey or Mod Command, to assist in making Stream Highlights
      • 
+			
    • Set your stream title, game & tags (with custom Presets) and run commercials
      • 
+			
    • Write current stream uptime to a file and create Stream Marker, via configurable hotkey or Mod Command, to assist in making Stream Highlights
      • 
 			
    • List your 100 most recent followers/subscribers
      • 
 			
    • Viewerhistory graph of your current streaming session
      • 
 		
    
@@ -156,7 +156,7 @@ function getDownloads(tag) {
 
 
 	
    Download
    
-	
    Choose one of the following downloads of Chatty Version 0.9.4. For older versions or betas go to GitHub.
    
+	
    Choose one of the following downloads of Chatty Version 0.9.5. For older versions or betas go to GitHub.
    
 	
    If this is your first time using Chatty check out the Getting Started Guide.
    
 
 	
    Windows
    
@@ -168,11 +168,11 @@ function getDownloads(tag) {
 		
    
 			
 				
    
-					
    Download Windows Standalone (Installer) Recommended
    
+					
    Download Windows Standalone (Installer) Recommended
    
 					
    Install into a folder of your choice and start Chatty.exe (or optionally created shortcuts).
    
 				
    
 				
    
-					
    Download Windows Standalone (.zip)
    
+					
    Download Windows Standalone (.zip)
    
 					
    Extract the .zip into a folder of your choice and start Chatty.exe.
    
 				
    
 
@@ -180,13 +180,13 @@ function getDownloads(tag) {
 			    		
 			
 				
    
-					
    Download JAR-Version (Installer)
    
+					
    Download JAR-Version (Installer)
    
 					
    Can select global hotkey support during installation.
    
 					
    Install into a folder of your choice and start Chatty.jar (or optionally created shortcuts).
    
 				
    
 				
    
-					
    Download JAR-Version (.zip)
    
-					
    Also available with global hotkey support for 32bit-Java / 64bit-Java
    
+					
    Download JAR-Version (.zip)
    
+					
    Also available with global hotkey support for 32bit-Java / 64bit-Java
    
 					
    Extract the .zip into a folder of your choice and start Chatty.jar.
    
 				
    
 			
    
 
 	
    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.
    
 
 	
    Contact
    
 	
    If you have any feedback or questions feel free to contact me. You can join the Chatty Discord preferred, write me an E-Mail or use Twitter.