pball's WB manager for mIRC

pball's WB manager for mIRC

Summary:
This is an addon script that creates, edits, and displays welcome back messages. This WB manager is
loaded with options which allow you to customize most aspects of a WB message.

Getting Started:

Loading the script
Place wb.mrc into the mIRC folder or create a subfolder
Open mIRC and in any window type /load -rs "c:\program files\mIRC\wb.mrc" (with the exact location of
where you placed wb.mrc)
Installation complete

Uninstalling the script
Type /unload -rs "c:\program files\mIRC\wb.mrc" (with the exact location of where you placed wb.mrc)
Uninstallation complete

How to create, edit, and manage WBs

First off there are two ways to open the WB manager dialog.
The first way is to right click in a chan then select "WB Manager" from the list of right click options.

The second way to open the manager leads us into creating a WB for a nick.
You can right click on a nick in the chan or in the nick list and you'll see "WB Manager" with
an option of "Add WB for nick", when this is used the selected nick will be added to the manager
when it opens.

General Script Setting
Before getting into specific WB options, general options that apply to all WBs and the script in general
will be discussed.

All the general options on located on the Options tab of the dialog

On the top left is the option "WB's On/Off", when clicked WBs will be displayed, when unclicked
WBs will not be displayed.

Below the on/off option is the Display Option.
This determines how the WB will be displayed in the chan. Below is an example of the two choices.
Say: <%pball> This is normal text
Describe: * %pball This is an action

Below the Display options is the Preview Option.
This determines how the WB will be previewed when you press the preview button.
Msg will query/personal message you the WB while Echo will echo the WB in the current window

Tag related options
The three text boxes at the bottom control how the WB looks.
First off lets define how tag is used in this guide, a tag is the text and symbols before the WB message.
*WB*(nick)*WB* that is a common example of what I call tags
The "Pre tag" is the part before the nick, "Post tag" is the part after the nick
The "Nick color" is how the color of the nick in the tag is set, in this text box enter a number from
0-15 which corresponds to the normal color codes in mIRC.
In the pre and post tags you can use color codes and symbols, in order to have a space between the tags
and the nick in-between them a space must be added to the end of the pre tag and the beginning of the
post tag.

Network List
The Network List controls which networks WBs will be shown in
This allows you to only show WBs on select networks.
The exact name a server can be found using the /networkname alias included in this script.
Simplely type /networkname in a chan window or the status window of the server you wish to get the name for.
Then add the network to the list by entering the name and hitting Add.

Chan related options
To the right of the Network list is the channel White/Black list.
Chans are added and removed in the same way as networks are, each network has it's own chan list.
There are two options for chans.

White List
Chans added when this option is selected means WBs will only be shown in those chans, for that particular network.

Black List
Chans added when this option is selected means WBs will be shown in all chans but those added, for that particular network

Specific WB options
These options are for nick specific WBs, thus this section will explain how to create, edit, and save WBs.

Saving a WB for a nick
After opening the WB manager enter the nick you wish to add a WB for in the top most text box, if you
did not right click on the nick and open the manager that way.
The WB message can be added to the large text box, color codes can be used in the message.
Below the large WB message text box is the "Nick Specific" tag text boxes, you can add tags in here
that will display for only the current nick. If left blank the default tags are used.
The WB can then be added to a particular network, so that nick's WB will only show in that network.
Simply choose one of the added networks from the drop down list, All is the default.
This new option allows you have different WBs for either different people with the same nick on different servers or when you'd like to keep a WB specific to a server where it took place.
Once the nick and WB message and optionally nick specific tags are entered, the WB can be saved.
When the save is completed a popup will inform you.

That is all for adding a WB for a nick, there are however more options and the ability to add more
than one WB message for a nick. These options will be discussed next.

After you save a WB the nick will appear in the "Nick list" on the left and a few fields
will also be filled in. To the right of the "Nick" text box there is "# of WBs" which will
have a number to the left which shows how many WBs the selected nick has. In the row below
that on the left side is "Current WB #" which has a drop down box to the right. This allows
you to choose between WBs if the nick has more than one, also has the option to make a new
WB for the selected nick. The last item in that row is "WB to use", when there are multiple
WBs for a nick you can choose Random, Disable, or a the number of a WB. This determines if a random WB
or a single chosen one will be shown when someone joins a chan. If Disable is selected
the WB will not be displayed when that nick joins. This is handy if someone is joining
a chan to often and you wish to temporarly remove their WB

To add a second WB for a nick select the nick you wish and then select "New" in the
"Current WB #" drop down. This will clear out the WB message text box. Add the new message
then hit save. Once this is done the "Current WB #" will change from New to the current WB
number, the WB to use drop down box will be updated with the newest WB number, and finally
the # of WBs will be updated.

Changing the Network a WB is on.
If you forget to select a specific network and add a nick to All networks, you can change that easiely.
Simply select the WB you wish to edit, change the Network to show in, then hit Add/Edit.
This will create a new WB entry for that nick under the specific network you choose. It will not delete the WB you created the new entry from.
This is not a bug and won't be changed for now.

There are three more buttons to discussed.
Delete WB: This button will delete the currently selected WB, there will be a prompt to
confirm the deletion

Clear Form: This button will clear all the nick specific information. This will allow
you add a new WB for a new nick.

Preview: This will pm you the current WB so you can check the formatting and color.


Change Log
V1.1
Added: vertical scroll bar to the WB text field
Added: ability to exclude selected chans when all chan option is selected

V1.2
Bug fix: The white and black lists didn't work under certain circumstances
Bug fix: Unable to remove all chans from the show in chans text box

V1.3
Bug fix: Couldn't clear the default tags, if cleared out and saved it wouldn't actually save

V1.4
Added: There is now a disable option in the WB to use drop down box. This is a per nick option, which will stop WBs for that nick from being displayed.

V1.5
Changed: Dialog layout, general settings are on second tab of dialog
Changed: The layout and working of the chan white/black list, now runs off a list with add and remove buttons
Added: Ability to chose servers to show in, functions same as chan list

V1.6
Bugfix: The disable WB option was missing in V1.5, I screwed up.

V1.7
Changed: Options on the options tab now save when changed, tags are saved on exit
Removed: Save button on options tab, not needed any more
Added: About popup
Fixed: Blank lines could be added to the chan and server list
Fixed: # of WBs would increase when add/edit button hit, but no new WB added
Fixed: When deleting WBs the WB number wasn't removed from the WB to use drop down
Fixed: Minor error appears when attempting to open an already open dialog, added check to stop that
Fixed: The show in all chans and show in all servers text below the checkboxs didn't load properly, only happens when save file hasn't been updated by new version
Comment: Cleaned up the code a good bit

V2.0
Added: Mutlinetwork support
Comment: Probably added/fixed some other things don't remember

V2.1
Edited: The Nick Color edit box so it's wide enough to accept something like 12,10 for background colors
Added: Some error checking to make sure only numbers and a comma is entered into the Nick Color edit box

V2.2
Fixed: Didn't work when loaded in a directory with spaces in the name
Note: wow surprised no one had complained of this before

V2.2.1
Fixed: Couldn't undo nick color in nick specific tag options, logical error on my part

V2.2.2
Fixed: Couldn't undo nick color in general tag options, logical error on my part

If you have any questions, concerns, or problems please contact pball in #pball on the rizon network