From 72abd84be1d059f30d2537e04a5789d7211ef993 Mon Sep 17 00:00:00 2001 From: tduva Date: Mon, 31 Dec 2018 07:36:39 +0100 Subject: [PATCH] v0.9.3 --- help/help-addressbook.html | 6 +- help/help-custom_commands.html | 78 +++++++++++++- help/help-guide1.html | 2 +- help/help-livestreamer.html | 2 +- help/help-releases.html | 80 ++++++++++++-- help/help-setting_commands.html | 7 +- help/help-settings.html | 185 +++++++++++++++++++++++++------- help/help-short_guides.html | 4 +- help/help-troubleshooting.html | 2 +- help/help.html | 94 +++++++++------- index.html | 18 ++-- 11 files changed, 368 insertions(+), 110 deletions(-) diff --git a/help/help-addressbook.html b/help/help-addressbook.html index 74967ce..1224af1 100644 --- a/help/help-addressbook.html +++ b/help/help-addressbook.html @@ -50,7 +50,7 @@ -

Categories are given as a comma-seperated list without spaces, e.g. cat1,cat2,cat3.

+

Categories are given as a comma-separated list without spaces, e.g. cat1,cat2,cat3.

The following commands edit all entries at once, so they should be used with care:

-

Add terms to be highlighted

+

Overview

Add items to the list to make a message highlighted if any one of them match the message. The Users to never highlight and Highlight Blacklist settings can be used to prevent some of those Highlights.

+

The following sections list different kinds of prefixes that can modify + the behaviour of the system:

+ + +

By default only regular chat messages are matched, however with the + config:info prefix info messages (e.g. subs, chat status) + can be matched instead.

+

Text Matching Prefixes

By default, matching is performed case-insensitive and anywhere in the message. However, you can add one of the following prefixes in front of @@ -753,23 +787,26 @@ -

Meta Prefixes

-

The following prefixes don't change the matching of the text itself, but - rather provide other information for the highlight system. You can place - one or several of these prefixes before the search text (separated by +

Meta Prefixes (Matching)

+

The following prefix don't match on the text itself, but define other + things that should or should not trigger a Highlight. You can place one + or several of these prefixes before the search text (separated by spaces): [meta-prefix:value] [..] [text-prefix:]<search text>

- + +

Meta Prefixes (Behaviour)

+

The following prefixes don't change what is highlighted, but rather + change what a Highlight does. You can place one or several of these + prefixes before the search text (separated by spaces): + [meta-prefix:value] [..] [text-prefix:]<search text>

+ + +

Note: If you're using the color: or bgcolor: + prefix to merely change the message color, but are not interested in + actually Highlighting it - which includes a Notification and adding the + message to the Highlighted Messages window - then consider using Custom + Message Colors instead.

+ +

Order of items

+

When using prefixes that change the behaviour (like setting a color) the + order of Highlight items may be important, since the settings of the + first matching item (from the top of the list) will be used. Contrary to + that, if the choice is merely whether or not to highlight, then the + order matter less (it can still matter for which matches in the message + are emphasized). + +

Example: If you have one item bgcolor:yellow user:joshimuz + that makes all messages of "Joshimuz" have a yellow background and + another item start:!bet that highlights all messages + starting with "!bet", then messages from "Joshimuz" that also happen to + be starting with "!bet" will either have a yellow background or not, + depending on the order of the two items in the list, so which one comes + first.

+ +

Note: If you have the "Highlight own name" setting enabled, then + it creates a Highlight item containing your name that will always be + checked first. So if you want to e.g. change the color of messages + containing your name as well, then you should disable that option and + manually add an appropriate entry to the list (e.g. + w:<yourname>), so that you can control it's position + in the list in relation to other items yourself.

+

Examples

word1 word2
@@ -973,13 +1052,11 @@ For example if you add regw:a\w* to the list, it will remove all words starting with a from messages in chat and replace it with .., which can be hovered over to - show the original text. If you prepend replacement:Wordwitha, - then instead of replacing it with the default .., - the removed text gets replaced with Wordwitha. If - you don't just want to use this as a fun word guessing game, then a more - useful application might be to e.g. filter out parts of bot messages - that are always the same.

- + show the original text.

+ +

An example usage for this could be to shorten bot messages by removing + parts that are always the same.

+

The text matching syntax is the same as for the Highlight list, although you have to remember that only the the parts of a message that match the pattern are removed, so you may have to use it a bit @@ -989,12 +1066,22 @@ also only uses the matches from the first item in the list that matches any part of the message. This may be changed in the future.

+

Customize replacement

+

The replacement: prefix can be used to change the default + .. the filtered text is replaced with to something + more meaningfull. For example if your entry is + replacement:Wordwitha regw:a\w* then the removed text gets + replaced with Wordwitha.

+ +

You can use replacement:none to output no replacement at + all.

+

Log to file [back to menu]

If you enable logging, chat messages (and more if enabled) will be written - into a seperate textfile for each channel.

+ into a separate textfile for each channel.

Channels

You can specify which channels should be logged:

If you want to switch between servers sometimes, you can create a diff --git a/help/help-troubleshooting.html b/help/help-troubleshooting.html index 23e9825..d7ddcfb 100644 --- a/help/help-troubleshooting.html +++ b/help/help-troubleshooting.html @@ -278,7 +278,7 @@ 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 + in it. It should show a list of semicolon-separated directories, one of which should point to Java.

Find errors in debug.log

diff --git a/help/help.html b/help/help.html index 9b07920..7cb19e5 100644 --- a/help/help.html +++ b/help/help.html @@ -5,7 +5,7 @@ -

Chatty (Version: 0.9.2)

