Addressbook

Editing Locally (Commands) | Advanced Usage (Mod Commands, Change via file)

The addressbook allows you to add usernames and assign categories to them, which can then be used in other places such as the Usercolor settings or the Highlight settings. Categories cannot contain spaces and are all made lowercase when added/loaded from file.

Editing Locally

The addressbook can be edited in several ways:

The addressbook dialog (<Main Menu> - Channels - Addressbook) where all entries are listed and you can add/edit/remove entries.
From the user context menu (when you click on a user, then Addressbook) where the entry for this user can be directly added/edited/removed. There you can just select/unselect the categories this user should be in (although only the categories that are already used in the addressbook are listed, so if you want to add a completely new category, you have to add it once by manually editing an entry).
The commands that are listed below.

Commands

In addition to the addressbook dialog and user context menu, there are also some commands to edit the addressbook. All commands are prefixed with /ab (e.g. /ab add <name>) or alternatively /users (e.g. /users add <name>):

add <name> - Adds a name
add <name> <categories> - Adds a name and directly assigns it the given categories, or adds the categories to the name if it already exists (categories are comma-seperated, without spaces)
set <name> <categories> - Sets the categories for this name, adding it if necessary, replacing any present categories for this name
remove <name> - Completely removes the given name
remove <name> <categories> - Removes the given categories from this name, but leaves the name
change <name> <categoriesModification> - Prepend categories with +, - or ! to add, remove or toggle the categories respectively. You can specify more than one set of categories, for example: change test +a,b -c !d adds a and b, removes c and toggles d
get <name> - Shows the categories for this name
info - Shows number of entries and used categories

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

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

renameCategory <currentName> <newName> - Renames a category, which means all occurences of currentName are replaced with newName in all entries. This can also be used to merge categories, if newName already exists.
removeCategory <name> - Removes the category with the given name from all entries

Command Examples

/ab add josh vip: Adds the category called vip to the user called josh; (Also adds the user to the addressbook in the first place, if not already there); (josh's categories would now be: vip)
/ab set josh rainbow: Sets the categories of the user josh to rainbow, replacing any previously associated categories; (josh's categories would now be: rainbow); (Also makes josh kind of colorful in chat, try it out with your own name Kappa)
/ab add josh vip: Adds the category called vip to the user josh; (josh's categories would now be: rainbow,vip)
/ab remove josh vip: Removes the category called vip from the user josh, keeping the other categories untouched; (josh's categories would now again be: rainbow)

Advanced Usage

The following features are a bit more advanced and should only be used if you somewhat know what you're doing.

Moderator Commands

You can use this to let the moderators of your channel edit your addressbook. Depending on what commands you allow them to use, this can be a powerful tool, so make sure you keep an eye on what your moderators do.

The following settings affect the this feature (you have to change them via setting commands):

abCommandsChannel: Set this to the channel you want this enabled in. You can reset the setting to empty using the /clearSetting command to disable the mod commands again.; /set abCommandsChannel #yourchannel
abCommands: A comma-seperated list of commands you want the mods to be able to use. Commands can be anything that is listed in the Commands section above. So for example if you wanted to allow the add and set commands, the setting value would be add,set (no spaces).; /set abCommands add,set; Default value for this is add,set,remove.

If you set the settings accordingly, then the mods will be able to use e.g. !add name category to add name to your Addressbook with the category category. Chatty will output a message about the change, similiar to when you enter the command yourself. It does not send a message to chat, so if you want your moderators to see an actual response, you need to have Chatty on stream (which means the response is also affected by stream delay of course).

Change Addressbook via file

This is a rather experimental feature, so it might not work reliably.

You can write Addressbook commands (one per line) to the addressbookImport.txt file in the settings directory (enter /dir to find out what your settings directory is). You can use any commands specified in the Commands section above, without the /ab or /users prefix (since it's already implied that they are Addressbook commands). For example:

add darthclide level1
change nightbot !vip
set testi ignore

To perform an import, enter the /abImport command and Chatty will read the file and execute each command as if you would have entered it in the input box. Information about the command results is output in the debug window (Extra - Debug window) and the debug log file.

You can also set the abAutoImport setting (/set abAutoImport on) and the file will be read automatically within a few seconds when it is detected to have been changed. You have to restart Chatty after changing the abAutoImport value for it to take effect. To make sure no data is lost, you should not write to the file too often, or else it may already be overwritten once changes are detected and the file contents are read and the commands performed.

It will also not be read automatically when you on start of Chatty, so you should only apply changes while Chatty is running or use the /abImport command to manually read the file once after start. If you only change the file while Chatty is running, manually reading the file should not be necessary.

Example: mIRC script to edit the Addressbook.