leafChat scripts

Overview

A script is a collection of customisations. You can use scripts to create new commands or to make your client automatically react to events.

Script files

Each script is a single file with a name ending in .leafChatScript. When a script is installed in leafChat, subsidiary files will include the compiled code or any errors.

Scripts are stored in the Scripts sub-folder of your per-user settings folder. You don't normally need to look in this folder as it is possible to manage scripts within the application. (Currently it is not possible to make scripts that apply to all users of a computer. Scripts are stored per-user.)

Script files are standard XML, so advanced users might want to examine or modify them using ordinary XML tools.

Importing scripts

If a friend has created a script you want to use, you should obtain from them the .leafChatScript file. Then use the Import button in the Scripting window to install the script into your leafChat copy.

Scripts can damage your computer so be sure not to install scripts from any source you don't entirely trust.

Troubleshooting

Scripts run inside leafChat on the same level as other parts of the program. Some scripts can prevent standard functionality from working (intentionally or by accident) or even cause the program to freeze or suddenly exit. Malicious scripts could do much worse, such as delete all your files or install trojan software to spy out your credit card number.

If you experience any bugs, try disabling all your scripts to see if this solves the problem. If a script prevents leafChat from starting up to the point where you can disable it, find the script file on disk and delete it manually.

Creating new scripts

Intended audience

You need a degree of technical knowledge to create new scripts for leafChat – you don't have to be a programmer (unless you want to do the advanced stuff) but you do need to be familiar with IRC.

Get started here.

Compiler credits

leafChat's Java-based scripting uses the Eclipse JDT compiler, which is released under the Eclipse Public License.

Eclipse JDT core © Eclipse contributors and others 2000, 2007. All rights reserved.