+

Chatty (Version: 0.9.3)

@@ -100,12 +100,12 @@
@@ -53,7 +53,7 @@
  • Livestreamer / Streamlink
  • SpeedrunsLive (SRL)
  • Followers/Subscribers List
  • -
  • Stream Highlights
  • +
  • Stream Highlights / Markers
  • Stream Chat
  • - +

    Title and Tabs [back to menu]

    - + Top of the main Chatty window, explaining the data in the title and the meaning of TAB colors

    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 @@ -132,16 +132,14 @@ Hotkeys [back to menu] -

    You can customize most of these hotkeys in the settings, and also - add hotkeys for some functions not listed here.

    Default hotkeys which can't be changed:

    -

    The following are more default hotkeys, however these can be changed - in the settings:

    + +

    The following default hotkeys can be changed in the Settings:

    +

    In the Settings you can configure hotkeys for many more functions than + are listed here.

    +

    Commands [back to menu] @@ -200,16 +201,20 @@ directly by prepending them with a dot . instead of a slash, for example: .mods.

    -

    Settings/Customization commands:

    +

    Other Twitch Commands

    + +

    Settings / Customization commands:

    +

    GUI commands:

    @@ -225,7 +230,7 @@ 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)
  • + but adds spaces so it's separated from text before and after (if present)
  • /openUrl <url> - Opens the given url (see Open URL Command settings)
  • /openUrlPrompt <url> - Opens the given url after showing a prompt for confirmation
  • @@ -284,6 +289,20 @@ is valid and sets it as new token if it is +

    Execute several commands

    +

    The /chain command allows you to run several commands at the + same time. Each part separated by a | is basicially + entered into the inputbox again. Whitespace around each part is trimmed. + Escape | with | to use it directly.

    + +
    +
    /chain /echo a | /echo b
    +
    Outputs a and b
    + +
    /chain /echo a | /echo ||b||
    +
    Outputs a and |b|
    +
    +

    Twitch Login [back to menu] @@ -305,6 +324,10 @@
    Allows you to change the title/game of your stream and streams you are an editor in via the Admin Dialog.
    +
    Edit broadcast
    +
    Allows you to create Stream Markers on your streams and streams that + you are an editor for.
    +
    Run commercials
    Allows you to run comercials on your stream via the Admin Dialog (if you are partnered).
    @@ -732,7 +755,7 @@ [back to menu]

    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 + messages appear in another color and appear in a separate window, which you can open under View - Highlights (you can clear the highlights window in it's context menu).

    More information: Highlight Settings
    @@ -743,7 +766,7 @@

    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 + added to a separated 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 @@ -969,7 +992,7 @@ MiniK http://static-cdn.jtvnw.net/emoticons/v1/25/1.0 set:793 id:3287Stream Chat [back to menu] -

    Stream Chat is a seperate dialog, opened via the /openStreamChat +

    Stream Chat is a separate 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 @@ -978,7 +1001,7 @@ MiniK http://static-cdn.jtvnw.net/emoticons/v1/25/1.0 set:793 id:3287The 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 + simply prefer to only have regular messages or to have a separate dialog for the capture.

    Getting started

    @@ -1335,7 +1358,7 @@ MiniK http://static-cdn.jtvnw.net/emoticons/v1/25/1.0 set:793 id:3287

    - Stream Highlights + Stream Highlights / Markers [back to menu]

    Chatty can help you with creating Highlights of your stream by recording @@ -1361,29 +1384,20 @@ MiniK http://static-cdn.jtvnw.net/emoticons/v1/25/1.0 set:793 id:3287/dir command).

    Allow your moderators to add highlights

    -

    You can also let your moderators add stream highlights - (!highlight [comment]), but you first have to set the channel with a - setting command:

    +

    You can also let your moderators add Stream Highlights + (!highlight [comment]), which you can configure under + Main - Settings - Stream Highlights.

    -
    -
    /set streamHighlightChannel #<yourchannelname>
    -
    Allows moderators in the given channel to run the command.
    -
    For example if your channel/stream is called zoton2 the - command you have to enter would be: /set streamHighlightChannel #zoton2
    -
    +

    Stream Markers

    +

    Twitch offers a way to add + Stream Markers + which show up when creating Highlights on the website. You can use the + /marker command or add a Stream Marker automatically when + adding a Stream Highlight (changeable in the Stream Highlights settings).

    -

    Optionally you can also set the following settings:

    -
    -
    /set streamHighlightChannelRespond 1
    -
    Send a response to chat when the mod command is used (otherwise the - message is just shown locally).
    -
    /set streamHighlightCommand !highlight
    -
    Change the mod command (in this example to !highlight, - which is the default)
    -
    - -

    Tip: Setting commands - are entered into the chat input box, just like Twitch Chat commands.

    +

    For creating Stream Markers you need the Edit broadcast + scope, so if you don't have that yet, you have to + request a new login token.

    Ignore joins/parts diff --git a/index.html b/index.html index 5468d7c..20b71b0 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.2 released "+humanized_time_span("2018/10/26", Date(), custom_date_formats)+""; + document.getElementById("ago").innerHTML = "Version 0.9.3 released "+humanized_time_span("2018/12/31", Date(), custom_date_formats)+""; - getDownloads("v0.9.2"); + getDownloads("v0.9.3"); slideshow_init("slideshow"); } @@ -156,7 +156,7 @@ function getDownloads(tag) {

    Download

    -

    Choose one of the following downloads of Chatty Version 0.9.2. For older versions or betas go to GitHub.

    +

    Choose one of the following downloads of Chatty Version 0.9.3. 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.
    @@ -194,7 +194,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.

    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.