Highlight Management Script goes beyond KVIrc's basic highlighting functionality allowing you to prevent all highlights from particular channels and/or nicks, along with a new highlight log window and the ability to log to file. Normal highlight configuration is done in the usual way, this script basically adds a blacklist on top.
Last updated on 5.10.16 for v1.4.
To load the script into KVIrc (which then persists until you uninstall) and run its startup alias, first disable 'User friendly command-line mode' (it prevents the parse command from working):
In a KVIrc console window, look at the bottom right - on the far right of the text entry widget, you'll see an arrow button. Press to expand, then press the 3rd button from the left - normal KVS command mode is now active, and the parse command below works:
/parse <path to script file, speechmark-delimited if the path contains spaces>
/HighlightManagementScript::Startup
Once the script is installed, HighlightManagementScript::Startup is automatically called when KVIrc is started.
You can turn back on 'User friendly command-line mode' if you want, its a per-window setting.
None.
In a KVIrc console window:
/HighlightManagementScript::uninstall::uninstall
The 'Scripts' menu is created on the main KVIrc menubar, which then hosts the Highlight Management Script menu. Here you can turn the script on/off, list, add and remove blacklisted channels, usernames and nicks (normally you would do this via right-clicking the channel/nick directly), and configure the Highlight Log Window:
The nick blacklisting dialog:
The 'Network' entry is the name of the relevant network - if you don't know this off-hand, use the following command in a window associated with the server:
/echo $context.networkName
Deletion of nick from blacklist dialog:
Select the relevant network at the top, then the nick at the bottom, then press OK.
Username blacklisting dialog:
Blacklisting on a nick isn't good enough when a user continuously changes their name (e.g. some of the newer commit bots) - in this case the username probably remains constant, so you can blacklist on that.
In the example of a user with the full usermask 'Not-bb4!~notifico@198.199.82.216', the user's nick is 'Not-bb4', and their username is '~notifico'. The tilde at the front is part of the username, and is prepended by the server when the user doesn't run a reachable ident service on their machine (which will be almost every real remote user, since its obsolescent).
This dialog works in the same way as the nick blacklisting dialog.
Deletion of username from blacklist dialog:
This dialog works in the same way as the deletion of nick from blacklist dialog.
Channel blacklisting dialog:
This dialog works in the same way as the nick blacklisting dialog.
Deletion of channel from blacklist dialog:
This dialog works in the same way as the deletion of nick from blacklist dialog.
Listing blacklisted nicks, usernames and channels outputs them as text to the current window.
'Configure Highlight Log Window...' (discussed later) shows the following dialog:
The dialog already comes with notes, but for convenience here is the $date function documentation, and the directory used to log highlights can be found in the main KVIrc configuration under IRC -> Tools -> Logging -> 'Save logs to folder'. Currently the following is used as the log filename:
Highlight Log - <yy>-<mm>-<dd>.txt
Normally to add or remove nicks, usernames and channels from the blacklist, you will use the integrated menus - right-click the channel to get at the channel menu:
Right-click a nick to get at the nick menu:
The following notes dialog appears to allow you to optionally note your blacklist reasons in case you forget in the future:
On starting the script up, the 'Highlight Log' window appears usually at the bottom of your window list. The following is an example of two highlights, one from a channel and one from a PM, with the default output configuration:
See under 'General Configuration' above for how to customise the output, and where the highlights are logged to file.
The script is fully commented so should be fairly accessible for those wanting to see how to take its use further - for alias usage, see comments preceeding the alias, or run the alias without parameters for help/errors.
Try out my modification of the geany IDE, extending it to syntax highlight, parse KVIrc Script for aliases, events, variables, shortcut for loading scripts into KVIrc etc: Github documentation.
Please create an issue on the Github issue tracker.