Module : colorTerm V1.3

Supersedes sheet :

Module Description

This module provides a Terminal colour window, with color text, edit line, and a system of macros.

There are three buttons on the main window :

1) macros contextual menu button : allow the user to choose a macro between :

- the default macros : these macros cannot be changed, they are defined by the author of the site.

- the user macros : they can be configured using "the configure chat macros" item of the "main contextual menu". (for the user, these macros will be common for all SCS sites)

2) choose color button : this button opens a window that allows the user to choose his own color in the terminal.

When it is the first time that the user connects to the site, he is assigned a random color between the colors of a list, (cf. the editor of the module)

Next, he will be automatically assigned the last color he used in the SCS site.

3) main contextual menu button : in this menu you find the following items :

- help : help for user

- enlarge what window : enlarge the chat window (in a new window)

- default colors for other users : default colors will be used for other users messages (cf. the editor of the module)

- disable chat system messages : disable messages beginning by > or >> (like login changes, messages when someone is entering or leaving...)

- configure chat macros : opens an interface allowing the user to configure his own chat macros

- record text as : click on it to choose a file to record text as

- recording text : to stop or start recording text. checked if currently recording text, choose a file to "record text as" if not already chosen.

You can access to the macros directly in the edit line by entering the macros shortcut that appear in the macros contextual menu (example : /bye)

If you define a own macro that has the same name as a default macro, the shortcut will be a shortcut to your macro.

A special macro is already defined and cannot be changed : /me (example : /me wishes a good night to everybody, in the chat it will appear [your login] wishes a good night to everybody)

External modules can also register their own macros in the colorTerm.

Editor Description

- background color (the background color of the text zone)

- system messages 1 color ( the color of the messages that begin by '<')

- system messages 2 color (the color of the messages that begin by '<<')

- user messages login name color (the color of the user names between '<' and '>')

- Users messages random colors : a list of 8 colors that are assigned to the users that have not already chosen a color (first access to the site)

- Default macros file : the name of the default macros file.

These macros will appear on the client interface in the macros contextual menu.

The user will not be able to change these macros.

The following colors are used when the user check the option "default colors for other users" in the contextual menu .

- other clients messages default 1 color (other clients first default color)

- other clients messages default 2 color (other clients alternate default color)

Actions and Events

Actions

General actions :

- start : display the client interface

- destroy : destroy the interface

- broadMsg : send a message to all clients

- privateMsg : send a message to one client

- getDialog : a module wants to get the text typed by the user.

The reply will be sent for each line the client types.

Special actions to send info messages (can be in different fonts, size and color):

- privateInfo : send an info message to one client

- broadInfo : send an info message to all clients

Example of parameter directly put in the link of the actions : Your\ msg\ text Arial 7 6000 0

That means font Arial, size 7, color 6000 and font flag 0

Special actions to use ignore functions :

- ignoreFlag - ignoreChgLogin - ignoreLogut -> must be connected to an ignore module if you want to use ignore functions for the colorTerm

Special actions to use external macros :

- registerExtMacro : register new external macros (format [[macroCat macroShortCut info flag] r1])

- unregisterExtMacro : unregister external macros (format [[macroCat macroShortCut] r1])

Events

- entering : the module is going to be started

- in : the module is started on client - destroyed : the module has been destroyed

- command : client typed a line (line in parameter)

- extMacroCommand : client typed a macro registered with registerExtMacro action

Zones

- Term : termColor interface