Skip to content
This repository

The (Unofficial) Irssi Scripting Documentation Wiki

This wiki is primarily aimed at scripting information. If you are looking to learn how to use Irssi, try the Usage page. For common scripting tasks, check the Guide page.

Overview

It is intended to provide a more comprehensive listing and description of the scripting capabilities of the Irssi IRC Client than is currently available elsewhere. In theory, it should be editable by anyone with a github account, and I encourage users to add further details where possible. Please read the Contributions page for details on how to add additional info.

Origins

This wiki started out as my personal attempt to convert the Irssi perl documentation into POD format so it can be linked together. I've since expanded it to include various bits of personal content, clarification, and some examples of things. It is now a wiki, in the hope other people will contribute.

Where to Start

Currently, the best place to get started is by reading the Guide page, or beginning with the Irssi module document which contains much of the scripting functionality and links to other items.

For those who are looking for documentation on Signals, an annotated list is available, or the full automatically extracted list if you're feeling brave.

For the impatient, there are full lists of:

  • Functions

    A complete dump of all the Perl accessible functions.

  • Signals

    Note that these do not have their parameters listed.

  • Theme Dump

    A list of all the abstracts and internal formats.

Anyone interested in hacking on the Irssi internals themselves, or looking to write a loadable module rather than just a script, should have a look at the Internals page.

Diving In

A good place to get started is by reading the Guide page, which covers a lot of the basics of Irssi scripting with plenty of helpful examples and cookbook style code snippets.

API Documents

Those looking for the API may with start with the Irssi article, whose namespace contains much of the scripting API, and has links to nearly all of the other objects it refers to.

Another useful starting point is the Class Index, or Main Index.

Theme Writing

Internals

For those who are looking for documentation on Signals, an annotated list is available, or the full automatically extracted list if you're feeling brave.

A complete index is also available, although it must be generated off-site, and may not be 100% up to date.

Other Useful Resources

Something went wrong with that request. Please try again.