From bdcefef978b1dd2a73382fce5af76c7634e690bf Mon Sep 17 00:00:00 2001 From: tduva Date: Thu, 4 Mar 2021 11:21:03 +0100 Subject: [PATCH] v0.14 files --- help/help-custom_commands.html | 132 ++++++++++++++++++++++++------- help/help-getting-started.html | 2 +- help/help-guide2.html | 58 ++------------ help/help-livestreamer.html | 99 ++++++++++------------- help/help-releases.html | 81 ++++++++++++++++++- help/help-settings.html | 138 +++++++++++++++++++++++++++++++-- help/help-troubleshooting.html | 7 -- help/help.html | 45 ++++++++++- help/style.css | 9 +++ index.html | 16 ++-- 10 files changed, 418 insertions(+), 169 deletions(-) diff --git a/help/help-custom_commands.html b/help/help-custom_commands.html index 108d428..c71ecd2 100644 --- a/help/help-custom_commands.html +++ b/help/help-custom_commands.html @@ -25,6 +25,7 @@ Replacements

The order of the @@ -230,11 +232,16 @@

Restriction
This is similiar to the Usercolors settings, where you can enter special restrictions the user has to match in order - for the icon to be displayed. What makes the most sense in this case is - probably just entering a username (e.g. serenity) or an - addressbook category (e.g. $cat:vip, which would refer to - the category vip). If you keep this empty, then no restriction + for the icon to be displayed. If you keep this empty, then no restriction is applied.
+
The most common restrictions would be: + +
Specifying a Type other than Addon carries an implicit restriction, since e.g. the default moderator icons are only displayed if the user is a moderator.
@@ -752,6 +759,13 @@
  • Text Matching Prefixes
  • Meta Prefixes (Matching) (e.g. matching by channel, user or message type)
  • Meta Prefixes (Behaviour) (e.g. changing resulting text color)
    • +
  • Presets
    • + + +

    Also see:

    +

    By default only regular chat messages are matched, however with the @@ -777,6 +791,7 @@

  • wcs: is the same as w:, but case-sensitive.
  • start: to match at the start, so start:!bet will match messages starting with !bet.
    • +
  • startw: is a combination of start: and w:.
  • reg: (and variations) to use a Regular Expression (Regex), which are case-sensitive by default: +
    • +
  • n: to provide a note that is ignored for matching. + Example: In n:"Explains this entry" config:info startw:!quote + only config:info startw:!quote will have an effect + (see Meta Prefixes (Matching) + on how quoting works).

    • Note: If you're using the color: or bgcolor: @@ -976,7 +997,108 @@ message to the Highlighted Messages window - then consider using Custom Message Colors instead.

    -

    Order of items

    +

    Presets

    +

    There are different ways that allow you to build Highlight items (or + settings using the same format) from pre-defined parts or apply + functions instead of writing it all manually:

    + + + +

    The "Presets" list can be accessed through the Highlights settings page. + Presets can be used from any setting that uses the Highlights format, + even though in this help it only refers to the Highlights list.

    + +

    The "preset:" prefix inserts an entry from + the "Presets" list. It could for example contain an entry with the name "m" that contains some meta prefixes:

    +

    m chanChat:mod config:!notify  ("Presets" list)

    + +

    This could then be inserted into a Highlight list entry like this:

    +

    preset:m reg:<some regex>

    + +

    Prior to further parsing this would be expanded to:

    +

    chanCat:mod config:!notify reg:<some regex>

    + +

    You can also add an optional parameter, for example preset:m|",silent", + which will be appended directly to the end if the inserted text: + chanCat:mod config:!notify,silent reg:<some regex>. + If the name of the preset begins with an underscore the parameter + will instead be provided to the preset in the $1- + replacement.

    + +

    The "cc:" prefix (short for "Custom Command") causes all following text to be + interpreted in the Custom Command syntax, which means:

    + + + +

    For example there could be a preset with the name "_t", that replaces + spaces in all of the given text $1- with underscores:

    +

    _t $replace($1-, ,_)  ("Presets" list)

    + +

    This could then be used in a Highlight item:

    +

    cc:reg:\\w $(_t,abc test)  (note the escaped \ and the abc test parameter)

    + +

    Prior to further parsing this would be modified to (due to being handled + like a Custom Command):

    +

    reg:\w abc_test

    + +

    The "cc2:" prefix does the same, except that you + must also specify a custom escaping (and optionally a replacement) character. + For example the following sets ~ as escape character (instead of \) + and § as replacement character (instead of $). + Anything after | is then interpreted in Custom Command syntax as above:

    +

    cc2:~§|reg:\w §(_t,abc test)

    + +

    The result is the same as the cc: example, but the \w + does not need the additional \ in front, since \ + is not a special Custom Command character anymore.

    + +

    The "ccf:" prefix (short for + "Custom Command Function") applies a "Presets" list entry (whose name + should begin with _ to be able to use Custom Command + replacements) to the entire following text, as if you wrapped the entire + text in a replacement. Example:

    +

    ccf:_t|reg:\w abc test

    + +

    This is equivalent to:

    +

    cc:$(_t,reg:\\w abc test)

    + +

    Both of these would give the entire text to _t (which is $replace($1-, ,_) as seen above) and then use the return value, so it changes to:

    +

    reg:\w_abc_test

    + +

    Using ccf: has the advantage that you don't have to + worry about potentially having to escape special characters, + since simply everything after the | is provided to _t + as a parameter without being interpreted in any special way.

    + +

    You can chain several prefixes, for example:

    +

    ccf:_test|preset:m reg:<some regex>

    +

    This would first apply the _test function to everything after + it, then insert the m preset (assuming the _test + function did not change the preset:m), then continue parsing the + result as a Highlight item.

    + +

    Order of Highlight 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 @@ -1737,7 +1859,7 @@ the -token parameter sets the login token used in Chatty. If a token is already saved in Chatty, then the -token parameter will have no effect, unless this setting is enabled. -

    Overriding the token can be any issue if external programs like the +
    Overriding the token can be an issue if external programs like the Livestreamer GUI provide a token that has less access than the one already saved in Chatty (e.g. doesn't allow you to change your stream title).
    diff --git a/help/help-troubleshooting.html b/help/help-troubleshooting.html index a413013..0a740e0 100644 --- a/help/help-troubleshooting.html +++ b/help/help-troubleshooting.html @@ -32,7 +32,6 @@ @@ -98,12 +97,6 @@ issue. -

    - Livestreamer won't run properly - [back to menu] -

    -

    See the Chatty Livestreamer Help.

    -

    Settings lost [back to menu] diff --git a/help/help.html b/help/help.html index 90cf18c..829670f 100644 --- a/help/help.html +++ b/help/help.html @@ -5,7 +5,7 @@ -

    Chatty (Version: 0.13.1)

    +

    Chatty (Version: 0.14)

    @@ -194,7 +194,7 @@ function getDownloads(tag) {
    @@ -50,7 +50,7 @@
  • Channel Info / History
  • Live Streams / Notifications
  • Admin Dialog
    • -
  • Livestreamer / Streamlink +
  • Streamlink
  • SpeedrunsLive (SRL)
  • Followers/Subscribers List
  • Stream Highlights / Markers
    • @@ -121,6 +121,8 @@
  • R9k for R9Kbeta Mode
  • EmoteOnly for Emote-Only Mode
  • A language code if Broadcaster Language Mode is enabled
    • +
  • [FM] indicates a websocket connection (F + for FrankerFaceZ, M for PubSub/Modlogs)

    • You can toggle showing some information under View - Options - Titlebar.

    @@ -174,7 +176,8 @@

    Chat commands:

      -
    • /me <message> - Send an action message (* nickname says something) to the channel
      • +
    • /say <message> - Send a regular chat message, alternative to just entering the text (it being a command can be useful in some cases, e.g. if you want to ensure that a message starting with a replacement can't trigger another command or to use an Anonymous Custom Command using //say)
      • +
    • /me <message> - Send an action message (* nickname says something)
    • /msgreply <message> - Send a reply to a specific message, only works when added to the User Context Menu or User Dialog in the Commands settings (e.g. Reply=/msgreply $$input(Reply to $(nick)))
    • /to <nick> [time] [reason] - Timeout the user with the given nickname for "time" seconds (time is optional)
      • @@ -309,6 +312,40 @@
      Outputs a and |b|
      +

      When using /chain with Custom Command + replacements, consider the following:

      + +
      +
      /chain /echo $(msg) | /echo abc
      +
      All replacements are performed before the /chain + command is executed, so anything in $(msg) is put in + first. If $(msg) contained Hello World!:
      + /chain /echo Hello World! | /echo abc
      +
      This means that if a replacement contains a | character + it would add an additional command. If $(msg) contained Hello | World!, then World! would be + separately entered into the inputbox (so it would output two /echo + info messages and send World! to chat):
      + /chain /echo Hello | World! | /echo abc
      +
      Since this could cause issues, any top-level replacement will escape + the | character automatically if the Custom Command + begins with the /chain command (so it would output + Hello | World! and abc):
      + /chain /echo Hello || World! | /echo abc
      +
      You can prevent this automatic escaping (if you are absolutely sure that + you want replacements to be able to insert any command) by adding + a backslash in front (this doesn't work when you enter the /chain + command directly into the inputbox):
      + \/chain /echo Hello | World! | /echo abc
      + +
      /chain /echo abc $(chain-test)
      +
      You can test this by using the $(chain-test) replacement. + This should (if e.g. added in the body of a Custom Command) output the following info message:
      + abc | /echo Test || Message
      +
      If you add a backslash in front, it will output two info messages:
      + abc
      + Test | Message
      +
      +

      Twitch Login [back to menu] @@ -1429,7 +1466,7 @@ MiniK http://static-cdn.jtvnw.net/emoticons/v1/25/1.0 set:793 id:3287

      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. + starting Streamlink, however this is a more basic implementation. This is probably only interesting for advanced users.

        diff --git a/help/style.css b/help/style.css index 2f22dc0..c7e60aa 100644 --- a/help/style.css +++ b/help/style.css @@ -55,6 +55,15 @@ code { padding: 0; } +.codeblock-compact { + display: block; + margin-left: 4px; + margin-right: 4px; + margin-top: 4px; + margin-bottom: -4px; + padding: 2px; +} + cite { background-color: #EEEEEE; } diff --git a/index.html b/index.html index d6489ca..1d3fd6a 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.13.1 released "+humanized_time_span("2020/11/17", Date(), custom_date_formats)+""; + document.getElementById("ago").innerHTML = "Version 0.14 released "+humanized_time_span("2021/03/04", Date(), custom_date_formats)+""; - getDownloads("v0.13.1"); + getDownloads("v0.14"); slideshow_init("slideshow"); } @@ -158,7 +158,7 @@ function getDownloads(tag) {

        Download

        -

        Choose one of the following downloads of Chatty Version 0.13.1. For older versions or betas go to the GitHub Releases. Checksums for release files are available as SHA-256 hashes.

        +

        Choose one of the following downloads of Chatty Version 0.14. For older versions or betas go to the GitHub Releases. Checksums for release files are available as SHA-256 hashes.

        If this is your first time using Chatty check out the Getting Started Guide.

        Windows

        @@ -170,11 +170,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.
    @@ -182,11 +182,11 @@ function getDownloads(tag) {
    -
    Download JAR-Version (Installer)
    +
    Download JAR-Version (Installer)
    Install into a folder of your choice and start Chatty.jar (or optionally created shortcuts).
    -
    Download JAR-Version (.zip)
    +
    Download JAR-Version (.zip)
    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.