From 16a3347514846e8fd7c7551704138abc3f706c95 Mon Sep 17 00:00:00 2001 From: tduva Date: Thu, 14 May 2020 15:39:09 +0200 Subject: [PATCH] v0.12 files --- help/help-custom_commands.html | 81 +++++++++++++++++++-- help/help-guide_folders.html | 124 +++++++++++++++------------------ help/help-laf.html | 7 ++ help/help-releases.html | 70 ++++++++++++++++++- help/help-settings.html | 7 ++ help/help.html | 70 ++++++++++++------- index.html | 18 ++--- 7 files changed, 267 insertions(+), 110 deletions(-) diff --git a/help/help-custom_commands.html b/help/help-custom_commands.html index 24e59de..364b91b 100644 --- a/help/help-custom_commands.html +++ b/help/help-custom_commands.html @@ -196,7 +196,7 @@ Description - All + All chan The current channel context (without leading #) @@ -210,6 +210,10 @@ All currently open regular channels (separated by spaces, without leading #) + + hostedChan + The currently hosted channel (if any) + streamstatus Stream Status (Title/Game or Offline) @@ -325,11 +329,36 @@ 1- Names of selected streams + Hotkey 1 The currently selected user (if present) + + + Selected Text Context menu + 1-, msg + The selected text + + + + Admin Context menu + title + The stream title currently set in the Admin Dialog + + + game + The game (category) currently set in the Admin Dialog + + + tag-ids + The tags currently set in the Admin Dialog (ids, comma-separated) + + + tag-names + The tags currently set in the Admin Dialog (display names, comma-separated) +

Example with pre-defined parameters:

@@ -343,9 +372,8 @@ commands like /ban are executed in the appropriate channel.

Functions

-

There is a very limited amount of functions available. Functions are - replacements, however they have a function name before the identifier (there - is no short notation for functions):

+

Functions are replacements, however they have a function name before the + identifier (there is no short notation for functions):

$<functionName>(<identifier>,<some parameters>,[optional parameters])

@@ -355,7 +383,7 @@ replacement: $(1-) -> $join(1-,/)

-

The following functions are available:

+

The following functions are always available:

$if(<identifier>,<output if exists>,[output if not])
If the value the identifier refers to exists (non-empty), it will @@ -364,7 +392,7 @@ with no parameters turns into nope, the optional [output if not] function parameter.
$ifeq(<identifier>,<comparison>,<output if equal>,[output if not])
-
Similar to $if, but instead of just checking fot the +
Similar to $if, but instead of just checking for the existence of a parameter it compares it to a given value (<comparison>).
Example: $ifeq(1,cheesecake,yummy) with parameters @@ -372,6 +400,13 @@ cheese cake turns into an an empty string, since the optional [output if not] has not been specified.
+
$switch(<identifier>,<case1>:<result1>,..,[casen]:[resultn],[default])
+
Similiar to a switch statement in programming, or one or several $ifeq() functions. + Compares the value associated with the identifier with the case values and returns the following + result if it matches. If none of the case values match, it will return the default, or an empty value.
+
Example: /set fontSize $switch($get(fontSize),25:50,50:18,25) when added + as a Custom Command alternates between font sizes 18, 25 and 50.
+
$join(<identifier>,<separator>)
Joins together the arguments the identifier refers to, using the given separator.
@@ -421,6 +456,13 @@
Example: $randum($$1) chooses a random number between 0 and what is the first parameter.
+
$calc(<simple math expression>)
+
Limited support for performing calculations.
+
Example: //echo $calc(2^3) $calc( (3+4\) / 2) + when entered into the inputbox returns 8 3.5 (note the + parentheses in the second, as well as how the closing parenthesis + needs to be escaped).
+
$urlencode(<input>)
Uses UrlEncoder.encode() to prepare the input to be used in a URL query parameter.
@@ -489,6 +531,33 @@
+

The following functions are only available in some contexts:

+ +
+
$is(<match input>)
+
Outputs true if the match succeeds, nothing otherwise. + The match input is in the Highlight + format, although what can actually be matched against depends on + where the command is ran from, for example the user or message text + is only available from the User Dialog or User Context Menu.
+
Example: $if($is(mystatus:bm),I'm a mod,Not a mod) + will output I'm a mod in channels where you are the + broadcaster or a moderator, Not a mod otherwise.
+ +
$get(<settingName>,[key])
+
Returns the value of a setting. Different setting types return + differently formatted values. There is no comprehensive list of + settings, unless you count the Chatty source.
+
One intended use for this is the special setting var, + where you can set a string value using setting commands + (/set var foo bar) and then retrieve the value with + this function ($get(var,foo) returns bar).
+
Example: //echo $get(username) returns the + name you are logged into Chatty with.
+
Example: $if($get(ontop),ONTOP) will return + ONTOP only if "View - Always on top" is enabled.
+
+

Tip: Enter e.g. //echo $datetime() into the chat inputbox to test a function directly, use arrow up/down keys to cycle through previous inputs. Of course you won't be able to diff --git a/help/help-guide_folders.html b/help/help-guide_folders.html index 4de111d..2a73faf 100644 --- a/help/help-guide_folders.html +++ b/help/help-guide_folders.html @@ -39,7 +39,8 @@ 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.

+ sure to close Chatty before doing so (the files may be overwritten + at any time while Chatty is running).

You can change the settings directory via different ways:

@@ -64,12 +65,20 @@ [Directory] - |   |- backup_x_<filename> - Setting backups + |   |- auto_* + Automatic setting backups - |   |- backup_meta - Backups meta (last backup, numbering) + |   |- manual_* + Manual setting backups + + + |   |- session_* + Session setting backups + + + |   |- backup_* + Old backups (no longer used) | @@ -123,22 +132,23 @@ | - - |- addressbook - [Settings] Addressbook entries - |- login [Settings] Your login data (keep this secure) + + + |- settings + [Settings] Main Settings File + + + |- addressbook + [Settings] Addressbook entries [deprecated] + |- favoritesAndHistory [Settings] Channel History/Favorites [deprecated] - - |- settings - [Settings] Main Settings File - |- statusPresets [Settings] Stream Title/Game presets (Admin Dialog) [deprecated] @@ -147,7 +157,9 @@

Note: favoritesAndHistory and statusPresets - have been merged into settings as of v0.9.1.

+ have been merged into settings as of v0.9.1. + The addressbook has been merged into settings + as of v0.12 (but may still be written to under some circumstances).

Working Directory

This directory is associated with Chatty when you start it. This is @@ -209,62 +221,36 @@

Backup

-

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, - by default one). It copies the setting files (except login) to the backup folder - in the settings directory, increasing the numbering of the files with every - backup. It only makes as many backups as defined in the settings and then - starts over with the first number, rotating the files.

- -

This is supposed to make recovery of settings easier in case they are not - read or written correctly and thus lost (which shouldn't usually - happen). In that case you can manually copy/rename the lost files from - a backup (just looks for the most recent one based on the change date - that looks fine).

+

Setting backups can provide a way to recover your settings if the + setting weren't written or loaded properly or to reset your settings + to a previous state.

-

If some settings are important to you this can help, but you - shouldn't rely on it. Always make your own backups, best on a - different device!

- -

Restore backup

-

If you lost your setting files (or some of them) but still have - a backup, you can manually copy the backup to restore it.

-
    -
  1. Prepare & Locate Backup Folder -
      -
    • Enter /openBackupDir to open the Backup folder - (or enter /showBackupDir and navigate to the Backup folder - manually).
      • -
    • There should be several files in the format backup_x_<name>, - these represent the separate batches of backups.
      • -
    • After that, make sure Chatty is not running. Settings are saved when - Chatty is closed, so if you change setting files manually - while it is running your manual changes would just be - overwritten once you close Chatty.
      • -
    -
    2. -
  2. Find latest backup and rename -
      -
    • Sort the files by modification date in your file browser and - choose the latest batch that seems like it might work (e.g. - files that are not 0KB, although the addressbook might be if - you never used it).
      • -
    • Rename the files you want to restore from backup_x_<name> - to <name> (for example backup_2_settings - to settings). You can ignore the backup_meta file.
      • - -
    -
    3. -
  3. Move renamed files -
      -
    • Copy or move the renamed files to the parent folder (the one - you get from /dir or /openDir commands), - overwriting any existing setting files.
      • -
    -
    4. -
  4. After you are done, start Chatty again and the settings - should be restored.
    5. -
+

Chatty can perform these types of backups:

+ +

Note: The login settings file is not backed up. + For a safer backup, make your own backups on a different + device.

+ +

To load an automatic backup go to "Main - Settings - Main - View Backups" + and follow the instructions. If you want to restore a manual backup you made of the + settings file, simply overwrite the current settings + file while Chatty is not running.

+ +

You can view the backup directory directly by entering /openBackupDir + or /showBackupDir into the Chatty inputbox. Note that files + in the backup directory starting with auto_ may be automatically + deleted.

+ diff --git a/help/help-laf.html b/help/help-laf.html index b612898..4611062 100644 --- a/help/help-laf.html +++ b/help/help-laf.html @@ -406,6 +406,13 @@ Other Properties + + windowDecoration + + When set to "off" it disables the custom styled windows and + uses native windows instead, on/off + + macStyleWindowDecoration diff --git a/help/help-releases.html b/help/help-releases.html index 391c340..5308468 100644 --- a/help/help-releases.html +++ b/help/help-releases.html @@ -17,6 +17,7 @@

Release Information

+ 0.12 | 0.11 | 0.10 | 0.9.7 | @@ -59,7 +60,74 @@ full list of changes.

- Version 0.11 (This one!) (2020-01-14) + Version 0.12 (This one!) (2020-05-14) + [back to top] +

+

Settings are now also saved during the session, not just when closing + Chatty. This may help with some issues, for example by notifying the + user early about writing access issues.

+ +

Also changed are setting backups (can now be accessed through the Settings + Dialog) and how the Addressbook is saved (no longer in the "addressbook" file).

+ + 
+### Settings Saving/Loading Changes
+- Settings are now saved while Chatty is running, and only if they changed
+- Improved "Main - Save.." option (for manually saving settings)
+- New backup system, including a GUI to view and load backups more easily
+  (Settings - Main - Settings Management)
+- Addressbook: Added "Edit all"-button to Addressbook dialog for bulk edits
+- Addressbook: Now saved in the "settings" instead of the "addressbook" file,
+  although the "addressbook" file is still written to if the setting
+  "abSaveOnChange" is enabled (but never read, except for the transition)
+
+### Settings
+- Stream Highlights: Added customizable template for the command reponse message
+- Followers/Subscribers Dialog: Added some settings to the context menu to
+  change the appearance of the list
+- Added setting to change the timezone used by Chatty
+- Chat Log: Added optional separate bits message
+- Chat Log: Added customizable template for logging regular chat messages
+- Added setting for input focus (Settings - Window) to test if it fixes issues
+
+### Custom Commands
+- Added identifier $(hostedChan) (the currently hosted channel, if any)
+- Added function $is() for Highlight format matching (e.g. "$is(mystatus:bm)")
+- Added function $calc() to perform simple calculations (e.g. "$calc(3*4)")
+- Added function $switch(), similar to a switch-statement in programming
+- Added function $get() to get setting values
+- Added "var" setting, which can be used like variables ("/set var foo bar" and
+  then "$get(var,foo)" returns "bar")
+- Added setting to add Custom Commands to Admin Dialog context menu
+- Added setting to add Custom Commands to text selection copy/paste context menu
+- Added tooltips for Custom Commands in context menus, showing the raw command
+
+### Utility Commands
+- Added "/showLogDir" and "/openLogDir" to show/open the Chat Log directory
+- Added "/openfile" and "/openfileprompt" to open a file in the default program
+- Added "/requests" command to open the reward queue in the default browser
+
+### Other Changes
+- Stream Chat: Added optional channel logo (if channel is live)
+- Stream Chat: Added context menu to more easily add/remove channels
+- Admin Dialog: Added Status Presets context menu entry to use only game/tags
+- Matching (Highlight etc.): Added "mystatus:" prefix to match against your own
+  user status (e.g. "mystatus:bm" for broadcaster or moderator)
+- Added notification about allowing "Your Subscriptions" access, so emotes are
+  loaded properly
+- Improved dark theme Look and Feel detection and Emotes Dialog background
+- Improved debug output
+- Updated help
+
+### Bugfixes
+- Fixed some types of streams not always showing up correctly
+- Fixed stream uptime sometimes appearing wrong
+- Fixed emote tooltip sometimes showing previously hovered emote's info
+- Fixed rare Emotes Dialog error
+
+ +

+ Version 0.11 (2020-01-14) [back to top]

The new "Look" settings now contain more customization options, including diff --git a/help/help-settings.html b/help/help-settings.html index a0e6165..0eaf39a 100644 --- a/help/help-settings.html +++ b/help/help-settings.html @@ -892,6 +892,13 @@ the given status codes (see status: for codes). For example: !status:stM matches all 'normal' users that have no badge by default (NOT a Subscriber, Turbo User or any kind of Moderator). +

  • mystatus: / !mystatus for the same as + status: / !status:, except for yourself. + Example: mystatus:bm to match only when you are the + broadcaster or a moderator. Note that your user status is only + updated on channel join and when sending a message, so e.g. if you + get modded while already in the channel it will not be recognized + until after you have sent a message.
  • config: to specify on or more options (separated by comma, no spaces):