IdealIRC

Documentation

Project news

Downloads

Git repository

Documentation

What's IdealIRC?  —  IdealIRC's interface  —  Options dialog  —  DCC  —  Scripting

Functions and commands  —  Variables and types  —  Maps and lists  —  Conditionals and operators  —  Event handling  —  Custom menus  —  Custom dialogs  —  API reference

Scripting

A scripting language for an IRC client - or more specifically - one tailored for GUI clients with some form of user text input has some special requirements.

You could go about using the usual suspects like Lua, Pawn, Python, etc, but then it would become pretty awkward and/or tedious to define things like: custom menus, custom dialog boxes, event handling and custom commands. Even executing a /command from within the script would become pretty weird, in fact.

This language allows for creating custom menu entries, defining custom GUI dialog boxes, defining your own custom /commands and adding event handling for things like messages written in a channel and others.

The language inspiration is mainly from C, as most others. You would define various block types such as menu, dialog, function, hook (for event handling) and command.
The de-facto standard file extension for the scripts are .iis - short for IdealIRC Script.

This documentation assumes you have at least some prior experience with scripting or programming.
Select a topic from the above menu to learn the details.

General syntax rules

• There are no explicit types in the language, but the script engine internals does differentiate between, for example, what an integer is and what a string is.
• The script file is organized in blocks, such as function, command, dialog and others.
• Variables are scoped.
• Comments starts with a pound '#' and lasts until line shift.
• Inside function and command blocks, all statements ends with a semi-colon.
  Except: Conditionals (if-else, while, etc), /commands and end-of-scope (and blocks) - marked with a '}'.